Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure DevOps Provider
  3. API Docs
  4. ServiceEndpointPipeline
Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi
pulumi/pulumi-azuredevops

azuredevops.ServiceEndpointPipeline

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi
pulumi/pulumi-azuredevops

    Manages a Azure DevOps Run Pipeline Service Connection service endpoint within Azure DevOps. Allows to run downstream pipelines, monitoring their execution, collecting and consolidating artefacts produced in the delegate pipelines (yaml block task: RunPipelines@1). More details on Marketplace page: RunPipelines

    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 Pulumi",
});
const exampleServiceEndpointPipeline = new azuredevops.ServiceEndpointPipeline("example", {
    projectId: example.id,
    serviceEndpointName: "Example Pipeline Runner",
    organizationName: "Organization Name",
    authPersonal: {
        personalAccessToken: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    },
    description: "Managed by Pulumi",
});

    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 Pulumi")
example_service_endpoint_pipeline = azuredevops.ServiceEndpointPipeline("example",
    project_id=example.id,
    service_endpoint_name="Example Pipeline Runner",
    organization_name="Organization Name",
    auth_personal={
        "personal_access_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    },
    description="Managed by Pulumi")

    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 Pulumi"),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewServiceEndpointPipeline(ctx, "example", &azuredevops.ServiceEndpointPipelineArgs{
			ProjectId:           example.ID(),
			ServiceEndpointName: pulumi.String("Example Pipeline Runner"),
			OrganizationName:    pulumi.String("Organization Name"),
			AuthPersonal: &azuredevops.ServiceEndpointPipelineAuthPersonalArgs{
				PersonalAccessToken: pulumi.String("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
			},
			Description: pulumi.String("Managed by Pulumi"),
		})
		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 Pulumi",
    });

    var exampleServiceEndpointPipeline = new AzureDevOps.ServiceEndpointPipeline("example", new()
    {
        ProjectId = example.Id,
        ServiceEndpointName = "Example Pipeline Runner",
        OrganizationName = "Organization Name",
        AuthPersonal = new AzureDevOps.Inputs.ServiceEndpointPipelineAuthPersonalArgs
        {
            PersonalAccessToken = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        },
        Description = "Managed by Pulumi",
    });

});

    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.ServiceEndpointPipeline;
import com.pulumi.azuredevops.ServiceEndpointPipelineArgs;
import com.pulumi.azuredevops.inputs.ServiceEndpointPipelineAuthPersonalArgs;
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 Pulumi")
            .build());

        var exampleServiceEndpointPipeline = new ServiceEndpointPipeline("exampleServiceEndpointPipeline", ServiceEndpointPipelineArgs.builder()
            .projectId(example.id())
            .serviceEndpointName("Example Pipeline Runner")
            .organizationName("Organization Name")
            .authPersonal(ServiceEndpointPipelineAuthPersonalArgs.builder()
                .personalAccessToken("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
                .build())
            .description("Managed by Pulumi")
            .build());

    }
}

    resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Pulumi
  exampleServiceEndpointPipeline:
    type: azuredevops:ServiceEndpointPipeline
    name: example
    properties:
      projectId: ${example.id}
      serviceEndpointName: Example Pipeline Runner
      organizationName: Organization Name
      authPersonal:
        personalAccessToken: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
      description: Managed by Pulumi

    Create ServiceEndpointPipeline Resource

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

    Constructor syntax

    new ServiceEndpointPipeline(name: string, args: ServiceEndpointPipelineArgs, opts?: CustomResourceOptions);
    @overload
