az devcenter admin project-catalog

  • Reference

Note

This reference is part of the devcenter extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az devcenter admin project-catalog command. Learn more about extensions.

Manage project catalogs.

Commands

Name Description Type Status
az devcenter admin project-catalog connect

Connects a project catalog to enable syncing.

 Extension GA
az devcenter admin project-catalog create

Create a project catalog.

 Extension GA
az devcenter admin project-catalog delete

Delete a project catalog resource.

 Extension GA
az devcenter admin project-catalog get-sync-error-detail

Gets project catalog synchronization error details.

 Extension GA
az devcenter admin project-catalog list

List the catalogs associated with a project.

 Extension GA
az devcenter admin project-catalog show

Get an associated project catalog.

 Extension GA
az devcenter admin project-catalog sync

Syncs templates for a template source.

 Extension GA
az devcenter admin project-catalog update

Update a project catalog.

 Extension GA
az devcenter admin project-catalog wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az devcenter admin project-catalog connect

Connects a project catalog to enable syncing.

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

Optional Parameters

--catalog-name --name -n

The name of the catalog.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az devcenter admin project-catalog create

Create a project catalog.

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

Required Parameters

--catalog-name --name -n

The name of the Catalog.

--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--ado-git

Properties for an Azure DevOps catalog type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--git-hub

Properties for a GitHub catalog type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--sync-type

Indicates the type of sync that is configured for the catalog.

Accepted values: Manual, Scheduled
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az devcenter admin project-catalog delete

Delete a project catalog resource.

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

Optional Parameters

--catalog-name --name -n

The name of the Catalog.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az devcenter admin project-catalog get-sync-error-detail

Gets project catalog synchronization error details.

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

Optional Parameters

--catalog-name --name -n

The name of the catalog.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az devcenter admin project-catalog list

List the catalogs associated with a project.

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

Required Parameters

--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az devcenter admin project-catalog show

Get an associated project catalog.

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

Optional Parameters

--catalog-name --name -n

The name of the Catalog.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az devcenter admin project-catalog sync

Syncs templates for a template source.

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

Optional Parameters

--catalog-name --name -n

The name of the catalog.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az devcenter admin project-catalog update

Update a project catalog.

az devcenter admin project-catalog update [--add]
                                          [--ado-git]
                                          [--catalog-name]
                                          [--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}]
                                          [--project]
                                          [--remove]
                                          [--resource-group]
                                          [--set]
                                          [--subscription]
                                          [--sync-type {Manual, Scheduled}]
                                          [--tags]

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--ado-git

Properties for an Azure DevOps catalog type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--catalog-name --name -n

The name of the Catalog.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--git-hub

Properties for a GitHub catalog type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--sync-type

Indicates the type of sync that is configured for the catalog.

Accepted values: Manual, Scheduled
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az devcenter admin project-catalog wait

Place the CLI in a waiting state until a condition is met.

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

Optional Parameters

--catalog-name --name -n

The name of the Catalog.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

Default value: 30
--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.