Azure DevOps v3.8.0, Mar 17 25

Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi

azuredevops.PipelineAuthorization

Explore with Pulumi AI

Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi

Example Usage

Authorization for all pipelines

TypeScript
Python
Go
C#
Java
YAML

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 examplePool = new azuredevops.Pool("example", {
    name: "Example Pool",
    autoProvision: false,
    autoUpdate: false,
});
const exampleQueue = new azuredevops.Queue("example", {
    projectId: example.id,
    agentPoolId: examplePool.id,
});
const examplePipelineAuthorization = new azuredevops.PipelineAuthorization("example", {
    projectId: example.id,
    resourceId: exampleQueue.id,
    type: "queue",
});

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_pool = azuredevops.Pool("example",
    name="Example Pool",
    auto_provision=False,
    auto_update=False)
example_queue = azuredevops.Queue("example",
    project_id=example.id,
    agent_pool_id=example_pool.id)
example_pipeline_authorization = azuredevops.PipelineAuthorization("example",
    project_id=example.id,
    resource_id=example_queue.id,
    type="queue")

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
		}
		examplePool, err := azuredevops.NewPool(ctx, "example", &azuredevops.PoolArgs{
			Name:          pulumi.String("Example Pool"),
			AutoProvision: pulumi.Bool(false),
			AutoUpdate:    pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		exampleQueue, err := azuredevops.NewQueue(ctx, "example", &azuredevops.QueueArgs{
			ProjectId:   example.ID(),
			AgentPoolId: examplePool.ID(),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewPipelineAuthorization(ctx, "example", &azuredevops.PipelineAuthorizationArgs{
			ProjectId:  example.ID(),
			ResourceId: exampleQueue.ID(),
			Type:       pulumi.String("queue"),
		})
		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 examplePool = new AzureDevOps.Pool("example", new()
    {
        Name = "Example Pool",
        AutoProvision = false,
        AutoUpdate = false,
    });

    var exampleQueue = new AzureDevOps.Queue("example", new()
    {
        ProjectId = example.Id,
        AgentPoolId = examplePool.Id,
    });

    var examplePipelineAuthorization = new AzureDevOps.PipelineAuthorization("example", new()
    {
        ProjectId = example.Id,
        ResourceId = exampleQueue.Id,
        Type = "queue",
    });

});

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.Pool;
import com.pulumi.azuredevops.PoolArgs;
import com.pulumi.azuredevops.Queue;
import com.pulumi.azuredevops.QueueArgs;
import com.pulumi.azuredevops.PipelineAuthorization;
import com.pulumi.azuredevops.PipelineAuthorizationArgs;
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 examplePool = new Pool("examplePool", PoolArgs.builder()
            .name("Example Pool")
            .autoProvision(false)
            .autoUpdate(false)
            .build());

        var exampleQueue = new Queue("exampleQueue", QueueArgs.builder()
            .projectId(example.id())
            .agentPoolId(examplePool.id())
            .build());

        var examplePipelineAuthorization = new PipelineAuthorization("examplePipelineAuthorization", PipelineAuthorizationArgs.builder()
            .projectId(example.id())
            .resourceId(exampleQueue.id())
            .type("queue")
            .build());

    }
}

resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Pulumi
  examplePool:
    type: azuredevops:Pool
    name: example
    properties:
      name: Example Pool
      autoProvision: false
      autoUpdate: false
  exampleQueue:
    type: azuredevops:Queue
    name: example
    properties:
      projectId: ${example.id}
      agentPoolId: ${examplePool.id}
  examplePipelineAuthorization:
    type: azuredevops:PipelineAuthorization
    name: example
    properties:
      projectId: ${example.id}
      resourceId: ${exampleQueue.id}
      type: queue

Authorization for specific pipeline

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const exampleProject = new azuredevops.Project("example", {
    name: "Example Project",
    visibility: "private",
    versionControl: "Git",
    workItemTemplate: "Agile",
    description: "Managed by Pulumi",
});
const examplePool = new azuredevops.Pool("example", {
    name: "Example Pool",
    autoProvision: false,
    autoUpdate: false,
});
const exampleQueue = new azuredevops.Queue("example", {
    projectId: exampleProject.id,
    agentPoolId: examplePool.id,
});
const example = azuredevops.getGitRepositoryOutput({
    projectId: exampleProject.id,
    name: "Example Project",
});
const exampleBuildDefinition = new azuredevops.BuildDefinition("example", {
    projectId: exampleProject.id,
    name: "Example Pipeline",
    repository: {
        repoType: "TfsGit",
        repoId: example.apply(example => example.id),
        ymlPath: "azure-pipelines.yml",
    },
});
const examplePipelineAuthorization = new azuredevops.PipelineAuthorization("example", {
    projectId: exampleProject.id,
    resourceId: exampleQueue.id,
    type: "queue",
    pipelineId: exampleBuildDefinition.id,
});

