Share via

az pipelines build definition

  • Reference

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 definition command. Learn more about extensions.

Manage build definitions.

Commands

Name Description Type Status
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 definition list

List build definitions.

az pipelines build definition list [--detect {false, true}]
                                   [--name]
                                   [--org]
                                   [--project]
                                   [--repository]
                                   [--repository-type {bitbucket, git, github, githubenterprise, svn, tfsgit, tfsversioncontrol}]
                                   [--top]

Optional Parameters

--detect

Automatically detect organization.

Accepted values: false, true
--name

Limit results to definitions with this name or starting with this name. Examples: "FabCI" or "Fab*".

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

--repository

Limit results to definitions associated with this repository.

--repository-type

Limit results to definitions associated with this repository type. It is mandatory to pass 'repository' argument along with this argument.

Accepted values: bitbucket, git, github, githubenterprise, svn, tfsgit, tfsversioncontrol
--top

Maximum number of definitions to list.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az pipelines build definition show

Get the details of a build definition.

az pipelines build definition show [--detect {false, true}]
                                   [--id]
                                   [--name]
                                   [--open]
                                   [--org]
                                   [--project]

Optional Parameters

--detect

Automatically detect organization.

Accepted values: false, true
--id

ID of the definition.

--name

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

--open

Open the definition summary page in your web browser.

Default value: False
--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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.