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

az stack-hci-vm

注意

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

使用 stack-hci-vm 管理 virtualmachine。

命令

名称	说明	类型	状态
az stack-hci-vm create	创建 VM。	扩展	GA
az stack-hci-vm delete	删除 VM。	扩展	GA
az stack-hci-vm disk	使用 stack-hci-vm 管理 virtualharddisk。	扩展	GA
az stack-hci-vm disk attach	将磁盘附加到 VM。	扩展	GA
az stack-hci-vm disk create	创建虚拟硬盘。	扩展	GA
az stack-hci-vm disk delete	删除虚拟硬盘。	扩展	GA
az stack-hci-vm disk detach	从 VM 分离磁盘。	扩展	GA
az stack-hci-vm disk list	列出所有虚拟硬盘。	扩展	GA
az stack-hci-vm disk show	获取虚拟硬盘的详细信息。	扩展	GA
az stack-hci-vm disk update	更新虚拟硬盘。	扩展	GA
az stack-hci-vm image	使用 stack-hci-vm 管理映像。	扩展	GA
az stack-hci-vm image create	创建库映像。	扩展	GA
az stack-hci-vm image delete	删除映像。	扩展	GA
az stack-hci-vm image list	列出所有库映像。	扩展	GA
az stack-hci-vm image show	获取图像的详细信息。	扩展	GA
az stack-hci-vm image update	更新映像。	扩展	GA
az stack-hci-vm list	列出所有 VM。	扩展	GA
az stack-hci-vm network	使用 stack-hvi-vm 管理网络。	扩展	GA
az stack-hci-vm network lnet	使用 stack-hci-vm 管理 logicalnetworks。	扩展	GA
az stack-hci-vm network lnet create	创建逻辑网络。	扩展	GA
az stack-hci-vm network lnet delete	删除逻辑网络。	扩展	GA
az stack-hci-vm network lnet list	列出所有逻辑网络。	扩展	GA
az stack-hci-vm network lnet show	获取逻辑网络的详细信息。	扩展	GA
az stack-hci-vm network lnet update	更新逻辑网络。	扩展	GA
az stack-hci-vm network nic	使用 stack-hci-vm 管理网络接口。	扩展	GA
az stack-hci-vm network nic create	创建网络接口。	扩展	GA
az stack-hci-vm network nic delete	删除网络接口。	扩展	GA
az stack-hci-vm network nic list	列出所有网络接口。	扩展	GA
az stack-hci-vm network nic show	获取网络接口的详细信息。	扩展	GA
az stack-hci-vm network nic update	更新网络接口。	扩展	GA
az stack-hci-vm network nsg	管理网络安全组（NSG）。	扩展	GA
az stack-hci-vm network nsg create	创建网络安全组。	扩展	GA
az stack-hci-vm network nsg delete	删除网络安全组。	扩展	GA
az stack-hci-vm network nsg list	列出网络安全组。	扩展	GA
az stack-hci-vm network nsg rule	管理网络安全组规则。	扩展	GA
az stack-hci-vm network nsg rule create	创建网络安全组规则。	扩展	GA
az stack-hci-vm network nsg rule delete	删除网络安全组规则。	扩展	GA
az stack-hci-vm network nsg rule list	列出网络安全组中的所有规则。	扩展	GA
az stack-hci-vm network nsg rule show	获取网络安全组规则的详细信息。	扩展	GA
az stack-hci-vm network nsg rule update	更新网络安全组规则。	扩展	GA
az stack-hci-vm network nsg show	获取有关网络安全组的信息。	扩展	GA
az stack-hci-vm network nsg update	更新网络安全组。	扩展	GA
az stack-hci-vm nic	使用 stack-hci-vm 管理虚拟机的 vNIC。	扩展	GA
az stack-hci-vm nic add	将现有 vNIC 添加到 VM。	扩展	GA
az stack-hci-vm nic remove	从 VM 中删除 vNIC。	扩展	GA
az stack-hci-vm pause	暂停 VM。	扩展	GA
az stack-hci-vm restart	重启 VM。	扩展	GA
az stack-hci-vm save	保存 VM。	扩展	GA
az stack-hci-vm show	获取 VM 的详细信息。	扩展	GA
az stack-hci-vm start	启动已停止的 VM。	扩展	GA
az stack-hci-vm stop	关闭（停止）正在运行的 VM。	扩展	GA
az stack-hci-vm storagepath	使用 stack-hci-vm 管理存储路径。	扩展	GA
az stack-hci-vm storagepath create	创建存储路径。	扩展	GA
az stack-hci-vm storagepath delete	删除存储路径。	扩展	GA
az stack-hci-vm storagepath list	列出所有存储路径。	扩展	GA
az stack-hci-vm storagepath show	获取存储路径的详细信息。	扩展	GA
az stack-hci-vm storagepath update	更新存储路径。	扩展	GA
az stack-hci-vm update	更新 VM。	扩展	GA

