你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az vm extension
管理 VM 上的扩展。
扩展是小型应用程序,用于在 Azure 虚拟机上提供部署后配置和自动化任务。 例如,如果虚拟机要求安装软件、防病毒保护或 Docker 配置,便可以使用 VM 扩展来完成这些任务。 扩展可与新虚拟机部署捆绑在一起,也可以针对任何现有系统运行。
命令
名称 | 说明 | 类型 | Status |
---|---|---|---|
az vm extension delete |
用于删除扩展的删除操作。 |
核心 | GA |
az vm extension image |
查找订阅和区域的可用 VM 扩展。 |
核心 | GA |
az vm extension image list |
列出有关可用扩展的信息。 |
核心 | GA |
az vm extension image list-names |
列出可用扩展的名称。 |
核心 | GA |
az vm extension image list-versions |
列出可用扩展的版本。 |
核心 | GA |
az vm extension image show |
显示扩展的信息。 |
核心 | GA |
az vm extension list |
列出附加到 VM 的扩展。 |
核心 | GA |
az vm extension set |
设置 VM 的扩展。 |
核心 | GA |
az vm extension show |
显示有关附加到 VM 的扩展的信息。 |
核心 | GA |
az vm extension wait |
将 CLI 置于等待状态,直到满足虚拟机扩展的条件。 |
核心 | GA |
az vm extension delete
用于删除扩展的删除操作。
az vm extension delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--vm-name]
示例
使用 VM 名称和扩展从 VM 中删除扩展。
az vm extension delete -g MyResourceGroup --vm-name MyVm -n MyExtensionName
从 VM 中删除包含字符串“MyExtension”的 ID 的扩展。
az vm extension delete --ids $(az resource list --query "[?contains(name, 'MyExtension')].id" -o tsv)
可选参数
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
虚拟机扩展的名称。
不等待长时间运行的操作完成。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
虚拟机的名称。 可以使用 < a0/a0> 配置默认值 az configure --defaults vm=<name>
。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az vm extension list
列出附加到 VM 的扩展。
az vm extension list [--ids]
[--resource-group]
[--subscription]
[--vm-name]
示例
列出命名 VM 的附加扩展。
az vm extension list -g MyResourceGroup --vm-name MyVm
可选参数
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
虚拟机的名称。 可以使用 < a0/a0> 配置默认值 az configure --defaults vm=<name>
。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az vm extension set
设置 VM 的扩展。
从 az vm extension image list
中获取扩展详细信息。
az vm extension set --name
--publisher
[--enable-auto-upgrade {false, true}]
[--extension-instance-name]
[--force-update]
[--ids]
[--no-auto-upgrade {false, true}]
[--no-auto-upgrade-minor-version {false, true}]
[--no-wait]
[--protected-settings]
[--resource-group]
[--settings]
[--subscription]
[--version]
[--vm-name]
示例
将用户帐户添加到 Linux VM。
az vm extension set -n VMAccessForLinux --publisher Microsoft.OSTCExtensions --version 1.4 \
--vm-name MyVm --resource-group MyResourceGroup \
--protected-settings '{"username":"user1", "ssh_key":"ssh_rsa ..."}'
将 customScript 扩展添加到由 --ids 指定的 VM(s)。
az vm extension set -n customScript --publisher Microsoft.Azure.Extensions --ids {vm_id}
添加扩展并启用平台的自动升级(如果有较新版本的扩展可用)。
az vm extension set -n extName --publisher publisher --vm-name MyVM -g MyResourceGroup \
--enable-auto-upgrade true
必需参数
扩展名。
扩展发布者的名称。
可选参数
指示如果有较新版本的扩展可用,平台应自动升级扩展。
可以自定义的扩展实例的名称。 默认值:扩展的名称。
即使扩展配置未更改,也强制更新。
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
选项“--no-auto-upgrade”已弃用,将在将来的版本中删除。 请改用“--no-auto-upgrade-minor-version”。
如果设置,即使重新部署扩展,扩展服务也不会自动选取或升级到最新的次要版本。
如果设置,即使重新部署扩展,扩展服务也不会自动选取或升级到最新的次要版本。
不等待长时间运行的操作完成。
用于敏感信息(如凭据)的 JSON 格式保护设置。 也接受 JSON 文件路径。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
JSON 格式的扩展设置。 也接受 JSON 文件路径。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
扩展的版本。 若要将扩展版本固定到此值,请指定 --no-auto-upgrade-minor-version。
虚拟机的名称。 可以使用 < a0/a0> 配置默认值 az configure --defaults vm=<name>
。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az vm extension show
显示有关附加到 VM 的扩展的信息。
az vm extension show [--ids]
[--instance-view]
[--name]
[--resource-group]
[--subscription]
[--vm-name]
示例
使用 VM 名称和扩展名称显示附加到 VM 的扩展。
az vm extension show -g MyResourceGroup --vm-name MyVm -n extension_name
可选参数
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
虚拟机扩展的实例视图。
扩展名。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
虚拟机的名称。 可以使用 < a0/a0> 配置默认值 az configure --defaults vm=<name>
。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az vm extension wait
将 CLI 置于等待状态,直到满足虚拟机扩展的条件。
az vm extension wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
[--vm-name]
示例
将 CLI 置于等待状态,直到满足虚拟机扩展的条件。 (自动生成)
az vm extension wait --created --name MyExtension --resource-group MyResourceGroup --vm-name MyVm
将 CLI 置于等待状态,直到满足虚拟机扩展的条件。 (自动生成)
az vm extension wait --exists --name MyExtension --resource-group MyResourceGroup --vm-name MyVm
将 CLI 置于等待状态,直到满足虚拟机扩展的条件。 (自动生成)
az vm extension wait --ids @- --name MyExtension --subscription MySubscription --updated --vm-name MyVm
可选参数
等待在“Succeeded”中使用“provisioningState”创建。
等待条件满足自定义 JMESPath 查询。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
等到删除为止。
等待资源存在。
一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
轮询间隔(以秒为单位)。
扩展名。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
最大等待(以秒为单位)。
等到 provisioningState 更新为“Succeeded”。
虚拟机的名称。 可以使用 < a0/a0> 配置默认值 az configure --defaults vm=<name>
。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。