az devcenter admin catalog
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 catalog command. Learn more about extensions.
Manage catalogs.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az devcenter admin catalog create |
Create a catalog. |
Extension | GA |
| az devcenter admin catalog delete |
Delete a catalog resource. |
Extension | GA |
| az devcenter admin catalog get-sync-error-detail |
Gets catalog synchronization error details. |
Extension | GA |
| az devcenter admin catalog list |
List catalogs for a dev center. |
Extension | GA |
| az devcenter admin catalog show |
Get a catalog. |
Extension | GA |
| az devcenter admin catalog sync |
Syncs templates for a template source. |
Extension | GA |
| az devcenter admin catalog update |
Update a catalog. |
Extension | GA |
| az devcenter admin catalog wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az devcenter admin catalog create
Create a catalog.
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}]Examples
Create using an Azure DevOps repository
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"Create using a GitHub repository
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"Required Parameters
The name of the catalog.
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Properties for an Azure DevOps catalog type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Properties for a GitHub catalog type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
Indicates the type of sync that is configured for the catalog.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter admin catalog delete
Delete a catalog resource.
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]Examples
Delete
az devcenter admin catalog delete --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1"Optional Parameters
The name of the catalog.
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter admin catalog get-sync-error-detail
Gets catalog synchronization error details.
az devcenter admin catalog get-sync-error-detail [--catalog-name]
[--dev-center]
[--ids]
[--resource-group]
[--subscription]Examples
Get synchronization error detail
az devcenter admin catalog get-sync-error-detail --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1"Optional Parameters
The name of the catalog.
The name of the dev center.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter admin catalog list
List catalogs for a dev center.
az devcenter admin catalog list --dev-center
--resource-group
[--max-items]
[--next-token]Examples
List
az devcenter admin catalog list --dev-center-name "Contoso" --resource-group "rg1"Required Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter admin catalog show
Get a catalog.
az devcenter admin catalog show [--catalog-name]
[--dev-center]
[--ids]
[--resource-group]
[--subscription]Examples
Get
az devcenter admin catalog show --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1"Optional Parameters
The name of the catalog.
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter admin catalog sync
Syncs templates for a template source.
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]Examples
Sync
az devcenter admin catalog sync --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1"Optional Parameters
The name of the catalog.
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter admin catalog update
Update a catalog.
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}]Examples
Update
az devcenter admin catalog update --git-hub path="/environments" --name "CentralCatalog" --dev-center-name "Contoso" --resource-group "rg1"Optional Parameters
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>.
Properties for an Azure DevOps catalog type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the catalog.
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Properties for a GitHub catalog type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Indicates the type of sync that is configured for the catalog.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter admin catalog wait
Place the CLI in a waiting state until a condition is met.
az devcenter admin catalog wait [--catalog-name]
[--created]
[--custom]
[--deleted]
[--dev-center]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
The name of the catalog.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for