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

az connectedmachine extension

参考

注意

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

在已启用 Azure Arc 的服务器上管理 VM 扩展。

命令

名称	说明	类型	Status
az connectedmachine extension create	创建扩展。	扩展	GA
az connectedmachine extension delete	删除扩展。	扩展	GA
az connectedmachine extension image	管理可用于已启用 Azure Arc 的服务器的 VM 扩展元数据。	扩展	GA
az connectedmachine extension image list	根据位置、发布者、extensionType 列出所有扩展版本。	扩展	GA
az connectedmachine extension image show	基于位置、发布者、extensionType 和版本获取扩展元数据。	扩展	GA
az connectedmachine extension list	获取非 Azure 计算机的所有扩展。	扩展	GA
az connectedmachine extension show	显示非 Azure 计算机的扩展。	扩展	GA
az connectedmachine extension update	更新扩展。	扩展	GA
az connectedmachine extension wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA

az connectedmachine extension create

创建扩展。

az connectedmachine extension create --extension-name
                                     --machine-name
                                     --resource-group
                                     [--auto-upgrade-min {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--enable-auto-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--instance-view]
                                     [--location]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--settings]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

示例

用于创建扩展的示例命令

az connectedmachine extension create --name CustomScriptExtension --location eastus2euap --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

必需参数

--extension-name --name -n

计算机扩展的名称。

--machine-name

应在其中创建或更新扩展的计算机的名称。

--resource-group -g

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

可选参数

--auto-upgrade-min --auto-upgrade-minor-version

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--enable-auto-upgrade --enable-automatic-upgrade

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--force-update-tag

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

--instance-view

计算机扩展实例视图。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--location -l

未指定资源所在的地理位置，将使用资源组的位置。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--protected-settings

该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault，或者根本不包含受保护的设置。支持 json-file 和 yaml-file。

--publisher

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

--settings

扩展的 Json 格式公共设置。支持 json-file 和 yaml-file。

--tags

资源标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--type

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

--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 connectedmachine extension delete

删除扩展。

az connectedmachine extension delete [--extension-name]
                                     [--ids]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]
                                     [--yes]

示例

扩展删除的示例命令

az connectedmachine extension delete --name myName --machine-name myMachine --resource-group myResourceGroup

可选参数

--extension-name --name -n

计算机扩展的名称。

--ids

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

--machine-name

应删除扩展的计算机的名称。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--subscription

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

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

获取非 Azure 计算机的所有扩展。

az connectedmachine extension list --machine-name
                                   --resource-group
                                   [--expand]
                                   [--max-items]
                                   [--next-token]

示例

扩展列表的示例命令

az connectedmachine extension list --machine-name myMachine --resource-group myResourceGroup

必需参数

--machine-name

包含扩展的计算机的名称。

--resource-group -g

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

可选参数

--expand

要应用于操作的展开表达式。

--max-items

命令输出中要返回的项总数。如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。若要恢复分页，请在后续命令的参数中 --next-token 提供令牌值。

--next-token

用于指定开始分页的位置的令牌。这是先前截断的响应中的令牌值。

全局参数

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

显示非 Azure 计算机的扩展。

az connectedmachine extension show [--extension-name]
                                   [--ids]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]

示例

扩展显示的示例命令

az connectedmachine extension show --name CustomScriptExtension --machine-name myMachine --resource-group myResourceGroup

可选参数

--extension-name --name -n

计算机扩展的名称。

--ids

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

--machine-name

包含扩展的计算机的名称。

--resource-group -g

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

--subscription

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

全局参数

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

更新扩展。

az connectedmachine extension update [--add]
                                     [--auto-upgrade-min {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--enable-auto-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--extension-name]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--ids]
                                     [--instance-view]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--settings]
                                     [--subscription]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

示例

扩展更新的示例命令

az connectedmachine extension update --name CustomScriptExtension --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value、string 或 JSON 字符串>。

--auto-upgrade-min --auto-upgrade-minor-version

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--enable-auto-upgrade --enable-automatic-upgrade

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--extension-name --name -n

计算机扩展的名称。

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--force-update-tag

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

--ids

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

--instance-view

计算机扩展实例视图。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--machine-name

包含扩展的计算机的名称。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--protected-settings

该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault，或者根本不包含受保护的设置。支持 json-file 和 yaml-file。

--publisher

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

--remove

从列表中删除属性或元素。示例：--remove property.list OR --remove propertyToRemove。

--resource-group -g

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

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=。

--settings

扩展的 Json 格式公共设置。支持 json-file 和 yaml-file。

--subscription

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

--tags

资源标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--type

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

--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 connectedmachine extension wait

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

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

可选参数

--created

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

默认值: False

--custom

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

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--extension-name --name -n

计算机扩展的名称。

--ids

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

--interval

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

默认值: 30

--machine-name

包含扩展的计算机的名称。

--resource-group -g

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

--subscription

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

--timeout

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

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: 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 connectedmachine extension

命令

az connectedmachine extension create

示例

必需参数

可选参数

az connectedmachine extension delete

示例

可选参数

az connectedmachine extension list

示例

必需参数

可选参数

az connectedmachine extension show

示例

可选参数

az connectedmachine extension update

示例

可选参数

az connectedmachine extension wait

可选参数

其他资源