你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az extension

管理和更新 CLI 扩展。

命令

名称	说明	类型	状态
az extension add	添加扩展。	核心	GA
az extension list	列出已安装的扩展。	核心	GA
az extension list-available	列出公开可用的扩展。	核心	GA
az extension list-versions	列出扩展的可用版本。	核心	GA
az extension remove	删除扩展。	核心	GA
az extension show	显示扩展。	核心	GA
az extension update	更新扩展。	核心	GA

az extension add

添加扩展。

若要了解如何自动安装扩展，请访问 https://aka.ms/AzExtDynamicInstall。

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

示例

按名称添加扩展

az extension add --name anextension

从 URL 添加扩展

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

从本地磁盘添加扩展

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

从本地磁盘添加扩展并使用 pip 代理进行依赖项

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

将扩展添加到系统目录

az extension add --name anextension --system

添加特定版本的扩展

az extension add --name anextension --version 1.0.0

升级扩展（如果已安装）

az extension add --upgrade --name anextension

可选参数

--allow-preview

包括用于扩展安装的预览包（如果存在）。

接受的值: false, true

--name -n

扩展的名称。

--pip-extra-index-urls

要使用的包索引的附加 URL 的空格分隔列表。 这应该指向符合 PEP 503（简单存储库 API）的存储库或以相同格式展开的本地目录。

--pip-proxy

用于 pip 的代理，以 [user：passwd@]proxy.server：port 的形式用于扩展依赖项。

--source -s

文件扩展名的 Filepath 或 URL。

--system

使用扩展的系统目录。

默认路径是运行 python 环境库路径的 CLI 下的 azure-cli-extensions 文件夹，可通过环境变量AZURE_EXTENSION_SYS_DIR进行配置。 在 Windows 上，可能需要以 管理员istrator 身份打开 shell，以使用正确的权限运行。

--upgrade

如果已安装扩展，请更新该扩展，否则只需安装该扩展。

--version

扩展的特定版本。

默认值: latest

--yes -y

不提示确认。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az extension list

列出已安装的扩展。

az extension list

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az extension list-available

列出公开可用的扩展。

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

示例

列出所有公开可用的扩展

az extension list-available

列出特定扩展的详细信息

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

可选参数

--show-details -d

显示扩展索引中的原始数据。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az extension list-versions

列出扩展的可用版本。

az extension list-versions --name

示例

列出扩展的可用版本

az extension list-versions --name anextension

必需参数

--name -n

扩展的名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az extension remove

删除扩展。

az extension remove --name

示例

删除扩展。 （自动生成）

az extension remove --name MyExtension

必需参数

--name -n

扩展的名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az extension show

显示扩展。

az extension show --name

示例

显示扩展。 （自动生成）

az extension show --name MyExtension

必需参数

--name -n

扩展的名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az extension update

更新扩展。

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

示例

按名称更新扩展

az extension update --name anextension

按名称更新扩展并使用 pip 代理进行依赖项

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

必需参数

--name -n

扩展的名称。

可选参数

--allow-preview

包括用于扩展安装的预览包（如果存在）。

接受的值: false, true

--pip-extra-index-urls

要使用的包索引的附加 URL 的空格分隔列表。 这应该指向符合 PEP 503（简单存储库 API）的存储库或以相同格式展开的本地目录。

--pip-proxy

用于 pip 的代理，以 [user：passwd@]proxy.server：port 的形式用于扩展依赖项。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。