azuredevops.ServiceEndpointGitHubEnterprise
Explore with Pulumi AI
Manages a GitHub Enterprise Server service endpoint within Azure DevOps.
Relevant Links
Example Usage
using System.Collections.Generic;
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 exampleServiceEndpointGitHubEnterprise = new AzureDevOps.ServiceEndpointGitHubEnterprise("exampleServiceEndpointGitHubEnterprise", new()
{
ProjectId = exampleProject.Id,
ServiceEndpointName = "Example GitHub Enterprise",
Url = "https://github.contoso.com",
Description = "Managed by Terraform",
AuthPersonal = new AzureDevOps.Inputs.ServiceEndpointGitHubEnterpriseAuthPersonalArgs
{
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.NewServiceEndpointGitHubEnterprise(ctx, "exampleServiceEndpointGitHubEnterprise", &azuredevops.ServiceEndpointGitHubEnterpriseArgs{
ProjectId: exampleProject.ID(),
ServiceEndpointName: pulumi.String("Example GitHub Enterprise"),
Url: pulumi.String("https://github.contoso.com"),
Description: pulumi.String("Managed by Terraform"),
AuthPersonal: &azuredevops.ServiceEndpointGitHubEnterpriseAuthPersonalArgs{
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.ServiceEndpointGitHubEnterprise;
import com.pulumi.azuredevops.ServiceEndpointGitHubEnterpriseArgs;
import com.pulumi.azuredevops.inputs.ServiceEndpointGitHubEnterpriseAuthPersonalArgs;
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 exampleServiceEndpointGitHubEnterprise = new ServiceEndpointGitHubEnterprise("exampleServiceEndpointGitHubEnterprise", ServiceEndpointGitHubEnterpriseArgs.builder()
.projectId(exampleProject.id())
.serviceEndpointName("Example GitHub Enterprise")
.url("https://github.contoso.com")
.description("Managed by Terraform")
.authPersonal(ServiceEndpointGitHubEnterpriseAuthPersonalArgs.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_enterprise = azuredevops.ServiceEndpointGitHubEnterprise("exampleServiceEndpointGitHubEnterprise",
project_id=example_project.id,
service_endpoint_name="Example GitHub Enterprise",
url="https://github.contoso.com",
description="Managed by Terraform",
auth_personal=azuredevops.ServiceEndpointGitHubEnterpriseAuthPersonalArgs(
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 exampleServiceEndpointGitHubEnterprise = new azuredevops.ServiceEndpointGitHubEnterprise("exampleServiceEndpointGitHubEnterprise", {
projectId: exampleProject.id,
serviceEndpointName: "Example GitHub Enterprise",
url: "https://github.contoso.com",
description: "Managed by Terraform",
authPersonal: {
personalAccessToken: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
},
});
resources:
exampleProject:
type: azuredevops:Project
properties:
visibility: private
versionControl: Git
workItemTemplate: Agile
description: Managed by Terraform
exampleServiceEndpointGitHubEnterprise:
type: azuredevops:ServiceEndpointGitHubEnterprise
properties:
projectId: ${exampleProject.id}
serviceEndpointName: Example GitHub Enterprise
url: https://github.contoso.com
description: Managed by Terraform
authPersonal:
personalAccessToken: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Create ServiceEndpointGitHubEnterprise Resource
new ServiceEndpointGitHubEnterprise(name: string, args: ServiceEndpointGitHubEnterpriseArgs, opts?: CustomResourceOptions);
@overload
def ServiceEndpointGitHubEnterprise(resource_name: str,
opts: Optional[ResourceOptions] = None,
auth_personal: Optional[ServiceEndpointGitHubEnterpriseAuthPersonalArgs] = None,
authorization: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
project_id: Optional[str] = None,
service_endpoint_name: Optional[str] = None,
url: Optional[str] = None)
@overload
def ServiceEndpointGitHubEnterprise(resource_name: str,
args: ServiceEndpointGitHubEnterpriseArgs,
opts: Optional[ResourceOptions] = None)
func NewServiceEndpointGitHubEnterprise(ctx *Context, name string, args ServiceEndpointGitHubEnterpriseArgs, opts ...ResourceOption) (*ServiceEndpointGitHubEnterprise, error)
public ServiceEndpointGitHubEnterprise(string name, ServiceEndpointGitHubEnterpriseArgs args, CustomResourceOptions? opts = null)
public ServiceEndpointGitHubEnterprise(String name, ServiceEndpointGitHubEnterpriseArgs args)
public ServiceEndpointGitHubEnterprise(String name, ServiceEndpointGitHubEnterpriseArgs args, CustomResourceOptions options)
type: azuredevops:ServiceEndpointGitHubEnterprise
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServiceEndpointGitHubEnterpriseArgs
- 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 ServiceEndpointGitHubEnterpriseArgs
- 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 ServiceEndpointGitHubEnterpriseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServiceEndpointGitHubEnterpriseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ServiceEndpointGitHubEnterpriseArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ServiceEndpointGitHubEnterprise 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 ServiceEndpointGitHubEnterprise resource accepts the following input properties:
- Auth
Personal Pulumi.Azure Dev Ops. Inputs. Service Endpoint Git Hub Enterprise Auth Personal Args An
auth_personal
block as documented below. Allows connecting using a personal access token.- Project
Id string The ID of the project.
- Service
Endpoint stringName The Service Endpoint name.
- Url string
GitHub Enterprise Server Url.
- Dictionary<string, string>
- Description string
- Auth
Personal ServiceEndpoint Git Hub Enterprise Auth Personal Args An
auth_personal
block as documented below. Allows connecting using a personal access token.- Project
Id string The ID of the project.
- Service
Endpoint stringName The Service Endpoint name.
- Url string
GitHub Enterprise Server Url.
- map[string]string
- Description string
- auth
Personal ServiceEndpoint Git Hub Enterprise Auth Personal Args An
auth_personal
block as documented below. Allows connecting using a personal access token.- project
Id String The ID of the project.
- service
Endpoint StringName The Service Endpoint name.
- url String
GitHub Enterprise Server Url.
- Map<String,String>
- description String
- auth
Personal ServiceEndpoint Git Hub Enterprise Auth Personal Args An
auth_personal
block as documented below. Allows connecting using a personal access token.- project
Id string The ID of the project.
- service
Endpoint stringName The Service Endpoint name.
- url string
GitHub Enterprise Server Url.
- {[key: string]: string}
- description string
- auth_
personal ServiceEndpoint Git Hub Enterprise Auth Personal Args An
auth_personal
block as documented below. Allows connecting using a personal access token.- project_
id str The ID of the project.
- service_
endpoint_ strname The Service Endpoint name.
- url str
GitHub Enterprise Server Url.
- Mapping[str, str]
- description str
- auth
Personal Property Map An
auth_personal
block as documented below. Allows connecting using a personal access token.- project
Id String The ID of the project.
- service
Endpoint StringName The Service Endpoint name.
- url String
GitHub Enterprise Server Url.
- Map<String>
- description String
Outputs
All input properties are implicitly available as output properties. Additionally, the ServiceEndpointGitHubEnterprise 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 ServiceEndpointGitHubEnterprise Resource
Get an existing ServiceEndpointGitHubEnterprise 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?: ServiceEndpointGitHubEnterpriseState, opts?: CustomResourceOptions): ServiceEndpointGitHubEnterprise
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auth_personal: Optional[ServiceEndpointGitHubEnterpriseAuthPersonalArgs] = None,
authorization: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
project_id: Optional[str] = None,
service_endpoint_name: Optional[str] = None,
url: Optional[str] = None) -> ServiceEndpointGitHubEnterprise
func GetServiceEndpointGitHubEnterprise(ctx *Context, name string, id IDInput, state *ServiceEndpointGitHubEnterpriseState, opts ...ResourceOption) (*ServiceEndpointGitHubEnterprise, error)
public static ServiceEndpointGitHubEnterprise Get(string name, Input<string> id, ServiceEndpointGitHubEnterpriseState? state, CustomResourceOptions? opts = null)
public static ServiceEndpointGitHubEnterprise get(String name, Output<String> id, ServiceEndpointGitHubEnterpriseState 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
Personal Pulumi.Azure Dev Ops. Inputs. Service Endpoint Git Hub Enterprise Auth Personal Args 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.
- Url string
GitHub Enterprise Server Url.
- Auth
Personal ServiceEndpoint Git Hub Enterprise 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.
- Url string
GitHub Enterprise Server Url.
- auth
Personal ServiceEndpoint Git Hub Enterprise 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.
- url String
GitHub Enterprise Server Url.
- auth
Personal ServiceEndpoint Git Hub Enterprise Auth Personal Args 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.
- url string
GitHub Enterprise Server Url.
- auth_
personal ServiceEndpoint Git Hub Enterprise 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.
- url str
GitHub Enterprise Server Url.
- 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.
- url String
GitHub Enterprise Server Url.
Supporting Types
ServiceEndpointGitHubEnterpriseAuthPersonal
- Personal
Access stringToken The Personal Access Token for GitHub.
- Personal
Access stringToken Hash
- Personal
Access stringToken The Personal Access Token for GitHub.
- Personal
Access stringToken Hash
- personal
Access StringToken The Personal Access Token for GitHub.
- personal
Access StringToken Hash
- personal
Access stringToken The Personal Access Token for GitHub.
- personal
Access stringToken Hash
- personal_
access_ strtoken The Personal Access Token for GitHub.
- personal_
access_ strtoken_ hash
- personal
Access StringToken The Personal Access Token for GitHub.
- personal
Access StringToken Hash
Import
Azure DevOps Service Endpoint GitHub Enterprise Server can be imported using projectID/serviceEndpointID or projectName/serviceEndpointID
$ pulumi import azuredevops:index/serviceEndpointGitHubEnterprise:ServiceEndpointGitHubEnterprise 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.