Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az repos policy build

Note

This reference is part of the azure-devops extension for the Azure CLI (version 2.30.0 or higher). The extension will automatically install the first time you run an az repos policy build command. Learn more about extensions.

Manage build policy.

Commands

Name Description Type Status
az repos policy build create

Create build policy.

 Extension GA
az repos policy build update

Update build policy.

 Extension GA

az repos policy build create

Create build policy.

az repos policy build create --blocking {false, true}
 --branch
 --build-definition-id
 --display-name
 --enabled {false, true}
 --manual-queue-only {false, true}
 --queue-on-source-update-only {false, true}
 --repository-id
 --valid-duration
 [--acquire-policy-token]
 [--branch-match-type {exact, prefix}]
 [--change-reference]
 [--detect {false, true}]
 [--org --organization]
 [--path-filter]
 [--project]

Required Parameters

--blocking

Whether the policy should be blocking or not.

Property Value
Accepted values: false, true
--branch

Branch on which this policy should be applied. For example: master.

--build-definition-id

Build Definition Id.

--display-name

Display name for this build policy to identify the policy. For example: 'Manual queue policy'.

--enabled

Whether the policy is enabled or not.

Property Value
Accepted values: false, true
--manual-queue-only

Whether to allow only manual queue of builds.

Property Value
Accepted values: false, true
--queue-on-source-update-only

Queue Only on source update.

Property Value
Accepted values: false, true
--repository-id

Id of the repository on which to apply the policy.

--valid-duration

Policy validity duration (in minutes).

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--branch-match-type

Determines how the branch argument is used to apply a policy. If value is 'exact', the policy will be applied on a branch which has an exact match on the --branch argument. If value is 'prefix' the policy is applied across all branch folders that match the prefix provided by the --branch argument.

Property Value
Default value: exact
Accepted values: exact, prefix
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--detect

Automatically detect organization.

Property Value
Accepted values: false, true
--org --organization

Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.

--path-filter

Filter path(s) on which the policy is applied. Supports absolute paths, wildcards and multiple paths separated by ';'. Example: /WebApp/Models/Data.cs, /WebApp/* or *.cs,/WebApp/Models/Data.cs;ClientApp/Models/Data.cs.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

az repos policy build update

Update build policy.

az repos policy build update --id --policy-id
 [--acquire-policy-token]
 [--blocking {false, true}]
 [--branch]
 [--branch-match-type {exact, prefix}]
 [--build-definition-id]
 [--change-reference]
 [--detect {false, true}]
 [--display-name]
 [--enabled {false, true}]
 [--manual-queue-only {false, true}]
 [--org --organization]
 [--path-filter]
 [--project]
 [--queue-on-source-update-only {false, true}]
 [--repository-id]
 [--valid-duration]

Required Parameters

--id --policy-id

ID of the policy.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--blocking

Whether the policy should be blocking or not.

Property Value
Accepted values: false, true
--branch

Branch on which this policy should be applied. For example: master.

--branch-match-type

Determines how the branch argument is used to apply a policy. If value is 'exact', the policy will be applied on a branch which has an exact match on the --branch argument. If value is 'prefix' the policy is applied across all branch folders that match the prefix provided by the --branch argument.

Property Value
Accepted values: exact, prefix
--build-definition-id

Build Definition Id.

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--detect

Automatically detect organization.

Property Value
Accepted values: false, true
--display-name

Display name for this build policy to identify the policy. For example: 'Manual queue policy'.

--enabled

Whether the policy is enabled or not.

Property Value
Accepted values: false, true
--manual-queue-only

Whether to allow only manual queue of builds.

Property Value
Accepted values: false, true
--org --organization

Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.

--path-filter

Filter path(s) on which the policy is applied. Supports absolute paths, wildcards and multiple paths separated by ';'. Example: /WebApp/Models/Data.cs, /WebApp/* or *.cs,/WebApp/Models/Data.cs;ClientApp/Models/Data.cs.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

--queue-on-source-update-only

Queue Only on source update.

Property Value
Accepted values: false, true
--repository-id

Id of the repository on which to apply the policy.

--valid-duration

Policy validity duration (in minutes).

Feedback

Was this page helpful?