Share via

Create a catalog

  • Article

This workflow shows how to create a catalog using the portal or CLI. Catalogs are used to manage products, devices and device groups. For more information, see About catalogs.

Use the portal

  1. Sign in to the Azure Portal. To locate the Azure Sphere service, in the top search bar, enter and select Azure Sphere. The Azure Sphere page is displayed.
  2. Select + Create from the menu at the top of the page. The Create Azure Sphere Catalog page displays.
  3. Under Project details, enter the following values:
    • Subscription: Select your Azure subscription.
    • Resource group: Enter a new resource group name.
  4. Under Instance details, enter the following values:
    • Name: Enter a name for the catalog. Catalog names can contain only alphanumeric characters, underscores, and hyphens, and cannot exceed 30 characters.
    • Region: Select an Azure location, such as global.
  5. Select Review + create.
  6. Select Create. It takes a few seconds to create a catalog.
  7. Select Refresh from the top menu to refresh the list, and then select the newly created item to open it. Or select Notification(the bell icon) from the top, and then select Go to resource group to open the resource group where the resource is created.

Use the CLI

To create a catalog, use the az sphere catalog create command.

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

Tip

We recommend that you configure the default values for the subscription, resource group, and catalog parameters. This helps reduce redundancy and can significantly shorten CLI command syntax.

Unless you have set the active subscription, the --subscription parameter will be required for all commands. You can set the active subscription using the command az account set --subscription <subscription-name>.