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

az devcenter admin devbox-definition

参考

注意

此参考是 Azure CLI（版本 2.51.0 或更高版本）的开发中心扩展的一部分。该扩展将在首次运行 az devcenter admin devbox-definition 命令时自动安装。详细了解扩展。

管理开发框定义。

命令

名称	说明	类型	状态
az devcenter admin devbox-definition create	创建开发框定义。	分机	GA
az devcenter admin devbox-definition delete	删除开发框定义。	扩展	GA
az devcenter admin devbox-definition list	列出为开发人员中心或项目配置的开发框定义。	分机	GA
az devcenter admin devbox-definition show	获取为开发人员中心或项目配置的开发框定义。	扩展	GA
az devcenter admin devbox-definition update	更新开发框定义。	分机	GA
az devcenter admin devbox-definition wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA

az devcenter admin devbox-definition create

创建开发框定义。

az devcenter admin devbox-definition create --dev-center
                                            --devbox-definition-name
                                            --image-reference
                                            --os-storage-type
                                            --resource-group
                                            --sku
                                            [--hibernate-support {Disabled, Enabled}]
                                            [--location]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--tags]

示例

创建

az devcenter admin devbox-definition create --location "eastus" --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" --os-storage-type "ssd_1024gb" --sku name="general_a_8c32gb_v1" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

必需参数

--dev-center --dev-center-name -d

开发人员中心的名称。用于 az configure -d dev-center=<dev_center_name> 配置默认值。

--devbox-definition-name --name -n

开发框定义的名称。

--image-reference

图像参考信息。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--os-storage-type

用于使用此定义创建的开发框操作系统磁盘的存储类型。

--resource-group -g

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

--sku

使用此定义创建的开发框的 SKU。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

可选参数

--hibernate-support

指示使用此定义创建的开发框是否能够休眠。并非所有图像都能够支持休眠。若要了解详细信息，请参阅 https://aka.ms/devbox/hibernate。

接受的值: Disabled, Enabled

--location -l

资源所在的地理位置。 az account list-locations 中的值。可以使用 az configure --defaults location=<location> 配置默认位置。如果未指定，将使用资源组的位置。

--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 devcenter admin devbox-definition delete

删除开发框定义。

az devcenter admin devbox-definition delete [--dev-center]
                                            [--devbox-definition-name]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--subscription]
                                            [--yes]

示例

Delete

az devcenter admin devbox-definition delete --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

可选参数

--dev-center --dev-center-name -d

开发人员中心的名称。用于 az configure -d dev-center=<dev_center_name> 配置默认值。

--devbox-definition-name --name -n

开发框定义的名称。

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

--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 devcenter admin devbox-definition list

列出为开发人员中心或项目配置的开发框定义。

az devcenter admin devbox-definition list --resource-group
                                          [--dev-center]
                                          [--max-items]
                                          [--next-token]
                                          [--project]

示例

按开发人员中心列出

az devcenter admin devbox-definition list --dev-center-name "Contoso" --resource-group "rg1"

按项目列出

az devcenter admin devbox-definition list --project-name "ContosoProject" --resource-group "rg1"

必需参数

--resource-group -g

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

可选参数

--dev-center --dev-center-name -d

开发人员中心的名称。用于 az configure -d dev-center=<dev_center_name> 配置默认值。

--max-items

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

--next-token

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

--project --project-name

项目的名称。用于 az configure -d project=<project_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 devcenter admin devbox-definition show

获取为开发人员中心或项目配置的开发框定义。

az devcenter admin devbox-definition show [--dev-center]
                                          [--devbox-definition-name]
                                          [--ids]
                                          [--project]
                                          [--resource-group]
                                          [--subscription]

示例

获取开发人员中心开发框定义

az devcenter admin devbox-definition show --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

获取项目开发框定义

az devcenter admin devbox-definition show --name "WebDevBox" --project-name "ContosoProject" --resource-group "rg1"

可选参数

--dev-center --dev-center-name -d

开发人员中心的名称。用于 az configure -d dev-center=<dev_center_name> 配置默认值。

--devbox-definition-name --name -n

开发框定义的名称。

--ids

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

--project --project-name

项目的名称。用于 az configure -d project=<project_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 devcenter admin devbox-definition update

更新开发框定义。

az devcenter admin devbox-definition update [--add]
                                            [--dev-center]
                                            [--devbox-definition-name]
                                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--hibernate-support {Disabled, Enabled}]
                                            [--ids]
                                            [--image-reference]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--os-storage-type]
                                            [--remove]
                                            [--resource-group]
                                            [--set]
                                            [--sku]
                                            [--subscription]
                                            [--tags]

示例

更新

az devcenter admin devbox-definition update --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

可选参数

--add

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

--dev-center --dev-center-name -d

开发人员中心的名称。用于 az configure -d dev-center=<dev_center_name> 配置默认值。

--devbox-definition-name --name -n

开发框定义的名称。

--force-string

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

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

--hibernate-support

预览

指示使用此定义创建的开发框是否能够休眠。并非所有图像都能够支持休眠。若要了解详细信息，请参阅 https://aka.ms/devbox/hibernate。

接受的值: Disabled, Enabled

--ids

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

--image-reference

图像参考信息。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--no-wait

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

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

--os-storage-type

用于使用此定义创建的开发框操作系统磁盘的存储类型。

--remove

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

--resource-group -g

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

--set

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

--sku

使用此定义创建的开发框的 SKU。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--subscription

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

--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 devcenter admin devbox-definition wait

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

az devcenter admin devbox-definition wait [--created]
                                          [--custom]
                                          [--deleted]
                                          [--dev-center]
                                          [--devbox-definition-name]
                                          [--exists]
                                          [--ids]
                                          [--interval]
                                          [--resource-group]
                                          [--subscription]
                                          [--timeout]
                                          [--updated]

可选参数

--created

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

默认值: False

--custom

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

--deleted

等到删除为止。

默认值: False

--dev-center --dev-center-name -d

开发人员中心的名称。用于 az configure -d dev-center=<dev_center_name> 配置默认值。

--devbox-definition-name --name -n

开发框定义的名称。

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

全局参数

--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 devcenter admin devbox-definition

命令

az devcenter admin devbox-definition create

示例

必需参数

可选参数

az devcenter admin devbox-definition delete

示例

可选参数

az devcenter admin devbox-definition list

示例

必需参数

可选参数

az devcenter admin devbox-definition show

示例

可选参数

az devcenter admin devbox-definition update

示例

可选参数

az devcenter admin devbox-definition wait

可选参数

其他资源