Share via

az sphere catalog

  • Article

Manage catalogs.

Operation Description
az sphere catalog create Create a catalog.
az sphere catalog delete Delete a catalog.
az sphere catalog list List available catalogs either in a resource group or a subscription.
az sphere catalog show Show details of a catalog.
az sphere catalog download-error-report List or download the available error reports for the selected catalog.

Commands

az sphere catalog create

Create a catalog.

Required Parameters

Parameter Description
--name -n The name of the catalog. Allows alphanumeric characters, underscores, and hyphens, and must be less than 30 characters.
--resource-group -g Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list.

Examples

Create a new catalog MyCatalog in resource group MyResourceGroup.

az sphere catalog create --resource-group MyResourceGroup --name MyCatalog

az sphere catalog delete

Delete a catalog.

Required Parameters

Parameter Description
--catalog -c The Azure Sphere Catalog in which to perform this operation. Specify Azure Sphere Catalog name. You can configure the default Azure Sphere Catalog using az config set defaults.sphere.catalog=<name>. Values from: az sphere catalog list.
--resource-group -g Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list.

Examples

Delete a catalog using resource group and catalog name.

az sphere catalog delete --resource-group MyResourceGroup --catalog MyCatalog

az sphere catalog list

List available catalogs either in a resource group or a subscription.

Required Parameters

Parameter Description
--all List all catalogs in all resource groups in a subscription.
--resource-group -g Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list.

Examples

List all catalogs in a resource group.

az sphere catalog list --resource-group MyResourceGroup

List all catalogs in all resource groups in a subscription.

az sphere catalog list --all

az sphere catalog show

Show details of a catalog.

Required Parameters

Parameter Description
--catalog -c The Azure Sphere Catalog in which to perform this operation. Specify Azure Sphere Catalog name. You can configure the default Azure Sphere Catalog using az config set defaults.sphere.catalog=<name>. Values from: az sphere catalog list.
--resource-group -g Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list.

Examples

Show details of a catalog using resource group and catalog name.

az sphere catalog show --resource-group MyResourceGroup --catalog MyCatalog

az sphere catalog download-error-report

List or download the available error reports for the selected catalog.

Required Parameters

Parameter Description
--catalog -c The Azure Sphere Catalog in which to perform this operation. Specify Azure Sphere Catalog name. You can configure the default Azure Sphere Catalog using az config set defaults.sphere.catalog=<name>. Values from: az sphere catalog list.
--resource-group -g Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list.

Optional Parameters

Parameter Description
--output-file -of The path to the new csv file to create, containing the error report data. You can provide a relative or absolute path. If this parameter is not set, the file will be saved in the current folder with a default name. (Path).

Examples

Download error reports in a csv file using resource group and catalog name.

az sphere catalog download-error-report --resource-group MyResourceGroup --catalog MyCatalog --output-file myErrorReport.csv