az stack-hci-vm create

创建 VM。

az stack-hci-vm create --custom-location
                       --name
                       --resource-group
                       [--admin-password]
                       [--admin-username]
                       [--attach-data-disks]
                       [--authentication-type {all, password, ssh}]
                       [--computer-name]
                       [--enable-agent {false, true}]
                       [--enable-secure-boot {false, true}]
                       [--enable-vm-config-agent {false, true}]
                       [--enable-vtpm {false, true}]
                       [--image]
                       [--location]
                       [--nics]
                       [--os-disk-name]
                       [--os-type {linux, windows}]
                       [--polling-interval]
                       [--proxy-configuration]
                       [--security-type {ConfidentialVM, TrustedLaunch}]
                       [--size]
                       [--ssh-dest-key-path]
                       [--ssh-key-values]
                       [--storage-path-id]
                       [--tags]

示例

创建 Stack HCI VM

az stack-hci-vm create --resource-group "test-rg" --custom-location "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocatio n/customLocations/dogfood-location" --location "West US2" --size "Default" --nics "test-nic" --computer-name "test-machine" --admin-username xxx --admin-password xxx --image "test-gallery-image" --storage-path-id "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storagecontainers/test-storagepath" --name "test-vm" --authentication-type all --enable-agent true --ssh-key-values @key-file

必需参数

--custom-location

扩展位置的 ID。

--name

虚拟机名称。

--resource-group -g

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

可选参数

--admin-password

如果身份验证类型为“密码”，则 VM 的密码。

--admin-username

VM 的用户名。

--attach-data-disks

将现有数据磁盘附加到 VM。 可以使用托管磁盘的名称或 ID。

--authentication-type

要用于 VM 的身份验证类型。 默认为 Windows 和适用于 Linux 的 SSH 公钥的密码。 “all”支持 ssh 和密码身份验证。

接受的值: all, password, ssh

--computer-name

计算机的名称。

--enable-agent

指示是否应在虚拟机上预配虚拟机代理。 如果未指定此属性，默认行为是将其设置为 true。 这将确保 VM 代理安装在 VM 上，以便以后可以向 VM 添加扩展。

接受的值: false, true

--enable-secure-boot

启用安全启动。

接受的值: false, true

--enable-vm-config-agent

指示是否应在虚拟机上预配虚拟机配置代理。 如果未指定此属性，默认行为是将其设置为 true。

接受的值: false, true

--enable-vtpm

启用 vtpm - 在 VM 的安全设置中启用 vTPM。 如果未提供标志，则默认值为 False。

用法：--enable-vtpm=XX。

接受的值: false, true

默认值: False

--image

映像 - VM 应用于预配的库映像名称。

--location -l

如果未指定位置，则使用资源组的位置。

--nics

要附加到 VM 的现有 NIC 的名称或 ID。

--os-disk-name

Os 磁盘 - VM 应用于预配的 vhd 的名称。

--os-type

在自定义 VHD 上安装的 OS 类型。 指定 URN 或 URN 别名时请勿使用。

接受的值: linux, windows

--polling-interval

长时间运行的操作的 ARM 轮询间隔。

--proxy-configuration

ProxyConfiguration - 描述虚拟机的代理配置。

--security-type

指定虚拟机的安全类型。

接受的值: ConfidentialVM, TrustedLaunch

--size

要创建的 VM 大小。

--ssh-dest-key-path

SSH 密钥的 VM 上的目标文件路径。

--ssh-key-values

SSH 公钥或公钥文件路径的空间分隔列表。

--storage-path-id

指向 VM 配置文件存储位置的存储路径的 Azure ID。

--tags

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

全局参数

--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 stack-hci-vm delete

删除 VM。

az stack-hci-vm delete [--ids]
                       [--name]
                       [--polling-interval]
                       [--resource-group]
                       [--subscription]
                       [--yes]

示例

DeleteVirtualMachine

az stack-hci-vm delete --resource-group "test-rg" --name "test-vm"

可选参数