import pulumi
import pulumi_azuredevops as azuredevops

example_project = azuredevops.Project("example",
    name="Example Project",
    visibility="private",
    version_control="Git",
    work_item_template="Agile",
    description="Managed by Pulumi")
example_pool = azuredevops.Pool("example",
    name="Example Pool",
    auto_provision=False,
    auto_update=False)
example_queue = azuredevops.Queue("example",
    project_id=example_project.id,
    agent_pool_id=example_pool.id)
example = azuredevops.get_git_repository_output(project_id=example_project.id,
    name="Example Project")
example_build_definition = azuredevops.BuildDefinition("example",
    project_id=example_project.id,
    name="Example Pipeline",
    repository={
        "repo_type": "TfsGit",
        "repo_id": example.id,
        "yml_path": "azure-pipelines.yml",
    })
example_pipeline_authorization = azuredevops.PipelineAuthorization("example",
    project_id=example_project.id,
    resource_id=example_queue.id,
    type="queue",
    pipeline_id=example_build_definition.id)

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 {
		exampleProject, 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
		}
		examplePool, err := azuredevops.NewPool(ctx, "example", &azuredevops.PoolArgs{
			Name:          pulumi.String("Example Pool"),
			AutoProvision: pulumi.Bool(false),
			AutoUpdate:    pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		exampleQueue, err := azuredevops.NewQueue(ctx, "example", &azuredevops.QueueArgs{
			ProjectId:   exampleProject.ID(),
			AgentPoolId: examplePool.ID(),
		})
		if err != nil {
			return err
		}
		example := azuredevops.GetGitRepositoryOutput(ctx, azuredevops.GetGitRepositoryOutputArgs{
			ProjectId: exampleProject.ID(),
			Name:      pulumi.String("Example Project"),
		}, nil)
		exampleBuildDefinition, err := azuredevops.NewBuildDefinition(ctx, "example", &azuredevops.BuildDefinitionArgs{
			ProjectId: exampleProject.ID(),
			Name:      pulumi.String("Example Pipeline"),
			Repository: &azuredevops.BuildDefinitionRepositoryArgs{
				RepoType: pulumi.String("TfsGit"),
				RepoId: example.ApplyT(func(example azuredevops.GetGitRepositoryResult) (*string, error) {
					return &example.Id, nil
				}).(pulumi.StringPtrOutput),
				YmlPath: pulumi.String("azure-pipelines.yml"),
			},
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewPipelineAuthorization(ctx, "example", &azuredevops.PipelineAuthorizationArgs{
			ProjectId:  exampleProject.ID(),
			ResourceId: exampleQueue.ID(),
			Type:       pulumi.String("queue"),
			PipelineId: exampleBuildDefinition.ID(),
		})
		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 exampleProject = new AzureDevOps.Project("example", new()
    {
        Name = "Example Project",
        Visibility = "private",
        VersionControl = "Git",
        WorkItemTemplate = "Agile",
        Description = "Managed by Pulumi",
    });

    var examplePool = new AzureDevOps.Pool("example", new()
    {
        Name = "Example Pool",
        AutoProvision = false,
        AutoUpdate = false,
    });

    var exampleQueue = new AzureDevOps.Queue("example", new()
    {
        ProjectId = exampleProject.Id,
        AgentPoolId = examplePool.Id,
    });

    var example = AzureDevOps.GetGitRepository.Invoke(new()
    {
        ProjectId = exampleProject.Id,
        Name = "Example Project",
    });

    var exampleBuildDefinition = new AzureDevOps.BuildDefinition("example", new()
    {
        ProjectId = exampleProject.Id,
        Name = "Example Pipeline",
        Repository = new AzureDevOps.Inputs.BuildDefinitionRepositoryArgs
        {
            RepoType = "TfsGit",
            RepoId = example.Apply(getGitRepositoryResult => getGitRepositoryResult.Id),
            YmlPath = "azure-pipelines.yml",
        },
    });

    var examplePipelineAuthorization = new AzureDevOps.PipelineAuthorization("example", new()
    {
        ProjectId = exampleProject.Id,
        ResourceId = exampleQueue.Id,
        Type = "queue",
        PipelineId = exampleBuildDefinition.Id,
    });

});

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.Pool;
import com.pulumi.azuredevops.PoolArgs;
import com.pulumi.azuredevops.Queue;
import com.pulumi.azuredevops.QueueArgs;
import com.pulumi.azuredevops.AzuredevopsFunctions;
import com.pulumi.azuredevops.inputs.GetGitRepositoryArgs;
import com.pulumi.azuredevops.BuildDefinition;
import com.pulumi.azuredevops.BuildDefinitionArgs;
import com.pulumi.azuredevops.inputs.BuildDefinitionRepositoryArgs;
import com.pulumi.azuredevops.PipelineAuthorization;
import com.pulumi.azuredevops.PipelineAuthorizationArgs;
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()
            .name("Example Project")
            .visibility("private")
            .versionControl("Git")
            .workItemTemplate("Agile")
            .description("Managed by Pulumi")
            .build());

        var examplePool = new Pool("examplePool", PoolArgs.builder()
            .name("Example Pool")
            .autoProvision(false)
            .autoUpdate(false)
            .build());

        var exampleQueue = new Queue("exampleQueue", QueueArgs.builder()
            .projectId(exampleProject.id())
            .agentPoolId(examplePool.id())
            .build());

        final var example = AzuredevopsFunctions.getGitRepository(GetGitRepositoryArgs.builder()
            .projectId(exampleProject.id())
            .name("Example Project")
            .build());

        var exampleBuildDefinition = new BuildDefinition("exampleBuildDefinition", BuildDefinitionArgs.builder()
            .projectId(exampleProject.id())
            .name("Example Pipeline")
            .repository(BuildDefinitionRepositoryArgs.builder()
                .repoType("TfsGit")
                .repoId(example.applyValue(getGitRepositoryResult -> getGitRepositoryResult).applyValue(example -> example.applyValue(getGitRepositoryResult -> getGitRepositoryResult.id())))
                .ymlPath("azure-pipelines.yml")
                .build())
            .build());

        var examplePipelineAuthorization = new PipelineAuthorization("examplePipelineAuthorization", PipelineAuthorizationArgs.builder()
            .projectId(exampleProject.id())
            .resourceId(exampleQueue.id())
            .type("queue")
            .pipelineId(exampleBuildDefinition.id())
            .build());

    }
}

