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

az devcenter admin catalog

注意

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

管理目录。

命令

名称 说明 类型 状态
az devcenter admin catalog connect

连接目录以启用同步。

扩展 GA
az devcenter admin catalog create

创建目录。

扩展 GA
az devcenter admin catalog delete

删除目录资源。

扩展 GA
az devcenter admin catalog get-sync-error-detail

获取目录同步错误详细信息。

扩展 GA
az devcenter admin catalog list

列出开发人员中心的目录。

扩展 GA
az devcenter admin catalog show

获取目录。

扩展 GA
az devcenter admin catalog sync

同步模板源的模板。

扩展 GA
az devcenter admin catalog update

更新目录。

扩展 GA
az devcenter admin catalog wait

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

扩展 GA

az devcenter admin catalog connect

连接目录以启用同步。

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

示例

连接

az devcenter admin catalog connect --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1"

可选参数

--catalog-name --name -n

目录的名称。

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

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

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource 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 配置默认订阅。

全局参数
--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 catalog create

创建目录。

az devcenter admin catalog create --catalog-name
                                  --dev-center
                                  --resource-group
                                  [--ado-git]
                                  [--git-hub]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--sync-type {Manual, Scheduled}]
                                  [--tags]

示例

使用 Azure DevOps 存储库创建

az devcenter admin catalog create --ado-git path="/templates" branch="main" secret-identifier="https://contosokv.vault.azure.net/secrets/CentralRepoPat" uri="https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso" --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1"

使用 GitHub 存储库创建

az devcenter admin catalog create --git-hub path="/templates" branch="main" secret-identifier="https://contosokv.vault.azure.net/secrets/CentralRepoPat" uri="https://github.com/Contoso/centralrepo-fake.git" --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1"

必需参数

--catalog-name --name -n

目录的名称。

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

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

--resource-group -g

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

可选参数

--ado-git

Azure DevOps 目录类型的属性。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--git-hub

GitHub 目录类型的属性。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--no-wait

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

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

指示为目录配置的同步类型。

接受的值: Manual, Scheduled
--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 catalog delete

删除目录资源。

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

示例

删除

az devcenter admin catalog delete --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1"

可选参数

--catalog-name --name -n

目录的名称。

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

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

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource 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 catalog get-sync-error-detail

获取目录同步错误详细信息。

az devcenter admin catalog get-sync-error-detail [--catalog-name]
                                                 [--dev-center]
                                                 [--ids]
                                                 [--resource-group]
                                                 [--subscription]

示例

获取同步错误详细信息

az devcenter admin catalog get-sync-error-detail --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1"

可选参数

--catalog-name --name -n

目录的名称。

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

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

--ids

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

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

列出开发人员中心的目录。

az devcenter admin catalog list --dev-center
                                --resource-group
                                [--max-items]
                                [--next-token]

示例

列出

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

必需参数

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

开发人员中心的名称。 用于 az configure -d dev-center=<dev_center_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 catalog show

获取目录。

az devcenter admin catalog show [--catalog-name]
                                [--dev-center]
                                [--ids]
                                [--resource-group]
                                [--subscription]

示例

获取

az devcenter admin catalog show --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1"

可选参数

--catalog-name --name -n

目录的名称。

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

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

--ids

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

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

同步模板源的模板。

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

示例

Sync

az devcenter admin catalog sync --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1"

可选参数

--catalog-name --name -n

目录的名称。

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

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

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource 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 配置默认订阅。

全局参数
--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 catalog update

更新目录。

az devcenter admin catalog update [--add]
                                  [--ado-git]
                                  [--catalog-name]
                                  [--dev-center]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--git-hub]
                                  [--ids]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--remove]
                                  [--resource-group]
                                  [--set]
                                  [--subscription]
                                  [--sync-type {Manual, Scheduled}]
                                  [--tags]

示例

更新

az devcenter admin catalog update --git-hub path="/environments" --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1"

可选参数

--add

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

--ado-git

Azure DevOps 目录类型的属性。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--catalog-name --name -n

目录的名称。

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

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

--force-string

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

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

GitHub 目录类型的属性。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--ids

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

--no-wait

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

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

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

--resource-group -g

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

--set

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

--subscription

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

--sync-type

指示为目录配置的同步类型。

接受的值: Manual, Scheduled
--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 catalog wait

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

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

可选参数

--catalog-name --name -n

目录的名称。

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

--exists

等待资源存在。

默认值: False
--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource 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 获取完整的调试日志。