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

az networkcloud virtualmachine

注意

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

命令组“az networkcloud”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

管理虚拟机。

命令

名称	说明	类型	状态
az networkcloud virtualmachine console	管理虚拟机的控制台。	分机	预览
az networkcloud virtualmachine console create	创建新的虚拟机控制台或更新现有虚拟机控制台的属性。	扩展	预览版
az networkcloud virtualmachine console delete	删除提供的虚拟机控制台。	扩展	预览
az networkcloud virtualmachine console list	列出虚拟机的控制台。	分机	预览
az networkcloud virtualmachine console show	获取提供的虚拟机控制台的属性。	扩展	预览
az networkcloud virtualmachine console update	更新提供的虚拟机控制台的属性，或更新与虚拟机控制台关联的标记。 属性和标记更新可以独立完成。	分机	预览
az networkcloud virtualmachine console wait	将 CLI 置于等待状态，直到满足条件。	分机	预览版
az networkcloud virtualmachine create	创建新的虚拟机或更新现有虚拟机的属性。	扩展	预览版
az networkcloud virtualmachine delete	删除提供的虚拟机。	分机	预览
az networkcloud virtualmachine list	列出提供的资源组或订阅中的虚拟机。	分机	预览版
az networkcloud virtualmachine power-off	关闭提供的虚拟机。	分机	预览版
az networkcloud virtualmachine reimage	重置提供的虚拟机的映像。	扩展	预览
az networkcloud virtualmachine restart	重启提供的虚拟机。	扩展	预览版
az networkcloud virtualmachine show	获取提供的虚拟机的属性。	扩展	预览版
az networkcloud virtualmachine start	启动提供的虚拟机。	分机	预览
az networkcloud virtualmachine update	更新提供的虚拟机的属性，或更新与虚拟机关联的标记。 属性和标记更新可以独立完成。	分机	预览
az networkcloud virtualmachine wait	将 CLI 置于等待状态，直到满足条件。	扩展	预览

az networkcloud virtualmachine create

预览

命令组“az networkcloud”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

创建新的虚拟机或更新现有虚拟机的属性。

az networkcloud virtualmachine create --admin-username
                                      --cloud-services-network-attachment
                                      --cpu-cores
                                      --extended-location
                                      --memory-size
                                      --name
                                      --resource-group
                                      --storage-profile
                                      --vm-image
                                      [--boot-method {BIOS, UEFI}]
                                      [--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--location]
                                      [--na]
                                      [--nd]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--ph]
                                      [--ssh-dest-key-path]
                                      [--ssh-key-values]
                                      [--tags]
                                      [--ud]
                                      [--vm-device-model {T1, T2}]
                                      [--vm-image-repository-credentials]

示例

创建虚拟机

az networkcloud virtualmachine create --resource-group "resourceGroupName" --name "virtualMachineName" --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" type="CustomLocation" --location "location" --admin-username "admin" --boot-method "UEFI" --cloud-services-network-attachment attached-network-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/CloudServicesNetworks/cloudServicesNetworkName" --cpu-cores 2 --memory-size 8 --network-attachments "[{attachedNetworkId:'/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName',defaultGateway:'True',ipAllocationMethod:'Dynamic',ipv4Address:'198.51.100.1',ipv6Address:'2001:0db8:0000:0000:0000:0000:0000:0000',networkAttachmentName:'networkAttachmentName'}]" --network-data "bmV0d29ya0RhdGVTYW1wbGU=" --placement-hints "[{hintType:'Affinity',resourceId:'/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName',schedulingExecution:'Hard,scope:''}]" --ssh-key-values "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT= admin@vm" --storage-profile disk-size=120 create-option="Ephemeral" delete-option="Delete" --tags key1="myvalues1" --tags key2="myvalues2" --user-data "dXNlckRhdGVTYW1wbGU=" --vm-device-model "T2" --vm-image "myacr.azurecr.io/ubuntu-pw:20.04" --vm-image-repository-credentials password="password" registry-url="myacr.azurecr.io" username="username"

必需参数

--admin-username

将 SSH 公钥添加到授权密钥的管理员的名称。

--cloud-services-network-attachment --csn

为虚拟机提供平台级服务的云服务网络。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--cpu-cores

虚拟机中的 CPU 核心数。

--extended-location

与资源关联的群集的扩展位置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--memory-size --memory-size-gb

虚拟机的内存大小（以 GB 为单位）。

--name --virtual-machine-name -n

虚拟机的名称。

--resource-group -g

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

--storage-profile

指定与虚拟机相关的磁盘的大小和其他参数的存储配置文件。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--vm-image

当前预配到 OS 磁盘的虚拟机映像，使用用于拉取映像的完整 URL 和标记表示法。

可选参数

--boot-method

选择虚拟机的启动方法。

接受的值: BIOS, UEFI

默认值: UEFI

--generate-ssh-keys

生成 SSH 公钥和私钥文件（如果缺少）。 密钥将存储在“~/.ssh”下。

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

--location -l

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

--na --network-attachments

