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

az networkcloud virtualmachine console

预览
参考

注意

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

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

管理虚拟机的控制台。

命令

名称	说明	类型	状态
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 console create

预览

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

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

每个虚拟机都允许使用单个控制台，并且始终命名为“default”。

az networkcloud virtualmachine console create --enabled {False, True}
                                              --extended-location
                                              --resource-group
                                              --ssh-public-key
                                              --virtual-machine-name
                                              [--expiration]
                                              [--location]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--tags]

示例

创建或更新虚拟机控制台

az networkcloud virtualmachine console create --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" type="CustomLocation" --location "location" --enabled "True" --expiration "2024-06-01T01:27:03.008Z" --ssh-public-key key-data="ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"

使用 SSH 密钥文件创建或更新虚拟机控制台

az networkcloud virtualmachine console create --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" type="CustomLocation" --location "location" --enabled "True" --expiration "2024-06-01T01:27:03.008Z" --ssh-public-key key-data=~/.ssh/id_rsa.pub --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"

必需参数

--enabled

是否启用控制台访问的指示器。

接受的值: False, True

--extended-location

创建此虚拟机时创建的群集管理器与群集关联的群集管理器的扩展位置。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--resource-group -g

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

--ssh-public-key

将为用户访问预配的 SSH 公钥。用户应具有相应的 SSH 私钥进行登录。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--virtual-machine-name

虚拟机的名称。

可选参数

--expiration

不允许访问密钥的日期和时间。

--location -l

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

--no-wait

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

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

--tags

资源标记。支持速记语法、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 console delete

预览

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

删除提供的虚拟机控制台。

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

示例

删除虚拟机控制台

az networkcloud virtualmachine console delete --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"

可选参数

--ids

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

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

--virtual-machine-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 networkcloud virtualmachine console list

预览

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

列出虚拟机的控制台。

az networkcloud virtualmachine console list --resource-group
                                            --virtual-machine-name
                                            [--max-items]
                                            [--next-token]

示例

列出虚拟机的控制台

az networkcloud virtualmachine console list --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"

必需参数

--resource-group -g

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

--virtual-machine-name

虚拟机的名称。

可选参数

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

预览

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

获取提供的虚拟机控制台的属性。

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

示例

获取虚拟机控制台

az networkcloud virtualmachine console show --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"

可选参数

--ids

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

--resource-group -g

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

--subscription

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

--virtual-machine-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 console update

预览

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

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

az networkcloud virtualmachine console update [--enabled {False, True}]
                                              [--expiration]
                                              [--ids]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--resource-group]
                                              [--ssh-public-key]
                                              [--subscription]
                                              [--tags]
                                              [--virtual-machine-name]

示例

修补虚拟机控制台

az networkcloud virtualmachine console update --enabled "True" --expiration "2022-06-01T01:27:03.008Z" --ssh-public-key key-data="ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"

使用 SSH 密钥文件修补虚拟机控制台

az networkcloud virtualmachine console update --enabled "True" --expiration "2022-06-01T01:27:03.008Z" --ssh-public-key key-data=~/.ssh/id_rsa.pub --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"

可选参数

--enabled

是否启用控制台访问的指示器。

接受的值: False, True

--expiration

不允许访问密钥的日期和时间。

--ids

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

--no-wait

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

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

--resource-group -g

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

--ssh-public-key

将为用户访问预配的 SSH 公钥。用户应具有相应的 SSH 私钥进行登录。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--subscription

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

--tags

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

--virtual-machine-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 console wait

预览

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

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

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

可选参数

--console-name --name -n

虚拟机控制台的名称。

--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

--resource-group -g

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

--subscription

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

--timeout

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

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

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

可选参数

其他资源