Share via

Claim devices

  • Article

Every device must be "claimed" into a catalog. Claiming the device associates its unique, immutable device ID with your catalog. The Azure Sphere Security Service uses the device ID to identify and authenticate the device.

Note

You must have Contributor permissions to the catalog to be able to claim a device. The option is disabled if you do not have the required permissions.

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 Devices page to list all available devices.
  3. Select Claim from the menu at the top of the page.
  4. Enter the device ID of the device you want to claim. You can enter a maximum of 5 device IDs at a time.
  5. Select Claim at the bottom of the page.

Use the CLI

Use the az sphere device claim command to claim a device in your catalog. You can also move your device to an existing device group while claiming. If you do not specify the product and device group, the device will get claimed to the default location (.default) in your catalog.

az sphere device claim --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup --device <DeviceIdValue>

Note

This command works with a locally attached Azure Sphere device. If you attempt the command without a device attached you will receive an error.

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