虚拟机的网络附件列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--nd --network-data

Base64 编码的 cloud-init 网络数据。

--no-wait

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

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

--ph --placement-hints

虚拟机的计划提示。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--ssh-dest-key-path

ssh 公钥的空间分隔路径列表。 可以提供文件路径或目录。 如果提供了目录，将尝试加载找到的所有公钥（.pub）。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--ssh-key-values

空格分隔的 SSH 公钥列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--tags

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

--ud --user-data

Base64 编码的 cloud-init 用户数据。

--vm-device-model

要使用的设备模型的类型。

接受的值: T1, T2

默认值: T2

--vm-image-repository-credentials --vmi-creds

用于登录到有权访问指定映像的映像存储库的凭据。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

全局参数

--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 networkcloud virtualmachine delete

预览

命令组“az networkcloud”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

删除提供的虚拟机。

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

示例

删除虚拟机

az networkcloud virtualmachine delete --resource-group "resourceGroupName" --name "virtualMachineName"

可选参数

--ids

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

--name --virtual-machine-name -n

虚拟机的名称。

--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 networkcloud virtualmachine list

预览

命令组“az networkcloud”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

列出提供的资源组或订阅中的虚拟机。

az networkcloud virtualmachine list [--max-items]
                                    [--next-token]
                                    [--resource-group]

示例

列出资源组的虚拟机

az networkcloud virtualmachine list --resource-group "resourceGroupName"

列出订阅的虚拟机

az networkcloud virtualmachine list

可选参数

--max-items

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

--next-token

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

--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 networkcloud virtualmachine power-off

预览

命令组“az networkcloud”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

关闭提供的虚拟机。

az networkcloud virtualmachine power-off [--ids]
                                         [--name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--skip-shutdown {False, True}]
                                         [--subscription]

示例

关闭虚拟机

az networkcloud virtualmachine power-off --resource-group "resourceGroupName" --name "virtualMachineName" --skip-shutdown "True"

可选参数

--ids

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

--name --virtual-machine-name -n

虚拟机的名称。

--no-wait

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

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

--resource-group -g

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

--skip-shutdown

指示是否立即跳过正常 OS 关闭并关闭虚拟机。

接受的值: False, True

默认值: False

--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 networkcloud virtualmachine reimage

预览

命令组“az networkcloud”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

重置提供的虚拟机的映像。

az networkcloud virtualmachine reimage [--ids]
                                       [--name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]

示例

重置虚拟机映像

az networkcloud virtualmachine reimage --resource-group "resourceGroupName" --name "virtualMachineName"

可选参数

--ids

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

--name --virtual-machine-name -n

虚拟机的名称。

--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 配置默认订阅。

全局参数

--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 networkcloud virtualmachine restart

预览

命令组“az networkcloud”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

重启提供的虚拟机。

az networkcloud virtualmachine restart [--ids]
                                       [--name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]

示例

重启虚拟机

az networkcloud virtualmachine restart --resource-group "resourceGroupName" --name "virtualMachineName"

可选参数

--ids

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

--name --virtual-machine-name -n

虚拟机的名称。

--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 配置默认订阅。

全局参数

--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 networkcloud virtualmachine show

预览

命令组“az networkcloud”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

获取提供的虚拟机的属性。

az networkcloud virtualmachine show [--ids]
                                    [--name]
                                    [--resource-group]
                                    [--subscription]

示例

获取虚拟机

az networkcloud virtualmachine show --resource-group "resourceGroupName" --name "virtualMachineName"

可选参数

--ids

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

--name --virtual-machine-name -n

虚拟机的名称。

--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 networkcloud virtualmachine start

预览

命令组“az networkcloud”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

启动提供的虚拟机。

az networkcloud virtualmachine start [--ids]
                                     [--name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]

示例

启动虚拟机

az networkcloud virtualmachine start --resource-group "resourceGroupName" --name "virtualMachineName"

可选参数

--ids

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

--name --virtual-machine-name -n

虚拟机的名称。

--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 配置默认订阅。

全局参数

--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 networkcloud virtualmachine update

预览

命令组“az networkcloud”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

更新提供的虚拟机的属性，或更新与虚拟机关联的标记。 属性和标记更新可以独立完成。

az networkcloud virtualmachine update [--ids]
                                      [--name]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--subscription]
                                      [--tags]
                                      [--vm-image-repository-credentials]

示例

修补虚拟机

az networkcloud virtualmachine update --resource-group "resourceGroupName" --name "virtualMachineName" --vm-image-repository-credentials password="password" registry-url="myacr.azurecr.io" username="myuser" --tags key1="myvalue1" key2="myvalue2"

可选参数

--ids

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

--name --virtual-machine-name -n

虚拟机的名称。

--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 配置默认订阅。

--tags

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

--vm-image-repository-credentials --vmi-creds

用于登录到有权访问指定映像的映像存储库的凭据。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

全局参数

--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 networkcloud virtualmachine wait

预览

命令组“az networkcloud”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

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

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

可选参数

--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 --virtual-machine-name -n

虚拟机的名称。

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