通过

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

az lab vm

  • 预览

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

管理 Azure 开发测试实验室中的 VM。

命令

名称 说明 类型 Status
az lab vm apply-artifacts

将项目应用于虚拟机。 此作可能需要一段时间才能完成。

 Core Preview
az lab vm claim

用于在 Azure 开发测试实验室中声明 VM 的命令。

 Core Preview
az lab vm create

在实验室中创建 VM。

 Core Preview
az lab vm delete

删除虚拟机。 此作可能需要一段时间才能完成。

 Core Preview
az lab vm hibernate

休眠虚拟机此作可能需要一段时间才能完成。

 Core Preview
az lab vm list

列出给定实验室中的虚拟机。

 Core Preview
az lab vm show

显示虚拟机。

 Core Preview
az lab vm start

启动虚拟机。 此作可能需要一段时间才能完成。

 Core Preview
az lab vm stop

停止虚拟机此作可能需要一段时间才能完成。

 Core Preview
az lab vm wait

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

 Core Preview

az lab vm apply-artifacts

编辑
预览

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

将项目应用于虚拟机。 此作可能需要一段时间才能完成。

az lab vm apply-artifacts --lab-name
                          --name
                          --resource-group
                          [--artifacts]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

示例

将项目应用于 Azure 开发测试实验室中的虚拟机。

az lab vm apply-artifacts --artifacts artifacts.json --lab-name MyLab --name MyVirtualMachine --resource-group MyResourceGroup

必需参数

--lab-name

实验室的名称。

--name -n

虚拟机的名称。

--resource-group -g

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--artifacts

要应用的项目的 JSON 编码数组的路径。 JSON 编码的参数列表。

--no-wait

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

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

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az lab vm claim

编辑
预览

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

用于在 Azure 开发测试实验室中声明 VM 的命令。

az lab vm claim [--ids]
                [--lab-name]
                [--name]
                [--resource-group]
                [--subscription]

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--ids

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

属性 值
参数组: Resource Id Arguments
--lab-name

实验室的名称。

属性 值
参数组: Resource Id Arguments
--name -n

要声明的虚拟机的名称。

属性 值
参数组: Resource Id Arguments
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az lab vm create

编辑
预览

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

在实验室中创建 VM。

