az pipelines 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 pipelines build command. Learn more about extensions.
Manage builds.
Commands
Name | Description | Type | Status |
---|---|---|---|
az pipelines build cancel |
Cancels if build is running. |
Extension | GA |
az pipelines build definition |
Manage build definitions. |
Extension | GA |
az pipelines build definition list |
List build definitions. |
Extension | GA |
az pipelines build definition show |
Get the details of a build definition. |
Extension | GA |
az pipelines build list |
List build results. |
Extension | GA |
az pipelines build queue |
Request (queue) a build. |
Extension | GA |
az pipelines build show |
Get the details of a build. |
Extension | GA |
az pipelines build tag |
Manage build tags. |
Extension | GA |
az pipelines build tag add |
Add tag(s) for a build. |
Extension | GA |
az pipelines build tag delete |
Delete a build tag. |
Extension | GA |
az pipelines build tag list |
Get tags for a build. |
Extension | GA |
az pipelines build cancel
Cancels if build is running.
az pipelines build cancel --build-id
[--detect {false, true}]
[--open]
[--org --organization]
[--project]
Required Parameters
ID of the build.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Automatically detect organization.
Property | Value |
---|---|
Accepted values: | false, true |
Open the build results page in your web browser.
Property | Value |
---|---|
Default value: | False |
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/
.
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 pipelines build list
List build results.
az pipelines build list [--branch]
[--definition-ids]
[--detect {false, true}]
[--org --organization]
[--project]
[--reason {all, batchedCI, buildCompletion, checkInShelveset, individualCI, manual, pullRequest, schedule, triggered, userCreated, validateShelveset}]
[--requested-for]
[--result {canceled, failed, none, partiallySucceeded, succeeded}]
[--status {all, cancelling, completed, inProgress, none, notStarted, postponed}]
[--tags]
[--top]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Filter by builds for this branch.
IDs (space separated) of definitions to list builds for.
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/
.
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.
Limit to builds with this reason.
Property | Value |
---|---|
Accepted values: | all, batchedCI, buildCompletion, checkInShelveset, individualCI, manual, pullRequest, schedule, triggered, userCreated, validateShelveset |
Limit to builds requested for this user or group.
Limit to builds with this result.
Property | Value |
---|---|
Accepted values: | canceled, failed, none, partiallySucceeded, succeeded |
Limit to builds with this status.
Property | Value |
---|---|
Accepted values: | all, cancelling, completed, inProgress, none, notStarted, postponed |
Limit to builds with each of the specified tags. Space separated.
Maximum number of builds to list.
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 pipelines build queue
Request (queue) a build.
az pipelines build queue [--branch]
[--commit-id]
[--definition-id]
[--definition-name]
[--detect {false, true}]
[--open]
[--org --organization]
[--project]
[--queue-id]
[--variables]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Branch to build. Required if there is not a default branch set up on the definition. Example: refs/heads/master or master or refs/pull/1/merge or refs/tags/tag.
Commit ID of the branch to build.
ID of the definition to queue. Required if --name is not supplied.
Name of the definition to queue. Ignored if --id is supplied.
Automatically detect organization.
Property | Value |
---|---|
Accepted values: | false, true |
Open the build results page in your web browser.
Property | Value |
---|---|
Default value: | False |
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/
.
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 Id of the pool that will be used to queue the build.
Space separated "name=value" pairs for the variables you would like to set.
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 pipelines build show
Get the details of a build.
az pipelines build show --id
[--detect {false, true}]
[--open]
[--org --organization]
[--project]
Required Parameters
ID of the build.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Automatically detect organization.
Property | Value |
---|---|
Accepted values: | false, true |
Open the build results page in your web browser.
Property | Value |
---|---|
Default value: | False |
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/
.
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 |