Update a device group

  • Article

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

Note

  • You must have Contributor permissions for the catalog to be able to edit 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. Go to the Device Groups page to list available device groups.
  3. Select the row of the device group that you want to edit, then select Edit from the menu at the top of the page. Or select ... at the right end of the line, then select Edit.
  4. Enter the following information:
    • Name: (Required) This field is disabled. After a device group is created, the name cannot be changed.
    • 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.
    • Update policy: Select the application updates policy for this device group. The options are No3rdPartyAppUpdates and UpdateAll.
    • Collect crash dump: Set consent for collection of crash dumps by Microsoft for the device group. For more information, see Configure crash dumps.
  5. Select Edit to apply the changes to the device group.

Use the CLI

Use the az sphere device-group update command.

az sphere device-group update --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup --description NewDescription

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