resources:
  exampleProject:
    type: azuredevops:Project
    name: example
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Pulumi
  examplePool:
    type: azuredevops:Pool
    name: example
    properties:
      name: Example Pool
      autoProvision: false
      autoUpdate: false
  exampleQueue:
    type: azuredevops:Queue
    name: example
    properties:
      projectId: ${exampleProject.id}
      agentPoolId: ${examplePool.id}
  exampleBuildDefinition:
    type: azuredevops:BuildDefinition
    name: example
    properties:
      projectId: ${exampleProject.id}
      name: Example Pipeline
      repository:
        repoType: TfsGit
        repoId: ${example.id}
        ymlPath: azure-pipelines.yml
  examplePipelineAuthorization:
    type: azuredevops:PipelineAuthorization
    name: example
    properties:
      projectId: ${exampleProject.id}
      resourceId: ${exampleQueue.id}
      type: queue
      pipelineId: ${exampleBuildDefinition.id}
variables:
  example:
    fn::invoke:
      function: azuredevops:getGitRepository
      arguments:
        projectId: ${exampleProject.id}
        name: Example Project

Relevant Links

Azure DevOps Service REST API 7.1 - Pipeline Permissions

Create PipelineAuthorization Resource

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

new PipelineAuthorization(name: string, args: PipelineAuthorizationArgs, opts?: CustomResourceOptions);

