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
[--branch-match-type {exact, prefix}]
[--detect {false, true}]
[--org --organization]
[--path-filter]
[--project]
Required Parameters
Whether the policy should be blocking or not.
Property | Value |
---|---|
Accepted values: | false, true |
Branch on which this policy should be applied. For example: master.
Build Definition Id.
Display name for this build policy to identify the policy. For example: 'Manual queue policy'.
Whether the policy is enabled or not.
Property | Value |
---|---|
Accepted values: | false, true |
Whether to allow only manual queue of builds.
Property | Value |
---|---|
Accepted values: | false, true |
Queue Only on source update.
Property | Value |
---|---|
Accepted values: | false, true |
Id of the repository on which to apply the policy.
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.
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 |
Automatically detect organization.
Property | Value |
---|---|
Accepted values: | false, true |
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/
.
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.
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.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az repos policy build update
Update build policy.
az repos policy build update --id --policy-id
[--blocking {false, true}]
[--branch]
[--branch-match-type {exact, prefix}]
[--build-definition-id]
[--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 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.
Whether the policy should be blocking or not.
Property | Value |
---|---|
Accepted values: | false, true |
Branch on which this policy should be applied. For example: master.
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.
Automatically detect organization.
Property | Value |
---|---|
Accepted values: | false, true |
Display name for this build policy to identify the policy. For example: 'Manual queue policy'.
Whether the policy is enabled or not.
Property | Value |
---|---|
Accepted values: | false, true |
Whether to allow only manual queue of builds.
Property | Value |
---|---|
Accepted values: | false, true |
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/
.
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.
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 Only on source update.
Property | Value |
---|---|
Accepted values: | false, true |
Id of the repository on which to apply the policy.
Policy validity duration (in minutes).
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |