Share via

Create a device group

  • Article

Create an Azure Sphere device group using the Azure portal or Azure CLI.

Note

  • You must have Contributor permissions for the catalog to add a device group. This option is disabled if you do not have the required permissions.
  • Names can contain only alphanumeric characters and spaces. They cannot exceed 50 characters. Description cannot exceed 100 character. In the CLI, if either the name or description includes spaces, enclose it in quotation marks.

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 the required Azure Sphere catalog.
  3. Go to the Manage > Device Groups page to list available device groups.
  4. Select Create from the menu at the top of the page.
  5. The Create device group pane appears. Enter the following information:
    • Product: (Required) Select the product for which you want to create the device group from the dropdown menu.
    • Name: (Required) Enter a name for the device group. Names for device groups can contain only alphanumeric characters and spaces. They cannot exceed 50 characters.
    • Description: (Required) A useful description of the device group.
    • OS feed: Select the OS feed type to use for OS updates. The options are Retail and RetailEval. Microsoft deploys the Azure Sphere OS on the RetailEval feed two weeks before its release on the Retail OS feed, as described in Azure Sphere OS feeds. By assigning a few devices to a group that receives the Retail Evaluation OS, you can verify that your production-signed applications work with the release before we deploy it broadly.
    • Update policy: Select the application updates policy for this device group. The options are No3rdPartyAppUpdates and UpdateAll. In order for any device to update its application and board configuration images, the device group must have the UpdateAll update policy. You can disable application updates for a particular device group by using the No3rdPartyAppUpdates option.
    • Regional data boundary: Regional data boundary for this device group. Allowed values: Europe, None. Default: None
  6. Select Create to create the new device group.

Use the CLI

Use the az sphere device-group create command.

az sphere device-group create --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct -- name MyDeviceGroup --description MyDescription

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