@overload
def PipelineAuthorization(resource_name: str,
                          args: PipelineAuthorizationArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def PipelineAuthorization(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          project_id: Optional[str] = None,
                          resource_id: Optional[str] = None,
                          type: Optional[str] = None,
                          pipeline_id: Optional[int] = None,
                          pipeline_project_id: Optional[str] = None)

func NewPipelineAuthorization(ctx *Context, name string, args PipelineAuthorizationArgs, opts ...ResourceOption) (*PipelineAuthorization, error)

public PipelineAuthorization(string name, PipelineAuthorizationArgs args, CustomResourceOptions? opts = null)

public PipelineAuthorization(String name, PipelineAuthorizationArgs args)
public PipelineAuthorization(String name, PipelineAuthorizationArgs args, CustomResourceOptions options)

type: azuredevops:PipelineAuthorization
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 PipelineAuthorizationArgs: 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 PipelineAuthorizationArgs: 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 PipelineAuthorizationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PipelineAuthorizationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PipelineAuthorizationArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var pipelineAuthorizationResource = new AzureDevOps.PipelineAuthorization("pipelineAuthorizationResource", new()
{
    ProjectId = "string",
    ResourceId = "string",
    Type = "string",
    PipelineId = 0,
    PipelineProjectId = "string",
});

example, err := azuredevops.NewPipelineAuthorization(ctx, "pipelineAuthorizationResource", &azuredevops.PipelineAuthorizationArgs{
	ProjectId:         pulumi.String("string"),
	ResourceId:        pulumi.String("string"),
	Type:              pulumi.String("string"),
	PipelineId:        pulumi.Int(0),
	PipelineProjectId: pulumi.String("string"),
})

var pipelineAuthorizationResource = new PipelineAuthorization("pipelineAuthorizationResource", PipelineAuthorizationArgs.builder()
    .projectId("string")
    .resourceId("string")
    .type("string")
    .pipelineId(0)
    .pipelineProjectId("string")
    .build());

pipeline_authorization_resource = azuredevops.PipelineAuthorization("pipelineAuthorizationResource",
    project_id="string",
    resource_id="string",
    type="string",
    pipeline_id=0,
    pipeline_project_id="string")

const pipelineAuthorizationResource = new azuredevops.PipelineAuthorization("pipelineAuthorizationResource", {
    projectId: "string",
    resourceId: "string",
    type: "string",
    pipelineId: 0,
    pipelineProjectId: "string",
});

type: azuredevops:PipelineAuthorization
properties:
    pipelineId: 0
    pipelineProjectId: string
    projectId: string
    resourceId: string
    type: string

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

ProjectId string: The ID of the project. Changing this forces a new resource to be created
ResourceId string: The ID of the resource to authorize. Changing this forces a new resource to be created
Type string: The type of the resource to authorize. Possible values are: endpoint, queue, variablegroup, environment, repository. Changing this forces a new resource to be created
Note repository is for AzureDevOps repository. To authorize repository other than Azure DevOps like GitHub you need to use service connection(endpoint) to connect and authorize. Typical process for connecting to GitHub: Pipeline <----> Service Connection(endpoint) <----> GitHub Repository
PipelineId int: The ID of the pipeline. If not configured, all pipelines will be authorized. Changing this forces a new resource to be created.
PipelineProjectId string: The ID of the project where the pipeline exists. Defaults to project_id if not specified. Changing this forces a new resource to be created

ProjectId string: The ID of the project. Changing this forces a new resource to be created
ResourceId string: The ID of the resource to authorize. Changing this forces a new resource to be created
Type string: The type of the resource to authorize. Possible values are: endpoint, queue, variablegroup, environment, repository. Changing this forces a new resource to be created
Note repository is for AzureDevOps repository. To authorize repository other than Azure DevOps like GitHub you need to use service connection(endpoint) to connect and authorize. Typical process for connecting to GitHub: Pipeline <----> Service Connection(endpoint) <----> GitHub Repository
PipelineId int: The ID of the pipeline. If not configured, all pipelines will be authorized. Changing this forces a new resource to be created.
PipelineProjectId string: The ID of the project where the pipeline exists. Defaults to project_id if not specified. Changing this forces a new resource to be created

projectId String: The ID of the project. Changing this forces a new resource to be created
resourceId String: The ID of the resource to authorize. Changing this forces a new resource to be created
type String: The type of the resource to authorize. Possible values are: endpoint, queue, variablegroup, environment, repository. Changing this forces a new resource to be created
Note repository is for AzureDevOps repository. To authorize repository other than Azure DevOps like GitHub you need to use service connection(endpoint) to connect and authorize. Typical process for connecting to GitHub: Pipeline <----> Service Connection(endpoint) <----> GitHub Repository
pipelineId Integer: The ID of the pipeline. If not configured, all pipelines will be authorized. Changing this forces a new resource to be created.
pipelineProjectId String: The ID of the project where the pipeline exists. Defaults to project_id if not specified. Changing this forces a new resource to be created

projectId string: The ID of the project. Changing this forces a new resource to be created
resourceId string: The ID of the resource to authorize. Changing this forces a new resource to be created
type string: The type of the resource to authorize. Possible values are: endpoint, queue, variablegroup, environment, repository. Changing this forces a new resource to be created
Note repository is for AzureDevOps repository. To authorize repository other than Azure DevOps like GitHub you need to use service connection(endpoint) to connect and authorize. Typical process for connecting to GitHub: Pipeline <----> Service Connection(endpoint) <----> GitHub Repository
pipelineId number: The ID of the pipeline. If not configured, all pipelines will be authorized. Changing this forces a new resource to be created.
pipelineProjectId string: The ID of the project where the pipeline exists. Defaults to project_id if not specified. Changing this forces a new resource to be created

project_id str: The ID of the project. Changing this forces a new resource to be created
resource_id str: The ID of the resource to authorize. Changing this forces a new resource to be created
type str: The type of the resource to authorize. Possible values are: endpoint, queue, variablegroup, environment, repository. Changing this forces a new resource to be created
Note repository is for AzureDevOps repository. To authorize repository other than Azure DevOps like GitHub you need to use service connection(endpoint) to connect and authorize. Typical process for connecting to GitHub: Pipeline <----> Service Connection(endpoint) <----> GitHub Repository
pipeline_id int: The ID of the pipeline. If not configured, all pipelines will be authorized. Changing this forces a new resource to be created.
pipeline_project_id str: The ID of the project where the pipeline exists. Defaults to project_id if not specified. Changing this forces a new resource to be created

projectId String: The ID of the project. Changing this forces a new resource to be created
resourceId String: The ID of the resource to authorize. Changing this forces a new resource to be created
type String: The type of the resource to authorize. Possible values are: endpoint, queue, variablegroup, environment, repository. Changing this forces a new resource to be created
Note repository is for AzureDevOps repository. To authorize repository other than Azure DevOps like GitHub you need to use service connection(endpoint) to connect and authorize. Typical process for connecting to GitHub: Pipeline <----> Service Connection(endpoint) <----> GitHub Repository
pipelineId Number: The ID of the pipeline. If not configured, all pipelines will be authorized. Changing this forces a new resource to be created.
pipelineProjectId String: The ID of the project where the pipeline exists. Defaults to project_id if not specified. Changing this forces a new resource to be created

Outputs

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

Get an existing PipelineAuthorization resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: PipelineAuthorizationState, opts?: CustomResourceOptions): PipelineAuthorization

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        pipeline_id: Optional[int] = None,
        pipeline_project_id: Optional[str] = None,
        project_id: Optional[str] = None,
        resource_id: Optional[str] = None,
        type: Optional[str] = None) -> PipelineAuthorization

