az extension

  • Reference

Manage and update CLI extensions.

Commands

Name Description Type Status
az extension add

Add an extension.

 Core GA
az extension list

List the installed extensions.

 Core GA
az extension list-available

List publicly available extensions.

 Core GA
az extension list-versions

List available versions for an extension.

 Core GA
az extension remove

Remove an extension.

 Core GA
az extension show

Show an extension.

 Core GA
az extension update

Update an extension.

 Core GA

az extension add

Edit

Add an extension.

To learn about installing extensions automatically, visit https://aka.ms/AzExtDynamicInstall.

az extension add [--allow-preview {false, true}]
                 [--name]
                 [--pip-extra-index-urls]
                 [--pip-proxy]
                 [--source]
                 [--system]
                 [--upgrade]
                 [--version]
                 [--yes]

Examples

Add extension by name

az extension add --name anextension

Add extension from URL

az extension add --source https://contoso.com/anextension-0.0.1-py2.py3-none-any.whl

Add extension from local disk

az extension add --source ~/anextension-0.0.1-py2.py3-none-any.whl

Add extension from local disk and use pip proxy for dependencies

az extension add --source ~/anextension-0.0.1-py2.py3-none-any.whl --pip-proxy https://user:pass@proxy.server:8080

Add extension to system directory

az extension add --name anextension --system

Add a specific version of extension

az extension add --name anextension --version 1.0.0

Upgrade the extension if already installed

az extension add --upgrade --name anextension

Optional Parameters

--allow-preview

Include preview packages for extension installation, if exists.

Accepted values: false, true
--name -n

Name of extension.

--pip-extra-index-urls

Space-separated list of extra URLs of package indexes to use. This should point to a repository compliant with PEP 503 (the simple repository API) or a local directory laid out in the same format.

--pip-proxy

Proxy for pip to use for extension dependencies in the form of [user:passwd@]proxy.server:port.

--source -s

Filepath or URL to an extension.

--system

Use a system directory for the extension.

Default path is azure-cli-extensions folder under the CLI running python environment lib path, configurable by environment variable AZURE_EXTENSION_SYS_DIR. On Windows, you may need to open your shell as Administrator to run with the right permission.

--upgrade

Update the extension if already installed, otherwise just install the extension.

--version

The specific version of an extension.

Default value: latest
--yes -y

Do not prompt for confirmation.

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

Edit

List the installed extensions.

az extension 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 extension list-available

Edit

List publicly available extensions.

az extension list-available [--show-details]

Examples

List all publicly available extensions

az extension list-available

List details on a particular extension

az extension list-available --show-details --query anextension

Optional Parameters

--show-details -d

Show the raw data from the extension index.

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.

az extension list-versions

Edit

List available versions for an extension.

az extension list-versions --name

Examples

List available versions for an extension

az extension list-versions --name anextension

Required Parameters

--name -n

Name of extension.

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 extension remove

Edit

Remove an extension.

az extension remove --name

Examples

Remove an extension. (autogenerated)

az extension remove --name MyExtension

Required Parameters

--name -n

Name of extension.

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

Edit

Show an extension.

az extension show --name

Examples

Show an extension. (autogenerated)

az extension show --name MyExtension

Required Parameters

--name -n

Name of extension.

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 extension update

Edit

Update an extension.

az extension update --name
                    [--allow-preview {false, true}]
                    [--pip-extra-index-urls]
                    [--pip-proxy]

Examples

Update an extension by name

az extension update --name anextension

Update an extension by name and use pip proxy for dependencies

az extension update --name anextension --pip-proxy https://user:pass@proxy.server:8080

Required Parameters

--name -n

Name of extension.

Optional Parameters

--allow-preview

Include preview packages for extension installation, if exists.

Accepted values: false, true
--pip-extra-index-urls

Space-separated list of extra URLs of package indexes to use. This should point to a repository compliant with PEP 503 (the simple repository API) or a local directory laid out in the same format.

--pip-proxy

Proxy for pip to use for extension dependencies in the form of [user:passwd@]proxy.server:port.

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.