Share via

az devops extension

  • 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 devops extension command. Learn more about extensions.

Manage extensions.

Commands

Name Description Type Status
az devops extension disable

Disable an extension.

 Extension GA
az devops extension enable

Enable an extension.

 Extension GA
az devops extension install

Install an extension.

 Extension GA
az devops extension list

List extensions installed in an organization.

 Extension GA
az devops extension search

Search extensions from marketplace.

 Extension GA
az devops extension show

Get detail of single extension.

 Extension GA
az devops extension uninstall

Uninstall an extension.

 Extension GA

az devops extension disable

Disable an extension.

az devops extension disable --extension-id
                            --publisher-id
                            [--detect {false, true}]
                            [--org]

Required Parameters

--extension-id

Extension Id. This will map to extension-name in the az devops extension search output.

--publisher-id

Publisher Id. This will map to publisher-name in the az devops extension search output.

Optional Parameters

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

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 devops extension enable

Enable an extension.

az devops extension enable --extension-id
                           --publisher-id
                           [--detect {false, true}]
                           [--org]

Required Parameters

--extension-id

Extension Id. This will map to extension-name in the az devops extension search output.

--publisher-id

Publisher Id. This will map to publisher-name in the az devops extension search output.

Optional Parameters

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

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 devops extension install

Install an extension.

az devops extension install --extension-id
                            --publisher-id
                            [--detect {false, true}]
                            [--org]

Required Parameters

--extension-id

Extension Id. This will map to extension-name in the az devops extension search output.

--publisher-id

Publisher Id. This will map to publisher-name in the az devops extension search output.

Optional Parameters

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

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 devops extension list

List extensions installed in an organization.

az devops extension list [--detect {false, true}]
                         [--include-built-in {false, true}]
                         [--include-disabled {false, true}]
                         [--org]

Optional Parameters

--detect

Automatically detect organization.

Accepted values: false, true
--include-built-in

Include built in extensions.

Accepted values: false, true
--include-disabled

Include disabled extensions.

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

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.

Search extensions from marketplace.

az devops extension search --search-query

Required Parameters

--search-query -q

Search term.

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 devops extension show

Get detail of single extension.

az devops extension show --extension-id
                         --publisher-id
                         [--detect {false, true}]
                         [--org]

Required Parameters

--extension-id

Extension Id. This will map to extension-name in the az devops extension search output.

--publisher-id

Publisher Id. This will map to publisher-name in the az devops extension search output.

Optional Parameters

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

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 devops extension uninstall

Uninstall an extension.

az devops extension uninstall --extension-id
                              --publisher-id
                              [--detect {false, true}]
                              [--org]
                              [--yes]

Required Parameters

--extension-id

Extension Id. This will map to extension-name in the az devops extension search output.

--publisher-id

Publisher Id. This will map to publisher-name in the az devops extension search output.

Optional Parameters

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

--yes -y

Do not prompt for confirmation.

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