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

az devcenter admin pool

注意

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

管理池。

命令

名称	说明	类型	状态
az devcenter admin pool create	创建池。	分机	GA
az devcenter admin pool delete	删除池。	扩展	GA
az devcenter admin pool list	列出项目的池。	扩展	GA
az devcenter admin pool run-health-check	触发池状态的刷新。	分机	GA
az devcenter admin pool show	获取池。	扩展	GA
az devcenter admin pool update	更新池。	分机	GA
az devcenter admin pool wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA

az devcenter admin pool create

创建池。

az devcenter admin pool create --devbox-definition-name
                               --local-administrator {Disabled, Enabled}
                               --name
                               --project
                               --resource-group
                               [--display-name]
                               [--location]
                               [--managed-virtual-network-regions]
                               [--network-connection-name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--single-sign-on-status {Disabled, Enabled}]
                               [--tags]
                               [--virtual-network-type {Managed, Unmanaged}]

示例

创建

az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled"

必需参数

--devbox-definition-name -d

此池的父项目中开发框定义的名称。

--local-administrator

指示此池中的开发框所有者是否作为开发框中的本地管理员添加。

接受的值: Disabled, Enabled

--name --pool-name -n

池的名称。

--project --project-name

项目的名称。 用于 az configure -d project=<project_name> 配置默认值。

--resource-group -g

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

可选参数

--display-name

池的显示名称。

--location -l

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

--managed-virtual-network-regions -m

托管虚拟网络的区域（托管NetworkType 托管时需要）。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--network-connection-name -c

此池的父项目中网络连接的名称。

--no-wait

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

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

--single-sign-on-status

指示是否使用此池中的 Dev Boxes 启用了单一登录。 还需要在租户上启用单一登录。

接受的值: Disabled, Enabled

--tags

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

--virtual-network-type

指示池是使用 Microsoft 管理的虚拟网络还是客户提供的网络。

接受的值: Managed, Unmanaged

全局参数

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

删除池。

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

示例

删除

az devcenter admin pool delete --name "DevPool" --project-name "DevProject" --resource-group "rg1"

可选参数

--ids

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

--name --pool-name -n

池的名称。

--no-wait

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

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

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

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

列出项目的池。

az devcenter admin pool list --project
                             --resource-group
                             [--max-items]
                             [--next-token]

示例

列表

az devcenter admin pool list --project-name "DevProject" --resource-group "rg1"

必需参数

--project --project-name

项目的名称。 用于 az configure -d project=<project_name> 配置默认值。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<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 devcenter admin pool run-health-check

触发池状态的刷新。

az devcenter admin pool run-health-check [--ids]
                                         [--name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--project]
                                         [--resource-group]
                                         [--subscription]

示例

运行运行状况检查

az devcenter admin pool run-health-check --name "DevPool" --project-name "DevProject" --resource-group "rg1"

可选参数

--ids

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

--name --pool-name -n

池的名称。

--no-wait

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

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

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

获取池。

az devcenter admin pool show [--ids]
                             [--name]
                             [--project]
                             [--resource-group]
                             [--subscription]

示例

获取

az admin pool show --name "DevPool" --project-name "DevProject" --resource-group "rg1"

可选参数

--ids

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

--name --pool-name -n

池的名称。

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

更新池。

az devcenter admin pool update [--add]
                               [--devbox-definition-name]
                               [--display-name]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--ids]
                               [--local-administrator {Disabled, Enabled}]
                               [--managed-virtual-network-regions]
                               [--name]
                               [--network-connection-name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--project]
                               [--remove]
                               [--resource-group]
                               [--set]
                               [--single-sign-on-status {Disabled, Enabled}]
                               [--subscription]
                               [--tags]
                               [--virtual-network-type {Managed, Unmanaged}]

示例

更新

az devcenter admin pool update --devbox-definition-name "WebDevBox2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1"

可选参数

--add

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

--devbox-definition-name -d

此池的父项目中开发框定义的名称。

--display-name

池的显示名称。

--force-string

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

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

--ids

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

--local-administrator

指示此池中的开发框所有者是否作为开发框中的本地管理员添加。

接受的值: Disabled, Enabled

--managed-virtual-network-regions -m

托管虚拟网络的区域（托管NetworkType 托管时需要）。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--name --pool-name -n

池的名称。

--network-connection-name -c

此池的父项目中网络连接的名称。

--no-wait

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

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

--project --project-name

项目的名称。 用于 az configure -d project=<project_name> 配置默认值。

--remove

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

--resource-group -g

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

--set

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

--single-sign-on-status

指示是否使用此池中的 Dev Boxes 启用了单一登录。 还需要在租户上启用单一登录。

接受的值: Disabled, Enabled

--subscription

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

--tags

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

--virtual-network-type

指示池是使用 Microsoft 管理的虚拟网络还是客户提供的网络。

接受的值: Managed, Unmanaged

全局参数

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

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

az devcenter admin pool wait [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--name]
                             [--project]
                             [--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 --pool-name -n

池的名称。

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

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