def ServiceEndpointPipeline(resource_name: str,
                            args: ServiceEndpointPipelineArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def ServiceEndpointPipeline(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            auth_personal: Optional[ServiceEndpointPipelineAuthPersonalArgs] = None,
                            organization_name: Optional[str] = None,
                            project_id: Optional[str] = None,
                            service_endpoint_name: Optional[str] = None,
                            description: Optional[str] = None)
    func NewServiceEndpointPipeline(ctx *Context, name string, args ServiceEndpointPipelineArgs, opts ...ResourceOption) (*ServiceEndpointPipeline, error)
    public ServiceEndpointPipeline(string name, ServiceEndpointPipelineArgs args, CustomResourceOptions? opts = null)
    public ServiceEndpointPipeline(String name, ServiceEndpointPipelineArgs args)
public ServiceEndpointPipeline(String name, ServiceEndpointPipelineArgs args, CustomResourceOptions options)

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

    Constructor example

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

    var serviceEndpointPipelineResource = new AzureDevOps.ServiceEndpointPipeline("serviceEndpointPipelineResource", new()
{
    AuthPersonal = new AzureDevOps.Inputs.ServiceEndpointPipelineAuthPersonalArgs
    {
        PersonalAccessToken = "string",
    },
    OrganizationName = "string",
    ProjectId = "string",
    ServiceEndpointName = "string",
    Description = "string",
});

    example, err := azuredevops.NewServiceEndpointPipeline(ctx, "serviceEndpointPipelineResource", &azuredevops.ServiceEndpointPipelineArgs{
	AuthPersonal: &azuredevops.ServiceEndpointPipelineAuthPersonalArgs{
		PersonalAccessToken: pulumi.String("string"),
	},
	OrganizationName:    pulumi.String("string"),
	ProjectId:           pulumi.String("string"),
	ServiceEndpointName: pulumi.String("string"),
	Description:         pulumi.String("string"),
})

    var serviceEndpointPipelineResource = new ServiceEndpointPipeline("serviceEndpointPipelineResource", ServiceEndpointPipelineArgs.builder()
    .authPersonal(ServiceEndpointPipelineAuthPersonalArgs.builder()
        .personalAccessToken("string")
        .build())
    .organizationName("string")
    .projectId("string")
    .serviceEndpointName("string")
    .description("string")
    .build());

    service_endpoint_pipeline_resource = azuredevops.ServiceEndpointPipeline("serviceEndpointPipelineResource",
    auth_personal={
        "personal_access_token": "string",
    },
    organization_name="string",
    project_id="string",
    service_endpoint_name="string",
    description="string")

    const serviceEndpointPipelineResource = new azuredevops.ServiceEndpointPipeline("serviceEndpointPipelineResource", {
    authPersonal: {
        personalAccessToken: "string",
    },
    organizationName: "string",
    projectId: "string",
    serviceEndpointName: "string",
    description: "string",
});

    type: azuredevops:ServiceEndpointPipeline
properties:
    authPersonal:
        personalAccessToken: string
    description: string
    organizationName: string
    projectId: string
    serviceEndpointName: string

    ServiceEndpointPipeline Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ServiceEndpointPipeline resource accepts the following input properties:

    AuthPersonal Pulumi.AzureDevOps.Inputs.ServiceEndpointPipelineAuthPersonal
    An auth_personal block as documented below. Allows connecting using a personal access token.
    OrganizationName string
    The organization name used for Organization Url and Release API Url fields.
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    Description string
    AuthPersonal ServiceEndpointPipelineAuthPersonalArgs
    An auth_personal block as documented below. Allows connecting using a personal access token.
    OrganizationName string
    The organization name used for Organization Url and Release API Url fields.
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    Description string
    authPersonal ServiceEndpointPipelineAuthPersonal
    An auth_personal block as documented below. Allows connecting using a personal access token.
    organizationName String
    The organization name used for Organization Url and Release API Url fields.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    description String
    authPersonal ServiceEndpointPipelineAuthPersonal
    An auth_personal block as documented below. Allows connecting using a personal access token.
    organizationName string
    The organization name used for Organization Url and Release API Url fields.
    projectId string
    The ID of the project.
    serviceEndpointName string
    The Service Endpoint name.
    description string
    auth_personal ServiceEndpointPipelineAuthPersonalArgs
    An auth_personal block as documented below. Allows connecting using a personal access token.
    organization_name str
    The organization name used for Organization Url and Release API Url fields.
    project_id str
    The ID of the project.
    service_endpoint_name str
    The Service Endpoint name.
    description str
    authPersonal Property Map
    An auth_personal block as documented below. Allows connecting using a personal access token.
    organizationName String
    The organization name used for Organization Url and Release API Url fields.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    description String

    Outputs

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

    Authorization Dictionary<string, string>
    Id string
    The provider-assigned unique ID for this managed resource.
    Authorization map[string]string
    Id string
    The provider-assigned unique ID for this managed resource.
    authorization Map<String,String>
    id String
    The provider-assigned unique ID for this managed resource.
    authorization {[key: string]: string}
    id string
    The provider-assigned unique ID for this managed resource.
    authorization Mapping[str, str]
    id str
    The provider-assigned unique ID for this managed resource.
    authorization Map<String>
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ServiceEndpointPipeline Resource

    Get an existing ServiceEndpointPipeline 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?: ServiceEndpointPipelineState, opts?: CustomResourceOptions): ServiceEndpointPipeline
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_personal: Optional[ServiceEndpointPipelineAuthPersonalArgs] = None,
        authorization: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        organization_name: Optional[str] = None,
        project_id: Optional[str] = None,
        service_endpoint_name: Optional[str] = None) -> ServiceEndpointPipeline
    func GetServiceEndpointPipeline(ctx *Context, name string, id IDInput, state *ServiceEndpointPipelineState, opts ...ResourceOption) (*ServiceEndpointPipeline, error)
    public static ServiceEndpointPipeline Get(string name, Input<string> id, ServiceEndpointPipelineState? state, CustomResourceOptions? opts = null)
    public static ServiceEndpointPipeline get(String name, Output<String> id, ServiceEndpointPipelineState state, CustomResourceOptions options)
    resources:  _:    type: azuredevops:ServiceEndpointPipeline    get:      id: ${id}
    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:
    AuthPersonal Pulumi.AzureDevOps.Inputs.ServiceEndpointPipelineAuthPersonal
    An auth_personal block as documented below. Allows connecting using a personal access token.
    Authorization Dictionary<string, string>
    Description string
    OrganizationName string
    The organization name used for Organization Url and Release API Url fields.
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    AuthPersonal ServiceEndpointPipelineAuthPersonalArgs
    An auth_personal block as documented below. Allows connecting using a personal access token.
    Authorization map[string]string
    Description string
    OrganizationName string
    The organization name used for Organization Url and Release API Url fields.
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    authPersonal ServiceEndpointPipelineAuthPersonal
    An auth_personal block as documented below. Allows connecting using a personal access token.
    authorization Map<String,String>
    description String
    organizationName String
    The organization name used for Organization Url and Release API Url fields.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    authPersonal ServiceEndpointPipelineAuthPersonal
    An auth_personal block as documented below. Allows connecting using a personal access token.
    authorization {[key: string]: string}
    description string
    organizationName string
    The organization name used for Organization Url and Release API Url fields.
    projectId string
    The ID of the project.
    serviceEndpointName string
    The Service Endpoint name.
    auth_personal ServiceEndpointPipelineAuthPersonalArgs
    An auth_personal block as documented below. Allows connecting using a personal access token.
    authorization Mapping[str, str]
    description str
    organization_name str
    The organization name used for Organization Url and Release API Url fields.
    project_id str
    The ID of the project.
    service_endpoint_name str
    The Service Endpoint name.
    authPersonal Property Map
    An auth_personal block as documented below. Allows connecting using a personal access token.
    authorization Map<String>
    description String
    organizationName String
    The organization name used for Organization Url and Release API Url fields.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.

    Supporting Types

    ServiceEndpointPipelineAuthPersonal, ServiceEndpointPipelineAuthPersonalArgs

    PersonalAccessToken string
    The Personal Access Token for Azure DevOps Pipeline. It also can be set with AZDO_PERSONAL_ACCESS_TOKEN environment variable.
    PersonalAccessToken string
    The Personal Access Token for Azure DevOps Pipeline. It also can be set with AZDO_PERSONAL_ACCESS_TOKEN environment variable.
    personalAccessToken String
    The Personal Access Token for Azure DevOps Pipeline. It also can be set with AZDO_PERSONAL_ACCESS_TOKEN environment variable.
    personalAccessToken string
    The Personal Access Token for Azure DevOps Pipeline. It also can be set with AZDO_PERSONAL_ACCESS_TOKEN environment variable.
    personal_access_token str
    The Personal Access Token for Azure DevOps Pipeline. It also can be set with AZDO_PERSONAL_ACCESS_TOKEN environment variable.
    personalAccessToken String
    The Personal Access Token for Azure DevOps Pipeline. It also can be set with AZDO_PERSONAL_ACCESS_TOKEN environment variable.

    Import

    Azure DevOps Run Pipeline Service Endpoint can be imported using the project id, service connection id, e.g.

    $ pulumi import azuredevops:index/serviceEndpointPipeline:ServiceEndpointPipeline example projectID/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.8.0 published on Monday, Mar 17, 2025 by Pulumi
    pulumi/pulumi-azuredevops