Docs Packages
  1. Pulumi Registry
  2. AzureDevOps
  3. API Docs
  4. ServiceEndpointPipeline
azuredevops logo
Azure DevOps v2.7.0, Mar 27 23

azuredevops.ServiceEndpointPipeline

Explore with Pulumi AI

Manages a Azure DevOps 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

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 exampleServiceEndpointPipeline = new AzureDevOps.ServiceEndpointPipeline("exampleServiceEndpointPipeline", new()
    {
        ProjectId = exampleProject.Id,
        ServiceEndpointName = "Example Pipeline Runner",
        OrganizationName = "Organization Name",
        AuthPersonal = new AzureDevOps.Inputs.ServiceEndpointPipelineAuthPersonalArgs
        {
            PersonalAccessToken = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        },
        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.NewServiceEndpointPipeline(ctx, "exampleServiceEndpointPipeline", &azuredevops.ServiceEndpointPipelineArgs{
			ProjectId:           exampleProject.ID(),
			ServiceEndpointName: pulumi.String("Example Pipeline Runner"),
			OrganizationName:    pulumi.String("Organization Name"),
			AuthPersonal: &azuredevops.ServiceEndpointPipelineAuthPersonalArgs{
				PersonalAccessToken: pulumi.String("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
			},
			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.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 exampleProject = new Project("exampleProject", ProjectArgs.builder()        
            .visibility("private")
            .versionControl("Git")
            .workItemTemplate("Agile")
            .description("Managed by Terraform")
            .build());

        var exampleServiceEndpointPipeline = new ServiceEndpointPipeline("exampleServiceEndpointPipeline", ServiceEndpointPipelineArgs.builder()        
            .projectId(exampleProject.id())
            .serviceEndpointName("Example Pipeline Runner")
            .organizationName("Organization Name")
            .authPersonal(ServiceEndpointPipelineAuthPersonalArgs.builder()
                .personalAccessToken("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
                .build())
            .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_pipeline = azuredevops.ServiceEndpointPipeline("exampleServiceEndpointPipeline",
    project_id=example_project.id,
    service_endpoint_name="Example Pipeline Runner",
    organization_name="Organization Name",
    auth_personal=azuredevops.ServiceEndpointPipelineAuthPersonalArgs(
        personal_access_token="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    ),
    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 exampleServiceEndpointPipeline = new azuredevops.ServiceEndpointPipeline("exampleServiceEndpointPipeline", {
    projectId: exampleProject.id,
    serviceEndpointName: "Example Pipeline Runner",
    organizationName: "Organization Name",
    authPersonal: {
        personalAccessToken: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    },
    description: "Managed by Terraform",
});

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

Create ServiceEndpointPipeline Resource

new ServiceEndpointPipeline(name: string, args: ServiceEndpointPipelineArgs, opts?: CustomResourceOptions);
@overload
def ServiceEndpointPipeline(resource_name: 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)
@overload
def ServiceEndpointPipeline(resource_name: str,
                            args: ServiceEndpointPipelineArgs,
                            opts: Optional[ResourceOptions] = 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.
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.

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

The ServiceEndpointPipeline resource accepts the following input properties:

AuthPersonal Pulumi.AzureDevOps.Inputs.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.

Authorization Dictionary<string, string>
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.

Authorization map[string]string
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.

authorization Map<String,String>
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.

authorization {[key: string]: string}
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.

authorization Mapping[str, str]
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.

authorization Map<String>
description String

Outputs

All input properties are implicitly available as output properties. Additionally, the ServiceEndpointPipeline 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 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)
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:
AuthPersonal Pulumi.AzureDevOps.Inputs.ServiceEndpointPipelineAuthPersonalArgs

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 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 ServiceEndpointPipelineAuthPersonalArgs

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

PersonalAccessToken string

The Personal Access Token for Azure DevOps Pipeline. It also can be set with AZDO_PERSONAL_ACCESS_TOKEN environment variable.

PersonalAccessTokenHash string
PersonalAccessToken string

The Personal Access Token for Azure DevOps Pipeline. It also can be set with AZDO_PERSONAL_ACCESS_TOKEN environment variable.

PersonalAccessTokenHash string
personalAccessToken String

The Personal Access Token for Azure DevOps Pipeline. It also can be set with AZDO_PERSONAL_ACCESS_TOKEN environment variable.

personalAccessTokenHash String
personalAccessToken string

The Personal Access Token for Azure DevOps Pipeline. It also can be set with AZDO_PERSONAL_ACCESS_TOKEN environment variable.

personalAccessTokenHash string
personal_access_token str

The Personal Access Token for Azure DevOps Pipeline. It also can be set with AZDO_PERSONAL_ACCESS_TOKEN environment variable.

personal_access_token_hash str
personalAccessToken String

The Personal Access Token for Azure DevOps Pipeline. It also can be set with AZDO_PERSONAL_ACCESS_TOKEN environment variable.

personalAccessTokenHash String

Import

Azure DevOps 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

Package Details

Repository
Azure DevOps pulumi/pulumi-azuredevops
License
Apache-2.0
Notes

This Pulumi package is based on the azuredevops Terraform Provider.