Docs Packages
  1. Packages
  2. AzureDevOps
  3. API Docs
  4. BranchPolicyWorkItemLinking
Azure DevOps v2.13.0 published on Thursday, Sep 14, 2023 by Pulumi
pulumi/pulumi-azuredevops

azuredevops.BranchPolicyWorkItemLinking

Explore with Pulumi AI

azuredevops logo
Azure DevOps v2.13.0 published on Thursday, Sep 14, 2023 by Pulumi
pulumi/pulumi-azuredevops

    Require associations between branches and a work item within Azure DevOps.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

return await Deployment.RunAsync(() => 
{
    var exampleProject = new AzureDevOps.Project("exampleProject");

    var exampleGit = new AzureDevOps.Git("exampleGit", new()
    {
        ProjectId = exampleProject.Id,
        Initialization = new AzureDevOps.Inputs.GitInitializationArgs
        {
            InitType = "Clean",
        },
    });

    var exampleBranchPolicyWorkItemLinking = new AzureDevOps.BranchPolicyWorkItemLinking("exampleBranchPolicyWorkItemLinking", new()
    {
        ProjectId = exampleProject.Id,
        Enabled = true,
        Blocking = true,
        Settings = new AzureDevOps.Inputs.BranchPolicyWorkItemLinkingSettingsArgs
        {
            Scopes = new[]
            {
                new AzureDevOps.Inputs.BranchPolicyWorkItemLinkingSettingsScopeArgs
                {
                    RepositoryId = exampleGit.Id,
                    RepositoryRef = exampleGit.DefaultBranch,
                    MatchType = "Exact",
                },
                new AzureDevOps.Inputs.BranchPolicyWorkItemLinkingSettingsScopeArgs
                {
                    RepositoryId = exampleGit.Id,
                    RepositoryRef = "refs/heads/releases",
                    MatchType = "Prefix",
                },
                new AzureDevOps.Inputs.BranchPolicyWorkItemLinkingSettingsScopeArgs
                {
                    MatchType = "DefaultBranch",
                },
            },
        },
    });

});

    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", nil)
		if err != nil {
			return err
		}
		exampleGit, err := azuredevops.NewGit(ctx, "exampleGit", &azuredevops.GitArgs{
			ProjectId: exampleProject.ID(),
			Initialization: &azuredevops.GitInitializationArgs{
				InitType: pulumi.String("Clean"),
			},
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewBranchPolicyWorkItemLinking(ctx, "exampleBranchPolicyWorkItemLinking", &azuredevops.BranchPolicyWorkItemLinkingArgs{
			ProjectId: exampleProject.ID(),
			Enabled:   pulumi.Bool(true),
			Blocking:  pulumi.Bool(true),
			Settings: &azuredevops.BranchPolicyWorkItemLinkingSettingsArgs{
				Scopes: azuredevops.BranchPolicyWorkItemLinkingSettingsScopeArray{
					&azuredevops.BranchPolicyWorkItemLinkingSettingsScopeArgs{
						RepositoryId:  exampleGit.ID(),
						RepositoryRef: exampleGit.DefaultBranch,
						MatchType:     pulumi.String("Exact"),
					},
					&azuredevops.BranchPolicyWorkItemLinkingSettingsScopeArgs{
						RepositoryId:  exampleGit.ID(),
						RepositoryRef: pulumi.String("refs/heads/releases"),
						MatchType:     pulumi.String("Prefix"),
					},
					&azuredevops.BranchPolicyWorkItemLinkingSettingsScopeArgs{
						MatchType: pulumi.String("DefaultBranch"),
					},
				},
			},
		})
		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.Git;
import com.pulumi.azuredevops.GitArgs;
import com.pulumi.azuredevops.inputs.GitInitializationArgs;
import com.pulumi.azuredevops.BranchPolicyWorkItemLinking;
import com.pulumi.azuredevops.BranchPolicyWorkItemLinkingArgs;
import com.pulumi.azuredevops.inputs.BranchPolicyWorkItemLinkingSettingsArgs;
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");

        var exampleGit = new Git("exampleGit", GitArgs.builder()        
            .projectId(exampleProject.id())
            .initialization(GitInitializationArgs.builder()
                .initType("Clean")
                .build())
            .build());

        var exampleBranchPolicyWorkItemLinking = new BranchPolicyWorkItemLinking("exampleBranchPolicyWorkItemLinking", BranchPolicyWorkItemLinkingArgs.builder()        
            .projectId(exampleProject.id())
            .enabled(true)
            .blocking(true)
            .settings(BranchPolicyWorkItemLinkingSettingsArgs.builder()
                .scopes(                
                    BranchPolicyWorkItemLinkingSettingsScopeArgs.builder()
                        .repositoryId(exampleGit.id())
                        .repositoryRef(exampleGit.defaultBranch())
                        .matchType("Exact")
                        .build(),
                    BranchPolicyWorkItemLinkingSettingsScopeArgs.builder()
                        .repositoryId(exampleGit.id())
                        .repositoryRef("refs/heads/releases")
                        .matchType("Prefix")
                        .build(),
                    BranchPolicyWorkItemLinkingSettingsScopeArgs.builder()
                        .matchType("DefaultBranch")
                        .build())
                .build())
            .build());

    }
}

    import pulumi
import pulumi_azuredevops as azuredevops

example_project = azuredevops.Project("exampleProject")
example_git = azuredevops.Git("exampleGit",
    project_id=example_project.id,
    initialization=azuredevops.GitInitializationArgs(
        init_type="Clean",
    ))
example_branch_policy_work_item_linking = azuredevops.BranchPolicyWorkItemLinking("exampleBranchPolicyWorkItemLinking",
    project_id=example_project.id,
    enabled=True,
    blocking=True,
    settings=azuredevops.BranchPolicyWorkItemLinkingSettingsArgs(
        scopes=[
            azuredevops.BranchPolicyWorkItemLinkingSettingsScopeArgs(
                repository_id=example_git.id,
                repository_ref=example_git.default_branch,
                match_type="Exact",
            ),
            azuredevops.BranchPolicyWorkItemLinkingSettingsScopeArgs(
                repository_id=example_git.id,
                repository_ref="refs/heads/releases",
                match_type="Prefix",
            ),
            azuredevops.BranchPolicyWorkItemLinkingSettingsScopeArgs(
                match_type="DefaultBranch",
            ),
        ],
    ))

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

const exampleProject = new azuredevops.Project("exampleProject", {});
const exampleGit = new azuredevops.Git("exampleGit", {
    projectId: exampleProject.id,
    initialization: {
        initType: "Clean",
    },
});
const exampleBranchPolicyWorkItemLinking = new azuredevops.BranchPolicyWorkItemLinking("exampleBranchPolicyWorkItemLinking", {
    projectId: exampleProject.id,
    enabled: true,
    blocking: true,
    settings: {
        scopes: [
            {
                repositoryId: exampleGit.id,
                repositoryRef: exampleGit.defaultBranch,
                matchType: "Exact",
            },
            {
                repositoryId: exampleGit.id,
                repositoryRef: "refs/heads/releases",
                matchType: "Prefix",
            },
            {
                matchType: "DefaultBranch",
            },
        ],
    },
});

    resources:
  exampleProject:
    type: azuredevops:Project
  exampleGit:
    type: azuredevops:Git
    properties:
      projectId: ${exampleProject.id}
      initialization:
        initType: Clean
  exampleBranchPolicyWorkItemLinking:
    type: azuredevops:BranchPolicyWorkItemLinking
    properties:
      projectId: ${exampleProject.id}
      enabled: true
      blocking: true
      settings:
        scopes:
          - repositoryId: ${exampleGit.id}
            repositoryRef: ${exampleGit.defaultBranch}
            matchType: Exact
          - repositoryId: ${exampleGit.id}
            repositoryRef: refs/heads/releases
            matchType: Prefix
          - matchType: DefaultBranch

    Create BranchPolicyWorkItemLinking Resource

    new BranchPolicyWorkItemLinking(name: string, args: BranchPolicyWorkItemLinkingArgs, opts?: CustomResourceOptions);
    @overload
def BranchPolicyWorkItemLinking(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                blocking: Optional[bool] = None,
                                enabled: Optional[bool] = None,
                                project_id: Optional[str] = None,
                                settings: Optional[BranchPolicyWorkItemLinkingSettingsArgs] = None)
@overload
def BranchPolicyWorkItemLinking(resource_name: str,
                                args: BranchPolicyWorkItemLinkingArgs,
                                opts: Optional[ResourceOptions] = None)
    func NewBranchPolicyWorkItemLinking(ctx *Context, name string, args BranchPolicyWorkItemLinkingArgs, opts ...ResourceOption) (*BranchPolicyWorkItemLinking, error)
    public BranchPolicyWorkItemLinking(string name, BranchPolicyWorkItemLinkingArgs args, CustomResourceOptions? opts = null)
    public BranchPolicyWorkItemLinking(String name, BranchPolicyWorkItemLinkingArgs args)
public BranchPolicyWorkItemLinking(String name, BranchPolicyWorkItemLinkingArgs args, CustomResourceOptions options)

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

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

    ProjectId string

    The ID of the project in which the policy will be created.

    Settings Pulumi.AzureDevOps.Inputs.BranchPolicyWorkItemLinkingSettings

    Configuration for the policy. This block must be defined exactly once.

    Blocking bool

    A flag indicating if the policy should be blocking. Defaults to true.

    Enabled bool

    A flag indicating if the policy should be enabled. Defaults to true.

    ProjectId string

    The ID of the project in which the policy will be created.

    Settings BranchPolicyWorkItemLinkingSettingsArgs

    Configuration for the policy. This block must be defined exactly once.

    Blocking bool

    A flag indicating if the policy should be blocking. Defaults to true.

    Enabled bool

    A flag indicating if the policy should be enabled. Defaults to true.

    projectId String

    The ID of the project in which the policy will be created.

    settings BranchPolicyWorkItemLinkingSettings

    Configuration for the policy. This block must be defined exactly once.

    blocking Boolean

    A flag indicating if the policy should be blocking. Defaults to true.

    enabled Boolean

    A flag indicating if the policy should be enabled. Defaults to true.

    projectId string

    The ID of the project in which the policy will be created.

    settings BranchPolicyWorkItemLinkingSettings

    Configuration for the policy. This block must be defined exactly once.

    blocking boolean

    A flag indicating if the policy should be blocking. Defaults to true.

    enabled boolean

    A flag indicating if the policy should be enabled. Defaults to true.

    project_id str

    The ID of the project in which the policy will be created.

    settings BranchPolicyWorkItemLinkingSettingsArgs

    Configuration for the policy. This block must be defined exactly once.

    blocking bool

    A flag indicating if the policy should be blocking. Defaults to true.

    enabled bool

    A flag indicating if the policy should be enabled. Defaults to true.

    projectId String

    The ID of the project in which the policy will be created.

    settings Property Map

    Configuration for the policy. This block must be defined exactly once.

    blocking Boolean

    A flag indicating if the policy should be blocking. Defaults to true.

    enabled Boolean

    A flag indicating if the policy should be enabled. Defaults to true.

    Outputs

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

    Get an existing BranchPolicyWorkItemLinking 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?: BranchPolicyWorkItemLinkingState, opts?: CustomResourceOptions): BranchPolicyWorkItemLinking
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        blocking: Optional[bool] = None,
        enabled: Optional[bool] = None,
        project_id: Optional[str] = None,
        settings: Optional[BranchPolicyWorkItemLinkingSettingsArgs] = None) -> BranchPolicyWorkItemLinking
    func GetBranchPolicyWorkItemLinking(ctx *Context, name string, id IDInput, state *BranchPolicyWorkItemLinkingState, opts ...ResourceOption) (*BranchPolicyWorkItemLinking, error)
    public static BranchPolicyWorkItemLinking Get(string name, Input<string> id, BranchPolicyWorkItemLinkingState? state, CustomResourceOptions? opts = null)
    public static BranchPolicyWorkItemLinking get(String name, Output<String> id, BranchPolicyWorkItemLinkingState 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:
    Blocking bool

    A flag indicating if the policy should be blocking. Defaults to true.

    Enabled bool

    A flag indicating if the policy should be enabled. Defaults to true.

    ProjectId string

    The ID of the project in which the policy will be created.

    Settings Pulumi.AzureDevOps.Inputs.BranchPolicyWorkItemLinkingSettings

    Configuration for the policy. This block must be defined exactly once.

    Blocking bool

    A flag indicating if the policy should be blocking. Defaults to true.

    Enabled bool

    A flag indicating if the policy should be enabled. Defaults to true.

    ProjectId string

    The ID of the project in which the policy will be created.

    Settings BranchPolicyWorkItemLinkingSettingsArgs

    Configuration for the policy. This block must be defined exactly once.

    blocking Boolean

    A flag indicating if the policy should be blocking. Defaults to true.

    enabled Boolean

    A flag indicating if the policy should be enabled. Defaults to true.

    projectId String

    The ID of the project in which the policy will be created.

    settings BranchPolicyWorkItemLinkingSettings

    Configuration for the policy. This block must be defined exactly once.

    blocking boolean

    A flag indicating if the policy should be blocking. Defaults to true.

    enabled boolean

    A flag indicating if the policy should be enabled. Defaults to true.

    projectId string

    The ID of the project in which the policy will be created.

    settings BranchPolicyWorkItemLinkingSettings

    Configuration for the policy. This block must be defined exactly once.

    blocking bool

    A flag indicating if the policy should be blocking. Defaults to true.

    enabled bool

    A flag indicating if the policy should be enabled. Defaults to true.

    project_id str

    The ID of the project in which the policy will be created.

    settings BranchPolicyWorkItemLinkingSettingsArgs

    Configuration for the policy. This block must be defined exactly once.

    blocking Boolean

    A flag indicating if the policy should be blocking. Defaults to true.

    enabled Boolean

    A flag indicating if the policy should be enabled. Defaults to true.

    projectId String

    The ID of the project in which the policy will be created.

    settings Property Map

    Configuration for the policy. This block must be defined exactly once.

    Supporting Types

    BranchPolicyWorkItemLinkingSettings, BranchPolicyWorkItemLinkingSettingsArgs

    Scopes List<Pulumi.AzureDevOps.Inputs.BranchPolicyWorkItemLinkingSettingsScope>

    Controls which repositories and branches the policy will be enabled for. This block must be defined at least once.

    Scopes []BranchPolicyWorkItemLinkingSettingsScope

    Controls which repositories and branches the policy will be enabled for. This block must be defined at least once.

    scopes List<BranchPolicyWorkItemLinkingSettingsScope>

    Controls which repositories and branches the policy will be enabled for. This block must be defined at least once.

    scopes BranchPolicyWorkItemLinkingSettingsScope[]

    Controls which repositories and branches the policy will be enabled for. This block must be defined at least once.

    scopes Sequence[BranchPolicyWorkItemLinkingSettingsScope]

    Controls which repositories and branches the policy will be enabled for. This block must be defined at least once.

    scopes List<Property Map>

    Controls which repositories and branches the policy will be enabled for. This block must be defined at least once.

    BranchPolicyWorkItemLinkingSettingsScope, BranchPolicyWorkItemLinkingSettingsScopeArgs

    MatchType string

    The match type to use when applying the policy. Supported values are Exact (default), Prefix or DefaultBranch.

    RepositoryId string

    The repository ID. Needed only if the scope of the policy will be limited to a single repository. If match_type is DefaultBranch, this should not be defined.

    RepositoryRef string

    The ref pattern to use for the match when match_type other than DefaultBranch. If match_type is Exact, this should be a qualified ref such as refs/heads/master. If match_type is Prefix, this should be a ref path such as refs/heads/releases.

    MatchType string

    The match type to use when applying the policy. Supported values are Exact (default), Prefix or DefaultBranch.

    RepositoryId string

    The repository ID. Needed only if the scope of the policy will be limited to a single repository. If match_type is DefaultBranch, this should not be defined.

    RepositoryRef string

    The ref pattern to use for the match when match_type other than DefaultBranch. If match_type is Exact, this should be a qualified ref such as refs/heads/master. If match_type is Prefix, this should be a ref path such as refs/heads/releases.

    matchType String

    The match type to use when applying the policy. Supported values are Exact (default), Prefix or DefaultBranch.

    repositoryId String

    The repository ID. Needed only if the scope of the policy will be limited to a single repository. If match_type is DefaultBranch, this should not be defined.

    repositoryRef String

    The ref pattern to use for the match when match_type other than DefaultBranch. If match_type is Exact, this should be a qualified ref such as refs/heads/master. If match_type is Prefix, this should be a ref path such as refs/heads/releases.

    matchType string

    The match type to use when applying the policy. Supported values are Exact (default), Prefix or DefaultBranch.

    repositoryId string

    The repository ID. Needed only if the scope of the policy will be limited to a single repository. If match_type is DefaultBranch, this should not be defined.

    repositoryRef string

    The ref pattern to use for the match when match_type other than DefaultBranch. If match_type is Exact, this should be a qualified ref such as refs/heads/master. If match_type is Prefix, this should be a ref path such as refs/heads/releases.

    match_type str

    The match type to use when applying the policy. Supported values are Exact (default), Prefix or DefaultBranch.

    repository_id str

    The repository ID. Needed only if the scope of the policy will be limited to a single repository. If match_type is DefaultBranch, this should not be defined.

    repository_ref str

    The ref pattern to use for the match when match_type other than DefaultBranch. If match_type is Exact, this should be a qualified ref such as refs/heads/master. If match_type is Prefix, this should be a ref path such as refs/heads/releases.

    matchType String

    The match type to use when applying the policy. Supported values are Exact (default), Prefix or DefaultBranch.

    repositoryId String

    The repository ID. Needed only if the scope of the policy will be limited to a single repository. If match_type is DefaultBranch, this should not be defined.

    repositoryRef String

    The ref pattern to use for the match when match_type other than DefaultBranch. If match_type is Exact, this should be a qualified ref such as refs/heads/master. If match_type is Prefix, this should be a ref path such as refs/heads/releases.

    Import

    Azure DevOps Branch Policies can be imported using the project ID and policy configuration ID

     $ pulumi import azuredevops:index/branchPolicyWorkItemLinking:BranchPolicyWorkItemLinking example 00000000-0000-0000-0000-000000000000/0

    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 v2.13.0 published on Thursday, Sep 14, 2023 by Pulumi
    pulumi/pulumi-azuredevops