1. Packages
  2. AzureDevOps
  3. API Docs
  4. ServiceEndpointAzureDevOps
Azure DevOps v3.1.0 published on Friday, May 17, 2024 by Pulumi

azuredevops.ServiceEndpointAzureDevOps

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.1.0 published on Friday, May 17, 2024 by Pulumi

    Manages an Azure DevOps service endpoint within Azure DevOps.

    Note This resource is duplicate with azuredevops.ServiceEndpointPipeline, will be removed in the future, use azuredevops.ServiceEndpointPipeline instead.

    Note Prerequisite: Extension Configurable Pipeline Runner has been installed for the organization.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azuredevops from "@pulumi/azuredevops";
    
    const example = new azuredevops.Project("example", {
        name: "Example Project",
        visibility: "private",
        versionControl: "Git",
        workItemTemplate: "Agile",
        description: "Managed by Terraform",
    });
    const exampleServiceEndpointAzureDevOps = new azuredevops.ServiceEndpointAzureDevOps("example", {
        projectId: example.id,
        serviceEndpointName: "Example Azure DevOps",
        orgUrl: "https://dev.azure.com/testorganization",
        releaseApiUrl: "https://vsrm.dev.azure.com/testorganization",
        personalAccessToken: "0000000000000000000000000000000000000000000000000000",
        description: "Managed by Terraform",
    });
    
    import pulumi
    import pulumi_azuredevops as azuredevops
    
    example = azuredevops.Project("example",
        name="Example Project",
        visibility="private",
        version_control="Git",
        work_item_template="Agile",
        description="Managed by Terraform")
    example_service_endpoint_azure_dev_ops = azuredevops.ServiceEndpointAzureDevOps("example",
        project_id=example.id,
        service_endpoint_name="Example Azure DevOps",
        org_url="https://dev.azure.com/testorganization",
        release_api_url="https://vsrm.dev.azure.com/testorganization",
        personal_access_token="0000000000000000000000000000000000000000000000000000",
        description="Managed by Terraform")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azuredevops/sdk/v3/go/azuredevops"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := azuredevops.NewProject(ctx, "example", &azuredevops.ProjectArgs{
    			Name:             pulumi.String("Example Project"),
    			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.NewServiceEndpointAzureDevOps(ctx, "example", &azuredevops.ServiceEndpointAzureDevOpsArgs{
    			ProjectId:           example.ID(),
    			ServiceEndpointName: pulumi.String("Example Azure DevOps"),
    			OrgUrl:              pulumi.String("https://dev.azure.com/testorganization"),
    			ReleaseApiUrl:       pulumi.String("https://vsrm.dev.azure.com/testorganization"),
    			PersonalAccessToken: pulumi.String("0000000000000000000000000000000000000000000000000000"),
    			Description:         pulumi.String("Managed by Terraform"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureDevOps = Pulumi.AzureDevOps;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new AzureDevOps.Project("example", new()
        {
            Name = "Example Project",
            Visibility = "private",
            VersionControl = "Git",
            WorkItemTemplate = "Agile",
            Description = "Managed by Terraform",
        });
    
        var exampleServiceEndpointAzureDevOps = new AzureDevOps.ServiceEndpointAzureDevOps("example", new()
        {
            ProjectId = example.Id,
            ServiceEndpointName = "Example Azure DevOps",
            OrgUrl = "https://dev.azure.com/testorganization",
            ReleaseApiUrl = "https://vsrm.dev.azure.com/testorganization",
            PersonalAccessToken = "0000000000000000000000000000000000000000000000000000",
            Description = "Managed by Terraform",
        });
    
    });
    
    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.ServiceEndpointAzureDevOps;
    import com.pulumi.azuredevops.ServiceEndpointAzureDevOpsArgs;
    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 example = new Project("example", ProjectArgs.builder()        
                .name("Example Project")
                .visibility("private")
                .versionControl("Git")
                .workItemTemplate("Agile")
                .description("Managed by Terraform")
                .build());
    
            var exampleServiceEndpointAzureDevOps = new ServiceEndpointAzureDevOps("exampleServiceEndpointAzureDevOps", ServiceEndpointAzureDevOpsArgs.builder()        
                .projectId(example.id())
                .serviceEndpointName("Example Azure DevOps")
                .orgUrl("https://dev.azure.com/testorganization")
                .releaseApiUrl("https://vsrm.dev.azure.com/testorganization")
                .personalAccessToken("0000000000000000000000000000000000000000000000000000")
                .description("Managed by Terraform")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azuredevops:Project
        properties:
          name: Example Project
          visibility: private
          versionControl: Git
          workItemTemplate: Agile
          description: Managed by Terraform
      exampleServiceEndpointAzureDevOps:
        type: azuredevops:ServiceEndpointAzureDevOps
        name: example
        properties:
          projectId: ${example.id}
          serviceEndpointName: Example Azure DevOps
          orgUrl: https://dev.azure.com/testorganization
          releaseApiUrl: https://vsrm.dev.azure.com/testorganization
          personalAccessToken: '0000000000000000000000000000000000000000000000000000'
          description: Managed by Terraform
    

    Create ServiceEndpointAzureDevOps Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ServiceEndpointAzureDevOps(name: string, args: ServiceEndpointAzureDevOpsArgs, opts?: CustomResourceOptions);
    @overload
    def ServiceEndpointAzureDevOps(resource_name: str,
                                   args: ServiceEndpointAzureDevOpsArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def ServiceEndpointAzureDevOps(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   org_url: Optional[str] = None,
                                   personal_access_token: Optional[str] = None,
                                   project_id: Optional[str] = None,
                                   release_api_url: Optional[str] = None,
                                   service_endpoint_name: Optional[str] = None,
                                   authorization: Optional[Mapping[str, str]] = None,
                                   description: Optional[str] = None)
    func NewServiceEndpointAzureDevOps(ctx *Context, name string, args ServiceEndpointAzureDevOpsArgs, opts ...ResourceOption) (*ServiceEndpointAzureDevOps, error)
    public ServiceEndpointAzureDevOps(string name, ServiceEndpointAzureDevOpsArgs args, CustomResourceOptions? opts = null)
    public ServiceEndpointAzureDevOps(String name, ServiceEndpointAzureDevOpsArgs args)
    public ServiceEndpointAzureDevOps(String name, ServiceEndpointAzureDevOpsArgs args, CustomResourceOptions options)
    
    type: azuredevops:ServiceEndpointAzureDevOps
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ServiceEndpointAzureDevOpsArgs
    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 ServiceEndpointAzureDevOpsArgs
    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 ServiceEndpointAzureDevOpsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceEndpointAzureDevOpsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceEndpointAzureDevOpsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var serviceEndpointAzureDevOpsResource = new AzureDevOps.ServiceEndpointAzureDevOps("serviceEndpointAzureDevOpsResource", new()
    {
        OrgUrl = "string",
        PersonalAccessToken = "string",
        ProjectId = "string",
        ReleaseApiUrl = "string",
        ServiceEndpointName = "string",
        Authorization = 
        {
            { "string", "string" },
        },
        Description = "string",
    });
    
    example, err := azuredevops.NewServiceEndpointAzureDevOps(ctx, "serviceEndpointAzureDevOpsResource", &azuredevops.ServiceEndpointAzureDevOpsArgs{
    	OrgUrl:              pulumi.String("string"),
    	PersonalAccessToken: pulumi.String("string"),
    	ProjectId:           pulumi.String("string"),
    	ReleaseApiUrl:       pulumi.String("string"),
    	ServiceEndpointName: pulumi.String("string"),
    	Authorization: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    })
    
    var serviceEndpointAzureDevOpsResource = new ServiceEndpointAzureDevOps("serviceEndpointAzureDevOpsResource", ServiceEndpointAzureDevOpsArgs.builder()        
        .orgUrl("string")
        .personalAccessToken("string")
        .projectId("string")
        .releaseApiUrl("string")
        .serviceEndpointName("string")
        .authorization(Map.of("string", "string"))
        .description("string")
        .build());
    
    service_endpoint_azure_dev_ops_resource = azuredevops.ServiceEndpointAzureDevOps("serviceEndpointAzureDevOpsResource",
        org_url="string",
        personal_access_token="string",
        project_id="string",
        release_api_url="string",
        service_endpoint_name="string",
        authorization={
            "string": "string",
        },
        description="string")
    
    const serviceEndpointAzureDevOpsResource = new azuredevops.ServiceEndpointAzureDevOps("serviceEndpointAzureDevOpsResource", {
        orgUrl: "string",
        personalAccessToken: "string",
        projectId: "string",
        releaseApiUrl: "string",
        serviceEndpointName: "string",
        authorization: {
            string: "string",
        },
        description: "string",
    });
    
    type: azuredevops:ServiceEndpointAzureDevOps
    properties:
        authorization:
            string: string
        description: string
        orgUrl: string
        personalAccessToken: string
        projectId: string
        releaseApiUrl: string
        serviceEndpointName: string
    

    ServiceEndpointAzureDevOps 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 ServiceEndpointAzureDevOps resource accepts the following input properties:

    OrgUrl string
    The organization URL.
    PersonalAccessToken string
    The Azure DevOps personal access token.
    ProjectId string
    The ID of the project.
    ReleaseApiUrl string
    The URL of the release API.
    ServiceEndpointName string
    The Service Endpoint name.
    Authorization Dictionary<string, string>
    Description string
    OrgUrl string
    The organization URL.
    PersonalAccessToken string
    The Azure DevOps personal access token.
    ProjectId string
    The ID of the project.
    ReleaseApiUrl string
    The URL of the release API.
    ServiceEndpointName string
    The Service Endpoint name.
    Authorization map[string]string
    Description string
    orgUrl String
    The organization URL.
    personalAccessToken String
    The Azure DevOps personal access token.
    projectId String
    The ID of the project.
    releaseApiUrl String
    The URL of the release API.
    serviceEndpointName String
    The Service Endpoint name.
    authorization Map<String,String>
    description String
    orgUrl string
    The organization URL.
    personalAccessToken string
    The Azure DevOps personal access token.
    projectId string
    The ID of the project.
    releaseApiUrl string
    The URL of the release API.
    serviceEndpointName string
    The Service Endpoint name.
    authorization {[key: string]: string}
    description string
    org_url str
    The organization URL.
    personal_access_token str
    The Azure DevOps personal access token.
    project_id str
    The ID of the project.
    release_api_url str
    The URL of the release API.
    service_endpoint_name str
    The Service Endpoint name.
    authorization Mapping[str, str]
    description str
    orgUrl String
    The organization URL.
    personalAccessToken String
    The Azure DevOps personal access token.
    projectId String
    The ID of the project.
    releaseApiUrl String
    The URL of the release API.
    serviceEndpointName String
    The Service Endpoint name.
    authorization Map<String>
    description String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ServiceEndpointAzureDevOps 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 ServiceEndpointAzureDevOps Resource

    Get an existing ServiceEndpointAzureDevOps 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?: ServiceEndpointAzureDevOpsState, opts?: CustomResourceOptions): ServiceEndpointAzureDevOps
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authorization: Optional[Mapping[str, str]] = None,
            description: Optional[str] = None,
            org_url: Optional[str] = None,
            personal_access_token: Optional[str] = None,
            project_id: Optional[str] = None,
            release_api_url: Optional[str] = None,
            service_endpoint_name: Optional[str] = None) -> ServiceEndpointAzureDevOps
    func GetServiceEndpointAzureDevOps(ctx *Context, name string, id IDInput, state *ServiceEndpointAzureDevOpsState, opts ...ResourceOption) (*ServiceEndpointAzureDevOps, error)
    public static ServiceEndpointAzureDevOps Get(string name, Input<string> id, ServiceEndpointAzureDevOpsState? state, CustomResourceOptions? opts = null)
    public static ServiceEndpointAzureDevOps get(String name, Output<String> id, ServiceEndpointAzureDevOpsState 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.
    The following state arguments are supported:
    Authorization Dictionary<string, string>
    Description string
    OrgUrl string
    The organization URL.
    PersonalAccessToken string
    The Azure DevOps personal access token.
    ProjectId string
    The ID of the project.
    ReleaseApiUrl string
    The URL of the release API.
    ServiceEndpointName string
    The Service Endpoint name.
    Authorization map[string]string
    Description string
    OrgUrl string
    The organization URL.
    PersonalAccessToken string
    The Azure DevOps personal access token.
    ProjectId string
    The ID of the project.
    ReleaseApiUrl string
    The URL of the release API.
    ServiceEndpointName string
    The Service Endpoint name.
    authorization Map<String,String>
    description String
    orgUrl String
    The organization URL.
    personalAccessToken String
    The Azure DevOps personal access token.
    projectId String
    The ID of the project.
    releaseApiUrl String
    The URL of the release API.
    serviceEndpointName String
    The Service Endpoint name.
    authorization {[key: string]: string}
    description string
    orgUrl string
    The organization URL.
    personalAccessToken string
    The Azure DevOps personal access token.
    projectId string
    The ID of the project.
    releaseApiUrl string
    The URL of the release API.
    serviceEndpointName string
    The Service Endpoint name.
    authorization Mapping[str, str]
    description str
    org_url str
    The organization URL.
    personal_access_token str
    The Azure DevOps personal access token.
    project_id str
    The ID of the project.
    release_api_url str
    The URL of the release API.
    service_endpoint_name str
    The Service Endpoint name.
    authorization Map<String>
    description String
    orgUrl String
    The organization URL.
    personalAccessToken String
    The Azure DevOps personal access token.
    projectId String
    The ID of the project.
    releaseApiUrl String
    The URL of the release API.
    serviceEndpointName String
    The Service Endpoint name.

    Import

    Azure DevOps Service Endpoint Azure DevOps can be imported using projectID/serviceEndpointID or projectName/serviceEndpointID

    $ pulumi import azuredevops:index/serviceEndpointAzureDevOps:ServiceEndpointAzureDevOps example 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure DevOps pulumi/pulumi-azuredevops
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azuredevops Terraform Provider.
    azuredevops logo
    Azure DevOps v3.1.0 published on Friday, May 17, 2024 by Pulumi