azuredevops.ServiceEndpointGitHub
Explore with Pulumi AI
Manages a GitHub service endpoint within Azure DevOps.
Relevant Links
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;
return await Deployment.RunAsync(() =>
{
var exampleProject = new AzureDevOps.Project("exampleProject", new()
{
Visibility = "private",
VersionControl = "Git",
WorkItemTemplate = "Agile",
Description = "Managed by Terraform",
});
var exampleServiceEndpointGitHub = new AzureDevOps.ServiceEndpointGitHub("exampleServiceEndpointGitHub", new()
{
ProjectId = exampleProject.Id,
ServiceEndpointName = "Example GitHub Personal Access Token",
AuthPersonal = new AzureDevOps.Inputs.ServiceEndpointGitHubAuthPersonalArgs
{
PersonalAccessToken = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
},
});
});
package main
import (
"github.com/pulumi/pulumi-azuredevops/sdk/v2/go/azuredevops"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleProject, err := azuredevops.NewProject(ctx, "exampleProject", &azuredevops.ProjectArgs{
Visibility: pulumi.String("private"),
VersionControl: pulumi.String("Git"),
WorkItemTemplate: pulumi.String("Agile"),
Description: pulumi.String("Managed by Terraform"),
})
if err != nil {
return err
}
_, err = azuredevops.NewServiceEndpointGitHub(ctx, "exampleServiceEndpointGitHub", &azuredevops.ServiceEndpointGitHubArgs{
ProjectId: exampleProject.ID(),
ServiceEndpointName: pulumi.String("Example GitHub Personal Access Token"),
AuthPersonal: &azuredevops.ServiceEndpointGitHubAuthPersonalArgs{
PersonalAccessToken: pulumi.String("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.Project;
import com.pulumi.azuredevops.ProjectArgs;
import com.pulumi.azuredevops.ServiceEndpointGitHub;
import com.pulumi.azuredevops.ServiceEndpointGitHubArgs;
import com.pulumi.azuredevops.inputs.ServiceEndpointGitHubAuthPersonalArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleProject = new Project("exampleProject", ProjectArgs.builder()
.visibility("private")
.versionControl("Git")
.workItemTemplate("Agile")
.description("Managed by Terraform")
.build());
var exampleServiceEndpointGitHub = new ServiceEndpointGitHub("exampleServiceEndpointGitHub", ServiceEndpointGitHubArgs.builder()
.projectId(exampleProject.id())
.serviceEndpointName("Example GitHub Personal Access Token")
.authPersonal(ServiceEndpointGitHubAuthPersonalArgs.builder()
.personalAccessToken("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
.build())
.build());
}
}
import pulumi
import pulumi_azuredevops as azuredevops
example_project = azuredevops.Project("exampleProject",
visibility="private",
version_control="Git",
work_item_template="Agile",
description="Managed by Terraform")
example_service_endpoint_git_hub = azuredevops.ServiceEndpointGitHub("exampleServiceEndpointGitHub",
project_id=example_project.id,
service_endpoint_name="Example GitHub Personal Access Token",
auth_personal=azuredevops.ServiceEndpointGitHubAuthPersonalArgs(
personal_access_token="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
))
import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";
const exampleProject = new azuredevops.Project("exampleProject", {
visibility: "private",
versionControl: "Git",
workItemTemplate: "Agile",
description: "Managed by Terraform",
});
const exampleServiceEndpointGitHub = new azuredevops.ServiceEndpointGitHub("exampleServiceEndpointGitHub", {
projectId: exampleProject.id,
serviceEndpointName: "Example GitHub Personal Access Token",
authPersonal: {
personalAccessToken: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
},
});
resources:
exampleProject:
type: azuredevops:Project
properties:
visibility: private
versionControl: Git
workItemTemplate: Agile
description: Managed by Terraform
exampleServiceEndpointGitHub:
type: azuredevops:ServiceEndpointGitHub
properties:
projectId: ${exampleProject.id}
serviceEndpointName: Example GitHub Personal Access Token
authPersonal:
personalAccessToken: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;
return await Deployment.RunAsync(() =>
{
var exampleProject = new AzureDevOps.Project("exampleProject", new()
{
Visibility = "private",
VersionControl = "Git",
WorkItemTemplate = "Agile",
Description = "Managed by Terraform",
});
var exampleServiceEndpointGitHub = new AzureDevOps.ServiceEndpointGitHub("exampleServiceEndpointGitHub", new()
{
ProjectId = exampleProject.Id,
ServiceEndpointName = "Example GitHub",
AuthOauth = new AzureDevOps.Inputs.ServiceEndpointGitHubAuthOauthArgs
{
OauthConfigurationId = "00000000-0000-0000-0000-000000000000",
},
});
});
package main
import (
"github.com/pulumi/pulumi-azuredevops/sdk/v2/go/azuredevops"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleProject, err := azuredevops.NewProject(ctx, "exampleProject", &azuredevops.ProjectArgs{
Visibility: pulumi.String("private"),
VersionControl: pulumi.String("Git"),
WorkItemTemplate: pulumi.String("Agile"),
Description: pulumi.String("Managed by Terraform"),
})
if err != nil {
return err
}
_, err = azuredevops.NewServiceEndpointGitHub(ctx, "exampleServiceEndpointGitHub", &azuredevops.ServiceEndpointGitHubArgs{
ProjectId: exampleProject.ID(),
ServiceEndpointName: pulumi.String("Example GitHub"),
AuthOauth: &azuredevops.ServiceEndpointGitHubAuthOauthArgs{
OauthConfigurationId: pulumi.String("00000000-0000-0000-0000-000000000000"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.Project;
import com.pulumi.azuredevops.ProjectArgs;
import com.pulumi.azuredevops.ServiceEndpointGitHub;
import com.pulumi.azuredevops.ServiceEndpointGitHubArgs;
import com.pulumi.azuredevops.inputs.ServiceEndpointGitHubAuthOauthArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleProject = new Project("exampleProject", ProjectArgs.builder()
.visibility("private")
.versionControl("Git")
.workItemTemplate("Agile")
.description("Managed by Terraform")
.build());
var exampleServiceEndpointGitHub = new ServiceEndpointGitHub("exampleServiceEndpointGitHub", ServiceEndpointGitHubArgs.builder()
.projectId(exampleProject.id())
.serviceEndpointName("Example GitHub")
.authOauth(ServiceEndpointGitHubAuthOauthArgs.builder()
.oauthConfigurationId("00000000-0000-0000-0000-000000000000")
.build())
.build());
}
}
import pulumi
import pulumi_azuredevops as azuredevops
example_project = azuredevops.Project("exampleProject",
visibility="private",
version_control="Git",
work_item_template="Agile",
description="Managed by Terraform")
example_service_endpoint_git_hub = azuredevops.ServiceEndpointGitHub("exampleServiceEndpointGitHub",
project_id=example_project.id,
service_endpoint_name="Example GitHub",
auth_oauth=azuredevops.ServiceEndpointGitHubAuthOauthArgs(
oauth_configuration_id="00000000-0000-0000-0000-000000000000",
))
import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";
const exampleProject = new azuredevops.Project("exampleProject", {
visibility: "private",
versionControl: "Git",
workItemTemplate: "Agile",
description: "Managed by Terraform",
});
const exampleServiceEndpointGitHub = new azuredevops.ServiceEndpointGitHub("exampleServiceEndpointGitHub", {
projectId: exampleProject.id,
serviceEndpointName: "Example GitHub",
authOauth: {
oauthConfigurationId: "00000000-0000-0000-0000-000000000000",
},
});
resources:
exampleProject:
type: azuredevops:Project
properties:
visibility: private
versionControl: Git
workItemTemplate: Agile
description: Managed by Terraform
exampleServiceEndpointGitHub:
type: azuredevops:ServiceEndpointGitHub
properties:
projectId: ${exampleProject.id}
serviceEndpointName: Example GitHub
authOauth:
oauthConfigurationId: 00000000-0000-0000-0000-000000000000
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;
return await Deployment.RunAsync(() =>
{
var exampleProject = new AzureDevOps.Project("exampleProject", new()
{
Visibility = "private",
VersionControl = "Git",
WorkItemTemplate = "Agile",
Description = "Managed by Terraform",
});
var exampleServiceEndpointGitHub = new AzureDevOps.ServiceEndpointGitHub("exampleServiceEndpointGitHub", new()
{
ProjectId = exampleProject.Id,
ServiceEndpointName = "Example GitHub Apps: Azure Pipelines",
Description = "Managed by Terraform",
});
});
package main
import (
"github.com/pulumi/pulumi-azuredevops/sdk/v2/go/azuredevops"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleProject, err := azuredevops.NewProject(ctx, "exampleProject", &azuredevops.ProjectArgs{
Visibility: pulumi.String("private"),
VersionControl: pulumi.String("Git"),
WorkItemTemplate: pulumi.String("Agile"),
Description: pulumi.String("Managed by Terraform"),
})
if err != nil {
return err
}
_, err = azuredevops.NewServiceEndpointGitHub(ctx, "exampleServiceEndpointGitHub", &azuredevops.ServiceEndpointGitHubArgs{
ProjectId: exampleProject.ID(),
ServiceEndpointName: pulumi.String("Example GitHub Apps: Azure Pipelines"),
Description: pulumi.String("Managed by Terraform"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.Project;
import com.pulumi.azuredevops.ProjectArgs;
import com.pulumi.azuredevops.ServiceEndpointGitHub;
import com.pulumi.azuredevops.ServiceEndpointGitHubArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleProject = new Project("exampleProject", ProjectArgs.builder()
.visibility("private")
.versionControl("Git")
.workItemTemplate("Agile")
.description("Managed by Terraform")
.build());
var exampleServiceEndpointGitHub = new ServiceEndpointGitHub("exampleServiceEndpointGitHub", ServiceEndpointGitHubArgs.builder()
.projectId(exampleProject.id())
.serviceEndpointName("Example GitHub Apps: Azure Pipelines")
.description("Managed by Terraform")
.build());
}
}
import pulumi
import pulumi_azuredevops as azuredevops
example_project = azuredevops.Project("exampleProject",
visibility="private",
version_control="Git",
work_item_template="Agile",
description="Managed by Terraform")
example_service_endpoint_git_hub = azuredevops.ServiceEndpointGitHub("exampleServiceEndpointGitHub",
project_id=example_project.id,
service_endpoint_name="Example GitHub Apps: Azure Pipelines",
description="Managed by Terraform")
import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";
const exampleProject = new azuredevops.Project("exampleProject", {
visibility: "private",
versionControl: "Git",
workItemTemplate: "Agile",
description: "Managed by Terraform",
});
const exampleServiceEndpointGitHub = new azuredevops.ServiceEndpointGitHub("exampleServiceEndpointGitHub", {
projectId: exampleProject.id,
serviceEndpointName: "Example GitHub Apps: Azure Pipelines",
description: "Managed by Terraform",
});
resources:
exampleProject:
type: azuredevops:Project
properties:
visibility: private
versionControl: Git
workItemTemplate: Agile
description: Managed by Terraform
exampleServiceEndpointGitHub:
type: azuredevops:ServiceEndpointGitHub
properties:
projectId: ${exampleProject.id}
serviceEndpointName: 'Example GitHub Apps: Azure Pipelines'
# Note Github Apps do not support a description and will always be empty string. Must be explicitly set to override the default value.
description: Managed by Terraform
Create ServiceEndpointGitHub Resource
new ServiceEndpointGitHub(name: string, args: ServiceEndpointGitHubArgs, opts?: CustomResourceOptions);
@overload
def ServiceEndpointGitHub(resource_name: str,
opts: Optional[ResourceOptions] = None,
auth_oauth: Optional[ServiceEndpointGitHubAuthOauthArgs] = None,
auth_personal: Optional[ServiceEndpointGitHubAuthPersonalArgs] = None,
authorization: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
project_id: Optional[str] = None,
service_endpoint_name: Optional[str] = None)
@overload
def ServiceEndpointGitHub(resource_name: str,
args: ServiceEndpointGitHubArgs,
opts: Optional[ResourceOptions] = None)
func NewServiceEndpointGitHub(ctx *Context, name string, args ServiceEndpointGitHubArgs, opts ...ResourceOption) (*ServiceEndpointGitHub, error)
public ServiceEndpointGitHub(string name, ServiceEndpointGitHubArgs args, CustomResourceOptions? opts = null)
public ServiceEndpointGitHub(String name, ServiceEndpointGitHubArgs args)
public ServiceEndpointGitHub(String name, ServiceEndpointGitHubArgs args, CustomResourceOptions options)
type: azuredevops:ServiceEndpointGitHub
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServiceEndpointGitHubArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ServiceEndpointGitHubArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ServiceEndpointGitHubArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServiceEndpointGitHubArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ServiceEndpointGitHubArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ServiceEndpointGitHub Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ServiceEndpointGitHub resource accepts the following input properties:
- Project
Id string The ID of the project.
- Service
Endpoint stringName The Service Endpoint name.
- Auth
Oauth Pulumi.Azure Dev Ops. Inputs. Service Endpoint Git Hub Auth Oauth - Auth
Personal Pulumi.Azure Dev Ops. Inputs. Service Endpoint Git Hub Auth Personal An
auth_personal
block as documented below. Allows connecting using a personal access token.- Dictionary<string, string>
- Description string
- Project
Id string The ID of the project.
- Service
Endpoint stringName The Service Endpoint name.
- Auth
Oauth ServiceEndpoint Git Hub Auth Oauth Args - Auth
Personal ServiceEndpoint Git Hub Auth Personal Args An
auth_personal
block as documented below. Allows connecting using a personal access token.- map[string]string
- Description string
- project
Id String The ID of the project.
- service
Endpoint StringName The Service Endpoint name.
- auth
Oauth ServiceEndpoint Git Hub Auth Oauth - auth
Personal ServiceEndpoint Git Hub Auth Personal An
auth_personal
block as documented below. Allows connecting using a personal access token.- Map<String,String>
- description String
- project
Id string The ID of the project.
- service
Endpoint stringName The Service Endpoint name.
- auth
Oauth ServiceEndpoint Git Hub Auth Oauth - auth
Personal ServiceEndpoint Git Hub Auth Personal An
auth_personal
block as documented below. Allows connecting using a personal access token.- {[key: string]: string}
- description string
- project_
id str The ID of the project.
- service_
endpoint_ strname The Service Endpoint name.
- auth_
oauth ServiceEndpoint Git Hub Auth Oauth Args - auth_
personal ServiceEndpoint Git Hub Auth Personal Args An
auth_personal
block as documented below. Allows connecting using a personal access token.- Mapping[str, str]
- description str
- project
Id String The ID of the project.
- service
Endpoint StringName The Service Endpoint name.
- auth
Oauth Property Map - auth
Personal Property Map An
auth_personal
block as documented below. Allows connecting using a personal access token.- Map<String>
- description String
Outputs
All input properties are implicitly available as output properties. Additionally, the ServiceEndpointGitHub 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 string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing ServiceEndpointGitHub Resource
Get an existing ServiceEndpointGitHub 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?: ServiceEndpointGitHubState, opts?: CustomResourceOptions): ServiceEndpointGitHub
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auth_oauth: Optional[ServiceEndpointGitHubAuthOauthArgs] = None,
auth_personal: Optional[ServiceEndpointGitHubAuthPersonalArgs] = None,
authorization: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
project_id: Optional[str] = None,
service_endpoint_name: Optional[str] = None) -> ServiceEndpointGitHub
func GetServiceEndpointGitHub(ctx *Context, name string, id IDInput, state *ServiceEndpointGitHubState, opts ...ResourceOption) (*ServiceEndpointGitHub, error)
public static ServiceEndpointGitHub Get(string name, Input<string> id, ServiceEndpointGitHubState? state, CustomResourceOptions? opts = null)
public static ServiceEndpointGitHub get(String name, Output<String> id, ServiceEndpointGitHubState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- Auth
Oauth Pulumi.Azure Dev Ops. Inputs. Service Endpoint Git Hub Auth Oauth - Auth
Personal Pulumi.Azure Dev Ops. Inputs. Service Endpoint Git Hub Auth Personal An
auth_personal
block as documented below. Allows connecting using a personal access token.- Dictionary<string, string>
- Description string
- Project
Id string The ID of the project.
- Service
Endpoint stringName The Service Endpoint name.
- Auth
Oauth ServiceEndpoint Git Hub Auth Oauth Args - Auth
Personal ServiceEndpoint Git Hub Auth Personal Args An
auth_personal
block as documented below. Allows connecting using a personal access token.- map[string]string
- Description string
- Project
Id string The ID of the project.
- Service
Endpoint stringName The Service Endpoint name.
- auth
Oauth ServiceEndpoint Git Hub Auth Oauth - auth
Personal ServiceEndpoint Git Hub Auth Personal An
auth_personal
block as documented below. Allows connecting using a personal access token.- Map<String,String>
- description String
- project
Id String The ID of the project.
- service
Endpoint StringName The Service Endpoint name.
- auth
Oauth ServiceEndpoint Git Hub Auth Oauth - auth
Personal ServiceEndpoint Git Hub Auth Personal An
auth_personal
block as documented below. Allows connecting using a personal access token.- {[key: string]: string}
- description string
- project
Id string The ID of the project.
- service
Endpoint stringName The Service Endpoint name.
- auth_
oauth ServiceEndpoint Git Hub Auth Oauth Args - auth_
personal ServiceEndpoint Git Hub Auth Personal Args An
auth_personal
block as documented below. Allows connecting using a personal access token.- Mapping[str, str]
- description str
- project_
id str The ID of the project.
- service_
endpoint_ strname The Service Endpoint name.
- auth
Oauth Property Map - auth
Personal Property Map An
auth_personal
block as documented below. Allows connecting using a personal access token.- Map<String>
- description String
- project
Id String The ID of the project.
- service
Endpoint StringName The Service Endpoint name.
Supporting Types
ServiceEndpointGitHubAuthOauth, ServiceEndpointGitHubAuthOauthArgs
- Oauth
Configuration stringId
- Oauth
Configuration stringId
- oauth
Configuration StringId
- oauth
Configuration stringId
- oauth
Configuration StringId
ServiceEndpointGitHubAuthPersonal, ServiceEndpointGitHubAuthPersonalArgs
- Personal
Access stringToken The Personal Access Token for GitHub.
- Personal
Access stringToken The Personal Access Token for GitHub.
- personal
Access StringToken The Personal Access Token for GitHub.
- personal
Access stringToken The Personal Access Token for GitHub.
- personal_
access_ strtoken The Personal Access Token for GitHub.
- personal
Access StringToken The Personal Access Token for GitHub.
Import
Azure DevOps Service Endpoint GitHub can be imported using projectID/serviceEndpointID or projectName/serviceEndpointID
$ pulumi import azuredevops:index/serviceEndpointGitHub:ServiceEndpointGitHub example 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000
Package Details
- Repository
- Azure DevOps pulumi/pulumi-azuredevops
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azuredevops
Terraform Provider.