az lab vm create --lab-name
                 --name
                 --resource-group
                 [--admin-password]
                 [--admin-username]
                 [--allow-claim {0, 1, f, false, n, no, t, true, y, yes}]
                 [--artifacts]
                 [--authentication-type {password, ssh}]
                 [--disk-type {Premium, Standard, StandardSSD}]
                 [--expiration-date]
                 [--formula]
                 [--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
                 [--image]
                 [--image-type {custom, gallery}]
                 [--ip-configuration {private, public, shared}]
                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                 [--notes]
                 [--saved-secret]
                 [--size]
                 [--ssh-key]
                 [--subnet]
                 [--tags]
                 [--vnet-name]

必需参数

--lab-name

实验室的名称。

--name -n

虚拟机或环境的名称。

--resource-group -g

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--admin-password

VM 管理员的密码。

属性 值
参数组: Authentication Arguments
--admin-username

VM 管理员的用户名。

属性 值
参数组: Authentication Arguments
默认值: your_system_user_login_name
--allow-claim

指示是否应将 VM 创建为可认领的标志。

属性 值
默认值: False
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--artifacts

要应用的项目的 JSON 编码数组的路径。 JSON 编码的参数列表。

--authentication-type

VM 允许的身份验证类型。

属性 值
参数组: Authentication Arguments
默认值: password
接受的值: password, ssh
--disk-type

要用于虚拟机的存储类型。

属性 值
接受的值: Premium, Standard, StandardSSD
--expiration-date

VM 的到期日期。

--formula

公式的名称。 对可用公式使用 az lab formula list。 将 az lab formula 与 --export-artifacts 标志配合使用来导出和更新项目，然后通过 --artifacts 参数传递结果。

--generate-ssh-keys

生成 SSH 公钥和私钥文件（如果缺少）。

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

作系统映像的名称（库映像名称或自定义映像名称/ID）。 对可用的库映像使用 az lab gallery-image list，或将 az lab custom-image list 用于可用的自定义映像。

--image-type

图像的类型。

属性 值
接受的值: custom, gallery
--ip-configuration

要用于 VM 的 IP 配置类型。

属性 值
参数组: Network Arguments
接受的值: private, public, shared
--no-wait

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

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

虚拟机的说明。

--saved-secret

要用于身份验证的已保存机密的名称。 提供此值后，它将用于代替其他身份验证方法。

属性 值
参数组: Authentication Arguments
--size

要创建的 VM 的大小。 请参阅 https://azure.microsoft.com/pricing/details/virtual-machines/ 了解大小信息。

--ssh-key

SSH 公钥或公钥文件路径。 使用 --generate-ssh-keys 生成 SSH 密钥。

属性 值
参数组: Authentication Arguments
--subnet

要向其添加 VM 的子网的名称。

属性 值
参数组: Network Arguments
--tags

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

--vnet-name

要向其添加 VM 的虚拟网络的名称。

属性 值
参数组: Network Arguments
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

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

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az lab vm delete

编辑
预览

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

删除虚拟机。 此作可能需要一段时间才能完成。

az lab vm delete --lab-name
                 --name
                 --resource-group
                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                 [--yes]

必需参数

--lab-name

实验室的名称。

--name

虚拟机的名称。

--resource-group -g

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--no-wait

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

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

不要提示确认。

属性 值
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

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

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az lab vm hibernate

编辑
预览

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

休眠虚拟机此作可能需要一段时间才能完成。

az lab vm hibernate --lab-name
                    --name
                    --resource-group
                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

示例

休眠虚拟机。

az lab vm hibernate --resource-group MyResourceGroup --lab-name MyLab --name MyVM

必需参数

--lab-name

实验室的名称。

--name

虚拟机的名称。

--resource-group -g

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--no-wait

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

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

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az lab vm list

编辑
预览

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

列出给定实验室中的虚拟机。

az lab vm list --lab-name
               --resource-group
               [--all {0, 1, f, false, n, no, t, true, y, yes}]
               [--claimable {0, 1, f, false, n, no, t, true, y, yes}]
               [--environment]
               [--expand]
               [--filters]
               [--max-items]
               [--next-token]
               [--object-id]
               [--order-by]
               [--top]

示例

列出 Azure 开发测试实验室中的 VM。

az lab vm list --lab-name MyLab --resource-group MyResourceGroup

必需参数

--lab-name

实验室的名称。

--resource-group -g

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--all

列出实验室中的所有虚拟机。 不能与 --filters一起使用。

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

仅列出实验室中可认领的虚拟机。 不能与 --filters一起使用。

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

要在其中列出虚拟机的环境的名称或 ID。 不能与 --filters一起使用。

属性 值
参数组: Filter Arguments
--expand

指定$expand查询。 示例：“properties（$expand=artifacts，computeVm，networkInterface，applicableSchedule）””。

--filters

要应用于作的筛选器。 示例：“$filter=contains（name，'myName'）。

属性 值
参数组: Filter Arguments
--max-items

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

属性 值
参数组: Pagination Arguments
--next-token

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

属性 值
参数组: Pagination Arguments
--object-id

要列出其 VM 的所有者的对象 ID。

--order-by

结果的排序表达式，使用 OData 表示法。 示例：“$orderby=name desc”。

--top

要从作返回的最大资源数。 示例：“$top=10”。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

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

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az lab vm show

编辑
预览

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

显示虚拟机。

az lab vm show --lab-name
               --name
               --resource-group
               [--expand]

必需参数

--lab-name

实验室的名称。

--name

虚拟机的名称。

--resource-group -g

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--expand

指定$expand查询。 示例：“properties（$expand=artifacts，computeVm，networkInterface，applicableSchedule）””。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

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

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az lab vm start

编辑
预览

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

启动虚拟机。 此作可能需要一段时间才能完成。

az lab vm start --lab-name
                --name
                --resource-group
                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

必需参数

--lab-name

实验室的名称。

--name

虚拟机的名称。

--resource-group -g

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--no-wait

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

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

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az lab vm stop

编辑
预览

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

停止虚拟机此作可能需要一段时间才能完成。

az lab vm stop --lab-name
               --name
               --resource-group
               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

必需参数

--lab-name

实验室的名称。

--name

虚拟机的名称。

--resource-group -g

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--no-wait

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

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

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az lab vm wait

编辑
预览

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

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

az lab vm wait [--created]
               [--custom]
               [--deleted]
               [--exists]
               [--expand]
               [--ids]
               [--interval]
               [--lab-name]
               [--name]
               [--resource-group]
               [--subscription]
               [--timeout]
               [--updated]

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--created

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

属性 值
参数组: Wait Condition Arguments
默认值: False
--custom

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

属性 值
参数组: Wait Condition Arguments
--deleted

等到删除为止。

属性 值
参数组: Wait Condition Arguments
默认值: False
--exists

等待资源存在。

属性 值
参数组: Wait Condition Arguments
默认值: False
--expand

指定$expand查询。 示例：“properties（$expand=artifacts，computeVm，networkInterface，applicableSchedule）””。

--ids

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

属性 值
参数组: Resource Id Arguments
--interval

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

属性 值
参数组: Wait Condition Arguments
默认值: 30
--lab-name

实验室的名称。

属性 值
参数组: Resource Id Arguments
--name

虚拟机的名称。

属性 值
参数组: Resource Id Arguments
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
--timeout

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

属性 值
参数组: Wait Condition Arguments
默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

属性 值
参数组: Wait Condition Arguments
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False