通过

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

az devcenter admin project

Note

This reference is part of the devcenter extension for the Azure CLI (version 2.67.0 or higher). 该扩展将在首次运行 az devcenter admin project 命令时自动安装。 Learn more about extensions.

Manage projects.

命令

名称 说明 类型 Status
az devcenter admin project create

创建项目。

 Extension GA
az devcenter admin project delete

删除项目。

 Extension GA
az devcenter admin project get-inherited-setting

获取此项目的适用继承设置。

 Extension GA
az devcenter admin project list

List projects.

 Extension GA
az devcenter admin project show

获取项目。

 Extension GA
az devcenter admin project update

更新项目。

 Extension GA
az devcenter admin project wait

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

 Extension GA

az devcenter admin project create

创建项目。

az devcenter admin project create --dev-center-id
                                  --name
                                  --resource-group
                                  [--azure-ai-services-settings]
                                  [--catalog-item-sync-types]
                                  [--customization-settings]
                                  [--description]
                                  [--dev-box-auto-delete-settings]
                                  [--display-name]
                                  [--identity-type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
                                  [--___location]
                                  [--max-dev-boxes-per-user]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--serverless-gpu-sessions-settings]
                                  [--tags]
                                  [--user-assigned-identities]
                                  [--workspace-storage-settings]

示例

Create

az devcenter admin project create --___location "eastus" --description "This is my first project." --dev-center-id "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso" --tags CostCenter="R&D" --name "DevProject" --resource-group "rg1" --max-dev-boxes-per-user "3"

必需参数

--dev-center-id

关联的开发人员中心的资源 ID。

属性 值
Parameter group: Properties Arguments
--name -n

项目的名称。

--resource-group -g

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--azure-ai-services-settings -a

指示是否为项目启用了 Azure AI 服务。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
--catalog-item-sync-types -c

指示可以同步的目录项类型。 允许的值为“EnvironmentDefinition”和“ImageDefinition”。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: CatalogSettings Arguments
--customization-settings

用于自定义的设置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
--description

项目的说明。

属性 值
Parameter group: Properties Arguments
--dev-box-auto-delete-settings -d

Dev Box 自动删除设置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
--display-name

项目的显示名称。

属性 值
Parameter group: Properties Arguments
--identity-type

托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。

属性 值
Parameter group: Identity Arguments
接受的值: None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned
--___location -l

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

属性 值
Parameter group: Body Arguments
--max-dev-boxes-per-user

指定后，限制单个用户可以在项目中的所有池中创建的最大开发框数。 减少时，这不会影响现有开发框。

属性 值
Parameter group: Properties Arguments
--no-wait

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--serverless-gpu-sessions-settings -s

用于无服务器 GPU 的设置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
--tags

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

属性 值
Parameter group: Body Arguments
--user-assigned-identities -u

与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象（{}）。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Identity Arguments
--workspace-storage-settings -w

用于工作区存储的设置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
全局参数
--debug

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

Output format.

属性 值
默认值: 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 devcenter admin project delete

删除项目。

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

示例

Delete

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

属性 值
Parameter group: Resource Id Arguments
--name -n

项目的名称。

属性 值
Parameter group: Resource Id Arguments
--no-wait

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

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

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

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
--yes -y

不要提示确认。

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

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

Output format.

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

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

--verbose

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

属性 值
默认值: False

az devcenter admin project get-inherited-setting

获取此项目的适用继承设置。

az devcenter admin project get-inherited-setting [--ids]
                                                 [--name]
                                                 [--resource-group]
                                                 [--subscription]

示例

获取继承的设置

az devcenter admin project get-inherited-setting --name "DevProject" --resource-group "rg1"

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

属性 值
Parameter group: Resource Id Arguments
--name -n

项目的名称。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

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

属性 值
Parameter group: Resource Id Arguments
--subscription

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

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

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

Output format.

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

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

--verbose

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

属性 值
默认值: False

az devcenter admin project list

List projects.

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

