Share via

az sphere catalog

  • Reference

Note

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

Manage catalogs.

Commands

Name Description Type Status
az sphere catalog create

Create a catalog.

 Extension GA
az sphere catalog delete

Delete a catalog.

 Extension GA
az sphere catalog download-error-report

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

 Extension GA
az sphere catalog list

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

 Extension GA
az sphere catalog show

Show details of a catalog.

 Extension GA

az sphere catalog create

Create a catalog.

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

Examples

Create a new catalog "MyCatalog" in resource group "MyResourceGroup".

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

Required Parameters

--name -n

The catalog name.

--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.

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 sphere catalog delete

Delete a catalog.

az sphere catalog delete --catalog
                         --resource-group

Examples

Delete a catalog using resource group and catalog name.

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

Required Parameters

--catalog -c

The catalog name.

value 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.

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 sphere catalog download-error-report

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

az sphere catalog download-error-report --catalog
                                        --resource-group
                                        [--output-file]

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

Required Parameters

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

--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).

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

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

az sphere catalog list [--all]
                       [--resource-group]

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

Optional Parameters

--all

List all catalogs in all resource groups in a subscription.

default value: False
--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.

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 sphere catalog show

Show details of a catalog.

az sphere catalog show --catalog
                       --resource-group

Examples

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

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

Required Parameters

--catalog -c

The catalog name.

value 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.

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.