--ids

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

--name

虚拟机名称。

--polling-interval

长时间运行的操作的 ARM 轮询间隔。

--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 stack-hci-vm list

列出所有 VM。

az stack-hci-vm list [--resource-group]

示例

ListVirtualMachineByResourceGroup

az stack-hci-vm list --resource-group "test-rg"

ListVirtualMachineBySubscription

az stack-hci-vm list

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<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 stack-hci-vm pause

暂停 VM。

az stack-hci-vm pause [--ids]
                      [--name]
                      [--polling-interval]
                      [--resource-group]
                      [--subscription]

示例

PauseVirtualMachine

az stack-hci-vm pause --resource-group "test-rg" --name "test-vm"

可选参数

--ids

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

--name

虚拟机名称。

--polling-interval

长时间运行的操作的 ARM 轮询间隔。

--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 stack-hci-vm restart

重启 VM。

az stack-hci-vm restart [--ids]
                        [--name]
                        [--polling-interval]
                        [--resource-group]
                        [--subscription]

示例

RestartVirtualMachine

az stack-hci-vm restart --resource-group "test-rg" --name "test-vm"

可选参数

--ids

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

--name

虚拟机名称。

--polling-interval

长时间运行的操作的 ARM 轮询间隔。

--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 stack-hci-vm save

保存 VM。

az stack-hci-vm save [--ids]
                     [--name]
                     [--polling-interval]
                     [--resource-group]
                     [--subscription]

示例

SaveVirtualMachine

az stack-hci-vm save --resource-group "test-rg" --name "test-vm"

可选参数

--ids

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

--name

虚拟机名称。

--polling-interval

长时间运行的操作的 ARM 轮询间隔。

--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 stack-hci-vm show

获取 VM 的详细信息。

az stack-hci-vm show [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

示例

GetVirtualMachine

az stack-hci-vm show --resource-group "test-rg" --name "test-vm"

可选参数

--ids

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

--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 stack-hci-vm start

启动已停止的 VM。

az stack-hci-vm start [--ids]
                      [--name]
                      [--polling-interval]
                      [--resource-group]
                      [--subscription]

示例

StartVirtualMachine

az stack-hci-vm start --resource-group "test-rg" --name "test-vm"

可选参数

--ids

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

--name

虚拟机名称。

--polling-interval

长时间运行的操作的 ARM 轮询间隔。

--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 stack-hci-vm stop

关闭（停止）正在运行的 VM。

az stack-hci-vm stop [--ids]
                     [--name]
                     [--polling-interval]
                     [--resource-group]
                     [--subscription]

示例

StopVirtualMachine

az stack-hci-vm stop --resource-group "test-rg" --name "test-vm"

可选参数

--ids

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

--name

虚拟机名称。

--polling-interval

长时间运行的操作的 ARM 轮询间隔。

--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 stack-hci-vm update

更新 VM。

az stack-hci-vm update [--add]
                       [--computer-name]
                       [--enable-agent {false, true}]
                       [--enable-vm-config-agent {false, true}]
                       [--force-string]
                       [--ids]
                       [--memory-mb]
                       [--name]
                       [--nics]
                       [--polling-interval]
                       [--remove]
                       [--resource-group]
                       [--set]
                       [--subscription]
                       [--tags]
                       [--v-cpus-available]
                       [--vhds]

示例

UpdateVirtualMachine

az stack-hci-vm update --resource-group "test-rg" --tags additionalProperties="sample" --name "test-vm" --v-cpus-available XX --memory-mb XX

可选参数

--add

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

默认值: []

--computer-name

更新 VM 的主机名。

--enable-agent

指示在虚拟机更新期间是否应在虚拟机上预配虚拟机代理。 这将确保 VM 代理安装在 VM 上，以便以后可以向 VM 添加扩展。

接受的值: false, true

--enable-vm-config-agent

指示在虚拟机更新期间是否应在虚拟机上预配虚拟机配置代理。

接受的值: false, true

--force-string

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

默认值: False

--ids

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

--memory-mb

虚拟机的 RAM（以 mb 为单位）。

--name

虚拟机名称。

--nics

vnic 名称列表。

--polling-interval

长时间运行的操作的 ARM 轮询间隔。

--remove

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

默认值: []

--resource-group -g

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

--set

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

默认值: []

--subscription

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

--tags

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

--v-cpus-available

指定可用的 vCPU 数。

--vhds

虚拟硬盘名称的列表。

全局参数

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