func GetPipelineAuthorization(ctx *Context, name string, id IDInput, state *PipelineAuthorizationState, opts ...ResourceOption) (*PipelineAuthorization, error)

public static PipelineAuthorization Get(string name, Input<string> id, PipelineAuthorizationState? state, CustomResourceOptions? opts = null)

public static PipelineAuthorization get(String name, Output<String> id, PipelineAuthorizationState state, CustomResourceOptions options)

resources:  _:    type: azuredevops:PipelineAuthorization    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:

PipelineId int: The ID of the pipeline. If not configured, all pipelines will be authorized. Changing this forces a new resource to be created.
PipelineProjectId string: The ID of the project where the pipeline exists. Defaults to project_id if not specified. Changing this forces a new resource to be created
ProjectId string: The ID of the project. Changing this forces a new resource to be created
ResourceId string: The ID of the resource to authorize. Changing this forces a new resource to be created
Type string: The type of the resource to authorize. Possible values are: endpoint, queue, variablegroup, environment, repository. Changing this forces a new resource to be created
Note repository is for AzureDevOps repository. To authorize repository other than Azure DevOps like GitHub you need to use service connection(endpoint) to connect and authorize. Typical process for connecting to GitHub: Pipeline <----> Service Connection(endpoint) <----> GitHub Repository

