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

az azurestackhci virtualmachine extension

注意

此参考是 Azure CLI（版本 2.15.0 或更高版本）的 azurestackhci 扩展的一部分。 该扩展将在首次运行 az azurestackhci virtualmachine 扩展 命令时自动安装。 详细了解扩展。

命令组“azurestackhci”是实验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

使用 azurestackhci 管理 virtualmachine 扩展。

命令

名称	说明	类型	状态
az azurestackhci virtualmachine extension create	创建 virtualmachine 扩展。	分机	实验
az azurestackhci virtualmachine extension delete	删除 virtualmachine 扩展。	分机	实验
az azurestackhci virtualmachine extension list	列出 virtualmachine 的所有扩展。	扩展	实验
az azurestackhci virtualmachine extension show	获取 virtualmachine 扩展的详细信息。	分机	实验
az azurestackhci virtualmachine extension update	更新 virtualmachine 扩展。	分机	实验
az azurestackhci virtualmachine extension wait	将 CLI 置于等待状态，直到满足 virtualmachine 扩展的条件。	分机	实验

az azurestackhci virtualmachine extension create

实验

命令组“azurestackhci”是实验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

创建 virtualmachine 扩展。

az azurestackhci virtualmachine extension create --name
                                                 --resource-group
                                                 --virtualmachine-name
                                                 [--auto-upgrade-minor {false, true}]
                                                 [--enable-auto-upgrade {false, true}]
                                                 [--extension-type]
                                                 [--force-update-tag]
                                                 [--inst-handler-version]
                                                 [--instance-view-type]
                                                 [--location]
                                                 [--protected-settings]
                                                 [--publisher]
                                                 [--settings]
                                                 [--status]
                                                 [--tags]
                                                 [--type-handler-version]

示例

PutExtension

az azurestackhci virtualmachine extension create --resource-group "test-rg" --location "West US2" --name "test-extension" --extension-type "CustomScriptExtension" --publisher "Microsoft.Compute" --settings '{"commandToExecute":"hostname"}' --type-handler-version "1.10" --virtualmachine-name "test-virtualmachine"

必需参数

--name

扩展插件的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--virtualmachine-name

应在其中创建或更新扩展的 virtualmachine 的名称。

可选参数

--auto-upgrade-minor

指示扩展是否应在部署时使用较新的次要版本。 但是，部署后，除非重新部署，否则扩展不会升级次要版本，即使此属性设置为 true 也是如此。

接受的值: false, true

--enable-auto-upgrade

指示如果有较新版本可用，平台是否应自动升级扩展。

接受的值: false, true

--extension-type

指定 virtualmachine 扩展的类型;例如 CustomScriptExtension。

--force-update-tag

即使扩展配置未更改，扩展处理程序也应强制更新。

--inst-handler-version

指定脚本处理程序的版本。

--instance-view-type

指定扩展的类型;例如“CustomScriptExtension”。

--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--protected-settings

该扩展可以包含受保护的设置或受保护设置FromKeyVault 或根本没有受保护的设置。 预期值：json-string/json-file/@json-file。

--publisher

virtualmachine 扩展处理程序发布者的名称。

--settings

virtualmachine 扩展的 Json 格式公共设置。

--status

实例视图状态。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--type-handler-version

指定脚本处理程序的版本。

全局参数

--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 azurestackhci virtualmachine extension delete

实验

命令组“azurestackhci”是实验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

删除 virtualmachine 扩展。

az azurestackhci virtualmachine extension delete [--ids]
                                                 [--name]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--virtualmachine-name]
                                                 [--yes]

示例

DeleteExtension

az azurestackhci virtualmachine extension delete --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg"

可选参数

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name

计算机扩展的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

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

--virtualmachine-name

应从中删除扩展的虚拟机的名称。

--yes -y

不提示确认。

默认值: 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 azurestackhci virtualmachine extension list

实验

命令组“azurestackhci”是实验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

列出 virtualmachine 的所有扩展。

