Add-AzDoPipelineBranchControl#
SYNOPSIS#
Creates a Build Validation policy on a branch
SYNTAX#
Add-AzDoPipelineBranchControl [-CollectionUri] <String> [-ProjectName] <String> [[-PolicyName] <String>]
[-ResourceType] <String> [-ResourceName] <String[]> [[-AllowUnknownStatusBranches] <String>]
[[-AllowedBranches] <String>] [[-EnsureProtectionOfBranch] <String>] [[-Timeout] <Int32>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION#
Creates a Build Validation policy on a branch
EXAMPLES#
EXAMPLE 1#
$params = @{
CollectionUri = "https://dev.azure.com/contoso"
ProjectName = "Project 1"
ResourceType = "environment"
ResourceName = "MyEnvironment"
}
Add-AzDoPipelineBranchControl @params
Default usage
EXAMPLE 2#
$params = @{
CollectionUri = "https://dev.azure.com/contoso"
ProjectName = "Project 1"
ResourceType = "repository"
ResourceName = "MyRepo"
AllowedBranches = "refs/heads/main,refs/heads/develop"
EnsureProtectionOfBranch = "true"
}
Add-AzDoPipelineBranchControl @params
Add allowed branches and ensure branch protection
PARAMETERS#
-CollectionUri#
Collection Uri of the organization
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ProjectName#
Project where the pipeline will be created.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-PolicyName#
Name of the Build Validation policy. Default is the name of the Build Definition
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Branch Control
Accept pipeline input: False
Accept wildcard characters: False
-ResourceType#
The type of Azure DevOps resource to be protected by a build validation policy
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ResourceName#
Name of the resource to be protected by a build validation policy
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AllowUnknownStatusBranches#
Allow deployment from branches for which protection status could not be obtained.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-AllowedBranches#
Setup a comma separated list of branches from which a pipeline must be run to access this resource
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: Refs/head/main
Accept pipeline input: False
Accept wildcard characters: False
-EnsureProtectionOfBranch#
Validate the branches being deployed are protected.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: True
Accept pipeline input: False
Accept wildcard characters: False
-Timeout#
Valid duration of the Build Validation policy. Default is 1440 minutes
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 1440
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf#
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm#
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction#
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters#
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.