PipelineId int: The ID of the pipeline. If not configured, all pipelines will be authorized. Changing this forces a new resource to be created.
PipelineProjectId string: The ID of the project where the pipeline exists. Defaults to project_id if not specified. Changing this forces a new resource to be created
ProjectId string: The ID of the project. Changing this forces a new resource to be created
ResourceId string: The ID of the resource to authorize. Changing this forces a new resource to be created
Type string: The type of the resource to authorize. Possible values are: endpoint, queue, variablegroup, environment, repository. Changing this forces a new resource to be created
Note repository is for AzureDevOps repository. To authorize repository other than Azure DevOps like GitHub you need to use service connection(endpoint) to connect and authorize. Typical process for connecting to GitHub: Pipeline <----> Service Connection(endpoint) <----> GitHub Repository

pipelineId Integer: The ID of the pipeline. If not configured, all pipelines will be authorized. Changing this forces a new resource to be created.
pipelineProjectId String: The ID of the project where the pipeline exists. Defaults to project_id if not specified. Changing this forces a new resource to be created
projectId String: The ID of the project. Changing this forces a new resource to be created
resourceId String: The ID of the resource to authorize. Changing this forces a new resource to be created
type String: The type of the resource to authorize. Possible values are: endpoint, queue, variablegroup, environment, repository. Changing this forces a new resource to be created
Note repository is for AzureDevOps repository. To authorize repository other than Azure DevOps like GitHub you need to use service connection(endpoint) to connect and authorize. Typical process for connecting to GitHub: Pipeline <----> Service Connection(endpoint) <----> GitHub Repository

pipelineId number: The ID of the pipeline. If not configured, all pipelines will be authorized. Changing this forces a new resource to be created.
pipelineProjectId string: The ID of the project where the pipeline exists. Defaults to project_id if not specified. Changing this forces a new resource to be created
projectId string: The ID of the project. Changing this forces a new resource to be created
resourceId string: The ID of the resource to authorize. Changing this forces a new resource to be created
type string: The type of the resource to authorize. Possible values are: endpoint, queue, variablegroup, environment, repository. Changing this forces a new resource to be created
Note repository is for AzureDevOps repository. To authorize repository other than Azure DevOps like GitHub you need to use service connection(endpoint) to connect and authorize. Typical process for connecting to GitHub: Pipeline <----> Service Connection(endpoint) <----> GitHub Repository

pipeline_id int: The ID of the pipeline. If not configured, all pipelines will be authorized. Changing this forces a new resource to be created.
pipeline_project_id str: The ID of the project where the pipeline exists. Defaults to project_id if not specified. Changing this forces a new resource to be created
project_id str: The ID of the project. Changing this forces a new resource to be created
resource_id str: The ID of the resource to authorize. Changing this forces a new resource to be created
type str: The type of the resource to authorize. Possible values are: endpoint, queue, variablegroup, environment, repository. Changing this forces a new resource to be created
Note repository is for AzureDevOps repository. To authorize repository other than Azure DevOps like GitHub you need to use service connection(endpoint) to connect and authorize. Typical process for connecting to GitHub: Pipeline <----> Service Connection(endpoint) <----> GitHub Repository

pipelineId Number: The ID of the pipeline. If not configured, all pipelines will be authorized. Changing this forces a new resource to be created.
pipelineProjectId String: The ID of the project where the pipeline exists. Defaults to project_id if not specified. Changing this forces a new resource to be created
projectId String: The ID of the project. Changing this forces a new resource to be created
resourceId String: The ID of the resource to authorize. Changing this forces a new resource to be created
type String: The type of the resource to authorize. Possible values are: endpoint, queue, variablegroup, environment, repository. Changing this forces a new resource to be created
Note repository is for AzureDevOps repository. To authorize repository other than Azure DevOps like GitHub you need to use service connection(endpoint) to connect and authorize. Typical process for connecting to GitHub: Pipeline <----> Service Connection(endpoint) <----> GitHub Repository

Package Details

Repository: Azure DevOps pulumi/pulumi-azuredevops
License: Apache-2.0
Notes: This Pulumi package is based on the azuredevops Terraform Provider.

Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi

pulumi/pulumi-azuredevops

azuredevops.PipelineAuthorization

On this page

On this page

Example Usage

Authorization for all pipelines

Authorization for specific pipeline

Relevant Links

Create PipelineAuthorization Resource

Constructor syntax

Parameters

Constructor example

PipelineAuthorization Resource Properties

Inputs

Outputs

Look up Existing PipelineAuthorization Resource

Package Details

On this page

On this page