GitHub

Manages a GitHub service endpoint within Azure DevOps.

Relevant Links

Azure DevOps Service REST API 5.1 - Agent Pools

Create a GitHub Resource

new GitHub(name: string, args: GitHubArgs, opts?: CustomResourceOptions);

def GitHub(resource_name, opts=None, auth_oauth=None, auth_personal=None, authorization=None, description=None, project_id=None, service_endpoint_name=None, __props__=None);

func NewGitHub(ctx *Context, name string, args GitHubArgs, opts ...ResourceOption) (*GitHub, error)

public GitHub(string name, GitHubArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args GitHubArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GitHubArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GitHubArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

GitHub Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The GitHub resource accepts the following input properties:

ProjectId string: The project ID or project name.
ServiceEndpointName string: The Service Endpoint name.
AuthOauth Pulumi.AzureDevOps.ServiceEndpoint.Inputs.GitHubAuthOauthArgs: An auth_oauth block as documented below. Allows connecting using an Oauth token.
AuthPersonal Pulumi.AzureDevOps.ServiceEndpoint.Inputs.GitHubAuthPersonalArgs: An auth_personal block as documented below. Allows connecting using a personal access token.
Authorization Dictionary<string, string>
Description string

ProjectId string: The project ID or project name.
ServiceEndpointName string: The Service Endpoint name.
AuthOauth GitHubAuthOauth: An auth_oauth block as documented below. Allows connecting using an Oauth token.
AuthPersonal GitHubAuthPersonal: An auth_personal block as documented below. Allows connecting using a personal access token.
Authorization map[string]string
Description string

projectId string: The project ID or project name.
serviceEndpointName string: The Service Endpoint name.
authOauth GitHubAuthOauth: An auth_oauth block as documented below. Allows connecting using an Oauth token.
authPersonal GitHubAuthPersonal: An auth_personal block as documented below. Allows connecting using a personal access token.
authorization {[key: string]: string}
description string

project_id str: The project ID or project name.
service_endpoint_name str: The Service Endpoint name.
auth_oauth Dict[GitHubAuthOauth]: An auth_oauth block as documented below. Allows connecting using an Oauth token.
auth_personal Dict[GitHubAuthPersonal]: An auth_personal block as documented below. Allows connecting using a personal access token.
authorization Dict[str, str]
description str

Outputs

All input properties are implicitly available as output properties. Additionally, the GitHub resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing GitHub Resource

Get an existing GitHub resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GitHubState, opts?: CustomResourceOptions): GitHub

static get(resource_name, id, opts=None, auth_oauth=None, auth_personal=None, authorization=None, description=None, project_id=None, service_endpoint_name=None, __props__=None);

func GetGitHub(ctx *Context, name string, id IDInput, state *GitHubState, opts ...ResourceOption) (*GitHub, error)

public static GitHub Get(string name, Input<string> id, GitHubState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AuthOauth Pulumi.AzureDevOps.ServiceEndpoint.Inputs.GitHubAuthOauthArgs: An auth_oauth block as documented below. Allows connecting using an Oauth token.
AuthPersonal Pulumi.AzureDevOps.ServiceEndpoint.Inputs.GitHubAuthPersonalArgs: An auth_personal block as documented below. Allows connecting using a personal access token.
Authorization Dictionary<string, string>
Description string
ProjectId string: The project ID or project name.
ServiceEndpointName string: The Service Endpoint name.

AuthOauth GitHubAuthOauth: An auth_oauth block as documented below. Allows connecting using an Oauth token.
AuthPersonal GitHubAuthPersonal: An auth_personal block as documented below. Allows connecting using a personal access token.
Authorization map[string]string
Description string
ProjectId string: The project ID or project name.
ServiceEndpointName string: The Service Endpoint name.

authOauth GitHubAuthOauth: An auth_oauth block as documented below. Allows connecting using an Oauth token.
authPersonal GitHubAuthPersonal: An auth_personal block as documented below. Allows connecting using a personal access token.
authorization {[key: string]: string}
description string
projectId string: The project ID or project name.
serviceEndpointName string: The Service Endpoint name.

auth_oauth Dict[GitHubAuthOauth]: An auth_oauth block as documented below. Allows connecting using an Oauth token.
auth_personal Dict[GitHubAuthPersonal]: An auth_personal block as documented below. Allows connecting using a personal access token.
authorization Dict[str, str]
description str
project_id str: The project ID or project name.
service_endpoint_name str: The Service Endpoint name.