Share via

az pipelines release

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

Manage releases.

Commands

Name Description Type Status
az pipelines release create

Request (create) a release.

 Extension GA
az pipelines release definition

Manage release definitions.

 Extension GA
az pipelines release definition list

List release definitions.

 Extension GA
az pipelines release definition show

Get the details of a release definition.

 Extension GA
az pipelines release list

List release results.

 Extension GA
az pipelines release show

Get the details of a release.

 Extension GA

az pipelines release create

Request (create) a release.

az pipelines release create [--artifact-metadata-list]
                            [--definition-id]
                            [--definition-name]
                            [--description]
                            [--detect {false, true}]
                            [--open]
                            [--org --organization]
                            [--project]

Optional Parameters

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

--artifact-metadata-list

Space separated "alias=version_id" pairs.

--definition-id

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

--definition-name

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

--description

Description of the release.

--detect

Automatically detect organization.

Property Value
Accepted values: false, true
--open

Open the release results page in your web browser.

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

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az pipelines release list

List release results.

az pipelines release list [--definition-id]
                          [--detect {false, true}]
                          [--max-created-time]
                          [--min-created-time]
                          [--org --organization]
                          [--project]
                          [--source-branch]
                          [--status]
                          [--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.

--definition-id

ID of definition to list releases for.

--detect

Automatically detect organization.

Property Value
Accepted values: false, true
--max-created-time

Releases that were created before this time.

--min-created-time

Releases that were created after this time.

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

--source-branch

Filter releases for this branch.

--status

Limit to releases with this status.

--top

Maximum number of releases to list. Default is 50.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az pipelines release show

Get the details of a release.

az pipelines release show --id
                          [--detect {false, true}]
                          [--open]
                          [--org --organization]
                          [--project]

Required Parameters

--id

ID of the release.

Optional Parameters

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

--detect

Automatically detect organization.

Property Value
Accepted values: false, true
--open

Open the release results page in your web browser.

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

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False