az pipelines build

Manage builds.

Commands

az pipelines build definition

Manage build definitions.

az pipelines build definition list

List build definitions.

az pipelines build definition show

Get the details of a build definition.

az pipelines build list

List build results.

az pipelines build queue

Request (queue) a build.

az pipelines build show

Get the details of a build.

az pipelines build tag

Manage build tags.

az pipelines build tag add

Add tag(s) for a build.

az pipelines build tag delete

Delete a build tag.

az pipelines build tag list

Get tags for a build.

az pipelines build list

List build results.

az pipelines build list [--branch]
                        [--definition-ids]
                        [--detect {false, true}]
                        [--org]
                        [--project]
                        [--query-examples]
                        [--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}]
                        [--subscription]
                        [--tags]
                        [--top]

Optional Parameters

--branch

Filter by builds for this branch.

--definition-ids

IDs (space separated) of definitions to list builds for.

--detect

Automatically detect organization.

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/.

--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.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--reason

Limit to builds with this reason.

accepted values: all, batchedCI, buildCompletion, checkInShelveset, individualCI, manual, pullRequest, schedule, triggered, userCreated, validateShelveset
--requested-for

Limit to builds requested for this user or group.

--result

Limit to builds with this result.

accepted values: canceled, failed, none, partiallySucceeded, succeeded
--status

Limit to builds with this status.

accepted values: all, cancelling, completed, inProgress, none, notStarted, postponed
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Limit to builds with each of the specified tags. Space separated.

--top

Maximum number of builds to list.

az pipelines build queue

Request (queue) a build.

az pipelines build queue [--branch]
                         [--commit-id]
                         [--definition-id]
                         [--definition-name]
                         [--detect {false, true}]
                         [--open]
                         [--org]
                         [--project]
                         [--queue-id]
                         [--subscription]
                         [--variables]

Optional Parameters

--branch

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.

--commit-id

Commit ID of the branch to build.

--definition-id

ID of the definition to queue. Required if --name is not supplied.

--definition-name

Name of the definition to queue. Ignored if --id is supplied.

--detect

Automatically detect organization.

accepted values: false, true
--open

Open the build results page in your web browser.

--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/.

--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-id

Queue Id of the pool that will be used to queue the build.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--variables

Space separated "name=value" pairs for the variables you would like to set.

az pipelines build show

Get the details of a build.

az pipelines build show --id
                        [--detect {false, true}]
                        [--open]
                        [--org]
                        [--project]
                        [--query-examples]
                        [--subscription]

Required Parameters

--id

ID of the build.

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--open

Open the build results page in your web browser.

--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/.

--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.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.