az sphere device-group
Manage device groups in your resource group and catalog.
| Operation | Description |
|---|---|
| az sphere device-group list | List all device groups in a catalog. |
| az sphere device-group show | Show a device group's details. |
| az sphere device-group create | Create a device group. |
| az sphere device-group create-defaults | Create default device groups targeting a product. |
| az sphere device-group update | Update a device group's details. |
| az sphere device-group delete | Delete the specified device group. |
Commands
az sphere device-group list
List all device groups in a catalog.
Required Parameters
| Parameter | Description |
|---|---|
| --catalog -c | The Azure Sphere Catalog in which to perform this operation. Specify Azure Sphere Catalog name. You can configure the default Azure Sphere Catalog using az config set defaults.sphere.catalog=<name>. Values from: az sphere catalog list. |
| --resource-group -r | Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list. |
Optional Parameters
| Parameter | Description |
|---|---|
| --product -p | The product name. Values from: az sphere product list |
| --device-group -dg | The device group to show. Values from: az sphere device |
Examples
List all device groups in a resource group and catalog.
az sphere device-group list --resource-group MyResourceGroup --catalog MyCatalog
List all device groups with the specified name in a resource group and catalog.
az sphere device-group list --resource-group MyResourceGroup --catalog MyCatalog --device-group Development
List all device groups in a resource group, catalog, and product.
az sphere device-group list --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct
az sphere device-group show
Show a device group's details.
Required Parameters
| Parameter | Description |
|---|---|
| --product -p | The product name. Values from: az sphere product list |
| --device-group -dg | The device group to show. Values from: az sphere device |
| --catalog -c | The Azure Sphere Catalog in which to perform this operation. Specify Azure Sphere Catalog name. You can configure the default Azure Sphere Catalog using az config set defaults.sphere.catalog=<name>. Values from: az sphere catalog list. |
| --resource-group -r | Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list. |
Examples
Show details of a device group using resource group, catalog name, product name, and device group name.
az sphere device-group show --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup
az sphere device-group create
Create a device group.
Required Parameters
| Parameter | Description |
|---|---|
| --product -p | The product name. Values from: az sphere product list |
| --name -n | The certificate to download. Specify name. If no name is supplied, the active certificate is downloaded. Values from: az sphere ca |
| --description -d | Description of the device group. |
| --catalog -c | The Azure Sphere Catalog in which to perform this operation. Specify Azure Sphere Catalog name. You can configure the default Azure Sphere Catalog using az config set defaults.sphere.catalog=<name>. Values from: az sphere catalog list. |
| --resource-group -r | Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list. |
Optional Parameters
| Parameter | Description |
|---|---|
| --os-feed -f | The OS feed type to use for OS updates. |
| --application-update -a | Application update policy for this device group. |
| --allow-crash-dumps-collection -cd | Provide consent for collection of crash dumps by Microsoft for this device-group. For more information, see https://aka.ms/AzureSphereCrashDumpsCollection. |
| --regional-data-boundary -r | Regional data boundary for this device group. |
Examples
Create a new device group MyDeviceGroup in resource group MyResourceGroup, catalog MyCatalog, product MyProduct, description MyDescription, and default regional data boundary.
az sphere device-group create --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --name MyDeviceGroup --description MyDescription
Create a new device group MyDeviceGroup in resource group MyResourceGroup, catalog MyCatalog, product MyProduct, description MyDescription, and specify a regional data boundary.
az sphere device-group create --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --name MyDeviceGroup --description MyDescription --regional-data-boundary EU
az sphere device-group create-defaults
Create default device groups targeting a product.
Required Parameters
| Parameter | Description |
|---|---|
| --product -p | The product name. Values from: az sphere product list |
| --catalog -c | The Azure Sphere Catalog in which to perform this operation. Specify Azure Sphere Catalog name. You can configure the default Azure Sphere Catalog using az config set defaults.sphere.catalog=<name>. Values from: az sphere catalog list. |
| --resource-group -r | Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list. |
Examples
Create default device groups in resource group MyResourceGroup, catalog MyCatalog, and product MyProduct.
az sphere device-group create-defaults --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct
az sphere device-group update
Update a device group's details.
Required Parameters
| Parameter | Description |
|---|---|
| --product -p | The product name. Values from: az sphere product list |
| --device-group -dg | The device group to show. Values from: az sphere device |
| --catalog -c | The Azure Sphere Catalog in which to perform this operation. Specify Azure Sphere Catalog name. You can configure the default Azure Sphere Catalog using az config set defaults.sphere.catalog=<name>. Values from: az sphere catalog list. |
| --resource-group -r | Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list. |
Optional Parameters
| Parameter | Description |
|---|---|
| --description -d | A new description of the device group. |
| --os-feed -f | The OS feed type to use for OS updates. |
| --application-update -a | Application update policy for this device group. |
| --allow-crash-dumps-collection -cd | Provide consent for collection of crash dumps by Microsoft for this device-group. For more information, see https://aka.ms/AzureSphereCrashDumpsCollection. |
| --regional-data-boundary -r | Regional data boundary for this device group. |
Examples
Update the properties of a device group.
az sphere device-group update --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup --description NewDescription
az sphere device-group delete
Delete the specified device group.
Required Parameters
| Parameter | Description |
|---|---|
| --product -p | The product name. Values from: az sphere product list |
| --device-group -dg | The device group to show. Values from: az sphere device |
| --catalog -c | The Azure Sphere Catalog in which to perform this operation. Specify Azure Sphere Catalog name. You can configure the default Azure Sphere Catalog using az config set defaults.sphere.catalog=<name>. Values from: az sphere catalog list. |
| --resource-group -r | Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list. |
Examples
Delete a device group using resource group, catalog name, product name, and device group name.
az sphere device-group delete --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup