1. Packages
  2. AzureDevOps
  3. API Docs
  4. BranchPolicyBuildValidation
Azure DevOps v2.14.0 published on Tuesday, Oct 31, 2023 by Pulumi

azuredevops.BranchPolicyBuildValidation

Explore with Pulumi AI

azuredevops logo
Azure DevOps v2.14.0 published on Tuesday, Oct 31, 2023 by Pulumi

    Manages a build validation branch policy 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 exampleBuildDefinition = new AzureDevOps.BuildDefinition("exampleBuildDefinition", new()
        {
            ProjectId = exampleProject.Id,
            Repository = new AzureDevOps.Inputs.BuildDefinitionRepositoryArgs
            {
                RepoType = "TfsGit",
                RepoId = exampleGit.Id,
                YmlPath = "azure-pipelines.yml",
            },
        });
    
        var exampleBranchPolicyBuildValidation = new AzureDevOps.BranchPolicyBuildValidation("exampleBranchPolicyBuildValidation", new()
        {
            ProjectId = exampleProject.Id,
            Enabled = true,
            Blocking = true,
            Settings = new AzureDevOps.Inputs.BranchPolicyBuildValidationSettingsArgs
            {
                DisplayName = "Example build validation policy",
                BuildDefinitionId = exampleBuildDefinition.Id,
                ValidDuration = 720,
                FilenamePatterns = new[]
                {
                    "/WebApp/*",
                    "!/WebApp/Tests/*",
                    "*.cs",
                },
                Scopes = new[]
                {
                    new AzureDevOps.Inputs.BranchPolicyBuildValidationSettingsScopeArgs
                    {
                        RepositoryId = exampleGit.Id,
                        RepositoryRef = exampleGit.DefaultBranch,
                        MatchType = "Exact",
                    },
                    new AzureDevOps.Inputs.BranchPolicyBuildValidationSettingsScopeArgs
                    {
                        RepositoryId = exampleGit.Id,
                        RepositoryRef = "refs/heads/releases",
                        MatchType = "Prefix",
                    },
                    new AzureDevOps.Inputs.BranchPolicyBuildValidationSettingsScopeArgs
                    {
                        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
    		}
    		exampleBuildDefinition, err := azuredevops.NewBuildDefinition(ctx, "exampleBuildDefinition", &azuredevops.BuildDefinitionArgs{
    			ProjectId: exampleProject.ID(),
    			Repository: &azuredevops.BuildDefinitionRepositoryArgs{
    				RepoType: pulumi.String("TfsGit"),
    				RepoId:   exampleGit.ID(),
    				YmlPath:  pulumi.String("azure-pipelines.yml"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = azuredevops.NewBranchPolicyBuildValidation(ctx, "exampleBranchPolicyBuildValidation", &azuredevops.BranchPolicyBuildValidationArgs{
    			ProjectId: exampleProject.ID(),
    			Enabled:   pulumi.Bool(true),
    			Blocking:  pulumi.Bool(true),
    			Settings: &azuredevops.BranchPolicyBuildValidationSettingsArgs{
    				DisplayName:       pulumi.String("Example build validation policy"),
    				BuildDefinitionId: exampleBuildDefinition.ID(),
    				ValidDuration:     pulumi.Int(720),
    				FilenamePatterns: pulumi.StringArray{
    					pulumi.String("/WebApp/*"),
    					pulumi.String("!/WebApp/Tests/*"),
    					pulumi.String("*.cs"),
    				},
    				Scopes: azuredevops.BranchPolicyBuildValidationSettingsScopeArray{
    					&azuredevops.BranchPolicyBuildValidationSettingsScopeArgs{
    						RepositoryId:  exampleGit.ID(),
    						RepositoryRef: exampleGit.DefaultBranch,
    						MatchType:     pulumi.String("Exact"),
    					},
    					&azuredevops.BranchPolicyBuildValidationSettingsScopeArgs{
    						RepositoryId:  exampleGit.ID(),
    						RepositoryRef: pulumi.String("refs/heads/releases"),
    						MatchType:     pulumi.String("Prefix"),
    					},
    					&azuredevops.BranchPolicyBuildValidationSettingsScopeArgs{
    						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.BuildDefinition;
    import com.pulumi.azuredevops.BuildDefinitionArgs;
    import com.pulumi.azuredevops.inputs.BuildDefinitionRepositoryArgs;
    import com.pulumi.azuredevops.BranchPolicyBuildValidation;
    import com.pulumi.azuredevops.BranchPolicyBuildValidationArgs;
    import com.pulumi.azuredevops.inputs.BranchPolicyBuildValidationSettingsArgs;
    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 exampleBuildDefinition = new BuildDefinition("exampleBuildDefinition", BuildDefinitionArgs.builder()        
                .projectId(exampleProject.id())
                .repository(BuildDefinitionRepositoryArgs.builder()
                    .repoType("TfsGit")
                    .repoId(exampleGit.id())
                    .ymlPath("azure-pipelines.yml")
                    .build())
                .build());
    
            var exampleBranchPolicyBuildValidation = new BranchPolicyBuildValidation("exampleBranchPolicyBuildValidation", BranchPolicyBuildValidationArgs.builder()        
                .projectId(exampleProject.id())
                .enabled(true)
                .blocking(true)
                .settings(BranchPolicyBuildValidationSettingsArgs.builder()
                    .displayName("Example build validation policy")
                    .buildDefinitionId(exampleBuildDefinition.id())
                    .validDuration(720)
                    .filenamePatterns(                
                        "/WebApp/*",
                        "!/WebApp/Tests/*",
                        "*.cs")
                    .scopes(                
                        BranchPolicyBuildValidationSettingsScopeArgs.builder()
                            .repositoryId(exampleGit.id())
                            .repositoryRef(exampleGit.defaultBranch())
                            .matchType("Exact")
                            .build(),
                        BranchPolicyBuildValidationSettingsScopeArgs.builder()
                            .repositoryId(exampleGit.id())
                            .repositoryRef("refs/heads/releases")
                            .matchType("Prefix")
                            .build(),
                        BranchPolicyBuildValidationSettingsScopeArgs.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_build_definition = azuredevops.BuildDefinition("exampleBuildDefinition",
        project_id=example_project.id,
        repository=azuredevops.BuildDefinitionRepositoryArgs(
            repo_type="TfsGit",
            repo_id=example_git.id,
            yml_path="azure-pipelines.yml",
        ))
    example_branch_policy_build_validation = azuredevops.BranchPolicyBuildValidation("exampleBranchPolicyBuildValidation",
        project_id=example_project.id,
        enabled=True,
        blocking=True,
        settings=azuredevops.BranchPolicyBuildValidationSettingsArgs(
            display_name="Example build validation policy",
            build_definition_id=example_build_definition.id,
            valid_duration=720,
            filename_patterns=[
                "/WebApp/*",
                "!/WebApp/Tests/*",
                "*.cs",
            ],
            scopes=[
                azuredevops.BranchPolicyBuildValidationSettingsScopeArgs(
                    repository_id=example_git.id,
                    repository_ref=example_git.default_branch,
                    match_type="Exact",
                ),
                azuredevops.BranchPolicyBuildValidationSettingsScopeArgs(
                    repository_id=example_git.id,
                    repository_ref="refs/heads/releases",
                    match_type="Prefix",
                ),
                azuredevops.BranchPolicyBuildValidationSettingsScopeArgs(
                    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 exampleBuildDefinition = new azuredevops.BuildDefinition("exampleBuildDefinition", {
        projectId: exampleProject.id,
        repository: {
            repoType: "TfsGit",
            repoId: exampleGit.id,
            ymlPath: "azure-pipelines.yml",
        },
    });
    const exampleBranchPolicyBuildValidation = new azuredevops.BranchPolicyBuildValidation("exampleBranchPolicyBuildValidation", {
        projectId: exampleProject.id,
        enabled: true,
        blocking: true,
        settings: {
            displayName: "Example build validation policy",
            buildDefinitionId: exampleBuildDefinition.id,
            validDuration: 720,
            filenamePatterns: [
                "/WebApp/*",
                "!/WebApp/Tests/*",
                "*.cs",
            ],
            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
      exampleBuildDefinition:
        type: azuredevops:BuildDefinition
        properties:
          projectId: ${exampleProject.id}
          repository:
            repoType: TfsGit
            repoId: ${exampleGit.id}
            ymlPath: azure-pipelines.yml
      exampleBranchPolicyBuildValidation:
        type: azuredevops:BranchPolicyBuildValidation
        properties:
          projectId: ${exampleProject.id}
          enabled: true
          blocking: true
          settings:
            displayName: Example build validation policy
            buildDefinitionId: ${exampleBuildDefinition.id}
            validDuration: 720
            filenamePatterns:
              - /WebApp/*
              - '!/WebApp/Tests/*'
              - '*.cs'
            scopes:
              - repositoryId: ${exampleGit.id}
                repositoryRef: ${exampleGit.defaultBranch}
                matchType: Exact
              - repositoryId: ${exampleGit.id}
                repositoryRef: refs/heads/releases
                matchType: Prefix
              - matchType: DefaultBranch
    

    Create BranchPolicyBuildValidation Resource

    new BranchPolicyBuildValidation(name: string, args: BranchPolicyBuildValidationArgs, opts?: CustomResourceOptions);
    @overload
    def BranchPolicyBuildValidation(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    blocking: Optional[bool] = None,
                                    enabled: Optional[bool] = None,
                                    project_id: Optional[str] = None,
                                    settings: Optional[BranchPolicyBuildValidationSettingsArgs] = None)
    @overload
    def BranchPolicyBuildValidation(resource_name: str,
                                    args: BranchPolicyBuildValidationArgs,
                                    opts: Optional[ResourceOptions] = None)
    func NewBranchPolicyBuildValidation(ctx *Context, name string, args BranchPolicyBuildValidationArgs, opts ...ResourceOption) (*BranchPolicyBuildValidation, error)
    public BranchPolicyBuildValidation(string name, BranchPolicyBuildValidationArgs args, CustomResourceOptions? opts = null)
    public BranchPolicyBuildValidation(String name, BranchPolicyBuildValidationArgs args)
    public BranchPolicyBuildValidation(String name, BranchPolicyBuildValidationArgs args, CustomResourceOptions options)
    
    type: azuredevops:BranchPolicyBuildValidation
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args BranchPolicyBuildValidationArgs
    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 BranchPolicyBuildValidationArgs
    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 BranchPolicyBuildValidationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BranchPolicyBuildValidationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BranchPolicyBuildValidationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ProjectId string

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

    Settings Pulumi.AzureDevOps.Inputs.BranchPolicyBuildValidationSettings

    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 BranchPolicyBuildValidationSettingsArgs

    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 BranchPolicyBuildValidationSettings

    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 BranchPolicyBuildValidationSettings

    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 BranchPolicyBuildValidationSettingsArgs

    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 BranchPolicyBuildValidation 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 BranchPolicyBuildValidation Resource

    Get an existing BranchPolicyBuildValidation 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?: BranchPolicyBuildValidationState, opts?: CustomResourceOptions): BranchPolicyBuildValidation
    @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[BranchPolicyBuildValidationSettingsArgs] = None) -> BranchPolicyBuildValidation
    func GetBranchPolicyBuildValidation(ctx *Context, name string, id IDInput, state *BranchPolicyBuildValidationState, opts ...ResourceOption) (*BranchPolicyBuildValidation, error)
    public static BranchPolicyBuildValidation Get(string name, Input<string> id, BranchPolicyBuildValidationState? state, CustomResourceOptions? opts = null)
    public static BranchPolicyBuildValidation get(String name, Output<String> id, BranchPolicyBuildValidationState 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.BranchPolicyBuildValidationSettings

    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 BranchPolicyBuildValidationSettingsArgs

    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 BranchPolicyBuildValidationSettings

    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 BranchPolicyBuildValidationSettings

    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 BranchPolicyBuildValidationSettingsArgs

    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

    BranchPolicyBuildValidationSettings, BranchPolicyBuildValidationSettingsArgs

    BuildDefinitionId int

    The ID of the build to monitor for the policy.

    DisplayName string

    The display name for the policy.

    Scopes List<Pulumi.AzureDevOps.Inputs.BranchPolicyBuildValidationSettingsScope>

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

    FilenamePatterns List<string>

    If a path filter is set, the policy will only apply when files which match the filter are changes. Not setting this field means that the policy will always apply. You can specify absolute paths and wildcards. Example: ["/WebApp/Models/Data.cs", "/WebApp/*", "*.cs"]. Paths prefixed with "!" are excluded. Example: ["/WebApp/*", "!/WebApp/Tests/*"]. Order is significant.

    ManualQueueOnly bool

    If set to true, the build will need to be manually queued. Defaults to false

    QueueOnSourceUpdateOnly bool

    True if the build should queue on source updates only. Defaults to true.

    ValidDuration int

    The number of minutes for which the build is valid. If 0, the build will not expire. Defaults to 720 (12 hours).

    BuildDefinitionId int

    The ID of the build to monitor for the policy.

    DisplayName string

    The display name for the policy.

    Scopes []BranchPolicyBuildValidationSettingsScope

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

    FilenamePatterns []string

    If a path filter is set, the policy will only apply when files which match the filter are changes. Not setting this field means that the policy will always apply. You can specify absolute paths and wildcards. Example: ["/WebApp/Models/Data.cs", "/WebApp/*", "*.cs"]. Paths prefixed with "!" are excluded. Example: ["/WebApp/*", "!/WebApp/Tests/*"]. Order is significant.

    ManualQueueOnly bool

    If set to true, the build will need to be manually queued. Defaults to false

    QueueOnSourceUpdateOnly bool

    True if the build should queue on source updates only. Defaults to true.

    ValidDuration int

    The number of minutes for which the build is valid. If 0, the build will not expire. Defaults to 720 (12 hours).

    buildDefinitionId Integer

    The ID of the build to monitor for the policy.

    displayName String

    The display name for the policy.

    scopes List<BranchPolicyBuildValidationSettingsScope>

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

    filenamePatterns List<String>

    If a path filter is set, the policy will only apply when files which match the filter are changes. Not setting this field means that the policy will always apply. You can specify absolute paths and wildcards. Example: ["/WebApp/Models/Data.cs", "/WebApp/*", "*.cs"]. Paths prefixed with "!" are excluded. Example: ["/WebApp/*", "!/WebApp/Tests/*"]. Order is significant.

    manualQueueOnly Boolean

    If set to true, the build will need to be manually queued. Defaults to false

    queueOnSourceUpdateOnly Boolean

    True if the build should queue on source updates only. Defaults to true.

    validDuration Integer

    The number of minutes for which the build is valid. If 0, the build will not expire. Defaults to 720 (12 hours).

    buildDefinitionId number

    The ID of the build to monitor for the policy.

    displayName string

    The display name for the policy.

    scopes BranchPolicyBuildValidationSettingsScope[]

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

    filenamePatterns string[]

    If a path filter is set, the policy will only apply when files which match the filter are changes. Not setting this field means that the policy will always apply. You can specify absolute paths and wildcards. Example: ["/WebApp/Models/Data.cs", "/WebApp/*", "*.cs"]. Paths prefixed with "!" are excluded. Example: ["/WebApp/*", "!/WebApp/Tests/*"]. Order is significant.

    manualQueueOnly boolean

    If set to true, the build will need to be manually queued. Defaults to false

    queueOnSourceUpdateOnly boolean

    True if the build should queue on source updates only. Defaults to true.

    validDuration number

    The number of minutes for which the build is valid. If 0, the build will not expire. Defaults to 720 (12 hours).

    build_definition_id int

    The ID of the build to monitor for the policy.

    display_name str

    The display name for the policy.

    scopes Sequence[BranchPolicyBuildValidationSettingsScope]

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

    filename_patterns Sequence[str]

    If a path filter is set, the policy will only apply when files which match the filter are changes. Not setting this field means that the policy will always apply. You can specify absolute paths and wildcards. Example: ["/WebApp/Models/Data.cs", "/WebApp/*", "*.cs"]. Paths prefixed with "!" are excluded. Example: ["/WebApp/*", "!/WebApp/Tests/*"]. Order is significant.

    manual_queue_only bool

    If set to true, the build will need to be manually queued. Defaults to false

    queue_on_source_update_only bool

    True if the build should queue on source updates only. Defaults to true.

    valid_duration int

    The number of minutes for which the build is valid. If 0, the build will not expire. Defaults to 720 (12 hours).

    buildDefinitionId Number

    The ID of the build to monitor for the policy.

    displayName String

    The display name for the policy.

    scopes List<Property Map>

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

    filenamePatterns List<String>

    If a path filter is set, the policy will only apply when files which match the filter are changes. Not setting this field means that the policy will always apply. You can specify absolute paths and wildcards. Example: ["/WebApp/Models/Data.cs", "/WebApp/*", "*.cs"]. Paths prefixed with "!" are excluded. Example: ["/WebApp/*", "!/WebApp/Tests/*"]. Order is significant.

    manualQueueOnly Boolean

    If set to true, the build will need to be manually queued. Defaults to false

    queueOnSourceUpdateOnly Boolean

    True if the build should queue on source updates only. Defaults to true.

    validDuration Number

    The number of minutes for which the build is valid. If 0, the build will not expire. Defaults to 720 (12 hours).

    BranchPolicyBuildValidationSettingsScope, BranchPolicyBuildValidationSettingsScopeArgs

    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/branchPolicyBuildValidation:BranchPolicyBuildValidation 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.14.0 published on Tuesday, Oct 31, 2023 by Pulumi