az azurestackhci virtualmachine extension list --resource-group
                                               --virtualmachine-name

示例

ListExtensions

az azurestackhci virtualmachine extension list --virtualmachine-name "test-virtualmachine" --resource-group "test-rg"

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--virtualmachine-name

包含扩展的虚拟机的名称。

全局参数

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

实验

命令组“azurestackhci”是实验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

获取 virtualmachine 扩展的详细信息。

az azurestackhci virtualmachine extension show [--ids]
                                               [--name]
                                               [--resource-group]
                                               [--subscription]
                                               [--virtualmachine-name]

示例

GetExtension

az azurestackhci virtualmachine extension show --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg"

可选参数

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name

计算机扩展的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

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

--virtualmachine-name

包含扩展的虚拟机的名称。

全局参数

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

实验

命令组“azurestackhci”是实验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

更新 virtualmachine 扩展。

az azurestackhci virtualmachine extension update --name
                                                 [--auto-upgrade-minor {false, true}]
                                                 [--enable-auto-upgrade {false, true}]
                                                 [--extension-type]
                                                 [--force-update-tag]
                                                 [--ids]
                                                 [--protected-settings]
                                                 [--publisher]
                                                 [--resource-group]
                                                 [--settings]
                                                 [--subscription]
                                                 [--tags]
                                                 [--type-handler-version]
                                                 [--virtualmachine-name]

示例

UpdateExtension

az azurestackhci virtualmachine extension update --resource-group "test-rg" --name "test-extension" --extension-type "CustomScriptExtension" --virtualmachine-name "test-virtualmachine" --publisher "Microsoft.Compute" --settings '{"commandToExecute":"hostname"}' --type-handler-version "1.10"

必需参数

--name

扩展插件的名称。

可选参数

--auto-upgrade-minor

指示扩展是否应在部署时使用较新的次要版本。 但是，部署后，除非重新部署，否则扩展不会升级次要版本，即使此属性设置为 true 也是如此。

接受的值: false, true

--enable-auto-upgrade

指示如果有较新版本可用，平台是否应自动升级扩展。

接受的值: false, true

--extension-type

指定扩展的类型;例如“CustomScriptExtension”。

--force-update-tag

即使扩展配置未更改，扩展处理程序也应强制更新。

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--protected-settings

该扩展可以包含受保护的设置或受保护设置FromKeyVault 或根本没有受保护的设置。 预期值：json-string/json-file/@json-file。

--publisher

扩展处理程序发布者的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--settings

扩展的 Json 格式公共设置。 预期值：json-string/json-file/@json-file。

--subscription

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

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--type-handler-version

指定脚本处理程序的版本。

--virtualmachine-name

包含扩展的虚拟机的名称。

全局参数

--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 azurestackhci virtualmachine extension wait

实验

命令组“azurestackhci”是实验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

将 CLI 置于等待状态，直到满足 virtualmachine 扩展的条件。

az azurestackhci virtualmachine extension wait [--created]
                                               [--custom]
                                               [--deleted]
                                               [--exists]
                                               [--ids]
                                               [--interval]
                                               [--name]
                                               [--resource-group]
                                               [--subscription]
                                               [--timeout]
                                               [--updated]
                                               [--virtualmachine-name]

示例

暂停执行下一行 CLI 脚本，直到成功创建 virtualmachine 扩展。

az azurestackhci virtualmachine extension wait --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg" --created

暂停执行下一行 CLI 脚本，直到 virtualmachine 扩展成功更新。

az azurestackhci virtualmachine extension wait --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg" --updated

暂停执行下一行 CLI 脚本，直到成功删除 virtualmachine 扩展。

az azurestackhci virtualmachine extension wait --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg" --deleted

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--interval

轮询间隔（以秒为单位）。

默认值: 30

--name

计算机扩展的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

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

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

--virtualmachine-name

包含扩展的虚拟机的名称。

全局参数

--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 获取完整的调试日志。