Manage catalog

An Azure Sphere catalog provides a secure way for your organization to remotely manage its Azure Sphere devices in isolation from other customers' devices. Your organization must create an Azure Sphere catalog and then claim each of its devices into that catalog, so that you can manage those devices remotely and securely.

Prerequisites

Create an Azure Sphere catalog

An Azure Sphere catalog isolates your Azure Sphere devices and provides a way for you to organize and deploy applications. The account that creates the catalog is automatically assigned the role of administrator for the catalog.

Tip

  • Once a catalog is created, it cannot be deleted, and devices cannot be migrated between catalog. If your team or organization already has an Azure Sphere catalog, consider requesting access to it rather than creating an additional catalog.

To create an Azure Sphere catalog:

  1. Connect an Azure Sphere device to your computer by USB.

  2. Open a Azure Sphere CLI using PowerShell, Windows Command Prompt, or Linux command shell and enter the following command:

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

    Replace <catalog-name> with a name that other users can recognize, such as "Contoso Ltd" or "Contoso Dishwasher Division." When you name your catalog, use only alphanumeric characters and spaces. If you include spaces, enclose the name in quotation marks. The name must not start with a space or exceed 30 characters. Special characters are not allowed. Names are case sensitive.

The az sphere catalog create command creates a catalog but does not claim the device into the catalog. For more information, see Claim your device.

List catalog

You can list the available Azure Sphere catalog using the following options:

Run the following command to list the available Azure Sphere catalog.

az sphere catalog list

Update an existing catalog

Note

You cannot rename an existing Azure Sphere catalog using the CLI or the portal.

Download error report for catalog

To obtain error reports for all devices within a catalog, use the az sphere catalog download-error-report command.