示例

按资源组列出

az devcenter admin project list --resource-group "rg1"

按订阅列出

az devcenter admin project list

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

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

属性 值
Parameter group: Pagination Arguments
--next-token

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

属性 值
Parameter group: Pagination Arguments
--resource-group -g

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

全局参数
--debug

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

Output format.

属性 值
默认值: 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 devcenter admin project show

获取项目。

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

示例

Get

az devcenter admin project show --name "DevProject" --resource-group "rg1"

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

属性 值
Parameter group: Resource Id Arguments
--name -n

项目的名称。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

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

属性 值
Parameter group: Resource Id Arguments
--subscription

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

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

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

Output format.

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

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

--verbose

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

属性 值
默认值: False

az devcenter admin project update

更新项目。

az devcenter admin project update [--add]
                                  [--azure-ai-services-settings]
                                  [--catalog-item-sync-types]
                                  [--customization-settings]
                                  [--description]
                                  [--dev-box-auto-delete-settings]
                                  [--display-name]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--identity-type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
                                  [--ids]
                                  [--max-dev-boxes-per-user]
                                  [--name]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--remove]
                                  [--resource-group]
                                  [--serverless-gpu-sessions-settings]
                                  [--set]
                                  [--subscription]
                                  [--tags]
                                  [--user-assigned-identities]
                                  [--workspace-storage-settings]

示例

Update

az devcenter admin project update --description "This is my first project." --tags CostCenter="R&D" --name "DevProject" --resource-group "rg1" --max-dev-boxes-per-user "5"

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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

属性 值
Parameter group: Generic Update Arguments
--azure-ai-services-settings -a

指示是否为项目启用了 Azure AI 服务。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
--catalog-item-sync-types -c

指示可以同步的目录项类型。 允许的值为“EnvironmentDefinition”和“ImageDefinition”。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: CatalogSettings Arguments
--customization-settings

用于自定义的设置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
--description

项目的说明。

属性 值
Parameter group: Properties Arguments
--dev-box-auto-delete-settings -d

Dev Box 自动删除设置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
--display-name

项目的显示名称。

属性 值
Parameter group: Properties Arguments
--force-string

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

属性 值
Parameter group: Generic Update Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--identity-type

托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。

属性 值
Parameter group: Identity Arguments
接受的值: None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned
--ids

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

属性 值
Parameter group: Resource Id Arguments
--max-dev-boxes-per-user

指定后，限制单个用户可以在项目中的所有池中创建的最大开发框数。 减少时，这不会影响现有开发框。

属性 值
Parameter group: Properties Arguments
--name -n

项目的名称。

属性 值
Parameter group: Resource Id Arguments
--no-wait

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

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

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

属性 值
Parameter group: Generic Update Arguments
--resource-group -g

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

属性 值
Parameter group: Resource Id Arguments
--serverless-gpu-sessions-settings -s

用于无服务器 GPU 的设置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
--set

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

属性 值
Parameter group: Generic Update Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
--tags

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

属性 值
Parameter group: Body Arguments
--user-assigned-identities -u

与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象（{}）。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Identity Arguments
--workspace-storage-settings -w

用于工作区存储的设置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
全局参数
--debug

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

Output format.

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

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

--verbose

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

属性 值
默认值: False

az devcenter admin project wait

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

az devcenter admin project wait [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--ids]
                                [--interval]
                                [--name]
                                [--resource-group]
                                [--subscription]
                                [--timeout]
                                [--updated]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--custom

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

属性 值
Parameter group: Wait Condition Arguments
--deleted

等到删除为止。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--exists

等待资源存在。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--ids

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

属性 值
Parameter group: Resource Id Arguments
--interval

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

属性 值
Parameter group: Wait Condition Arguments
默认值: 30
--name -n

项目的名称。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

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

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
--timeout

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

属性 值
Parameter group: Wait Condition Arguments
默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

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

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

Output format.

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

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

--verbose

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

属性 值
默认值: False