az sphere device-group

Note

This reference is part of the azure-sphere extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an az sphere device-group command. Learn more about extensions.

Manage device groups in your resource group and catalog.

Commands

Name	Description	Type	Status
az sphere device-group create	Create a device group.	Extension	GA
az sphere device-group create-defaults	Create default device groups targeting a product.	Extension	GA
az sphere device-group delete	Delete the specified device group.	Extension	GA
az sphere device-group list	List all device groups in a catalog.	Extension	GA
az sphere device-group show	Show a device group's details.	Extension	GA
az sphere device-group update	Update a device group's details.	Extension	GA

az sphere device-group create

Create a device group.

az sphere device-group create --catalog
                              --description
                              --name
                              --product
                              --resource-group
                              [--allow-crash-dumps-collection {Disabled, Enabled}]
                              [--application-update {No3rdPartyAppUpdates, UpdateAll}]
                              [--os-feed {Retail, RetailEval}]
                              [--regional-data-boundary {EU, None}]

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

Required Parameters

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

--description -d

Description of the device group.

--name -n

Alphanumeric name of the device group.

--product -p

The product name.

Property	Value
Value from:	az sphere product list

--resource-group -g

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Default value:	Disabled
Accepted values:	Disabled, Enabled

--application-update -a

Application update policy for this device group.

Property	Value
Default value:	UpdateAll
Accepted values:	No3rdPartyAppUpdates, UpdateAll

--os-feed -f

The OS feed type to use for OS updates.

Property	Value
Default value:	Retail
Accepted values:	Retail, RetailEval

--regional-data-boundary -r

Regional data boundary for this device group.

Property	Value
Default value:	None
Accepted values:	EU, None

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sphere device-group create-defaults

Create default device groups targeting a product.

az sphere device-group create-defaults --catalog
                                       --product
                                       --resource-group

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

Required Parameters

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

--product -p

The product name.

Property	Value
Value from:	az sphere product list

--resource-group -g

Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sphere device-group delete

Delete the specified device group.

az sphere device-group delete --catalog
                              --device-group
                              --product
                              --resource-group

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

Required Parameters

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

--device-group -dg

The device group name.

Property	Value
Value from:	az sphere device-group list

--product -p

The product for which to delete the device groups.

Property	Value
Value from:	az sphere product list

--resource-group -g

Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sphere device-group list

List all device groups in a catalog.

az sphere device-group list --catalog
                            --resource-group
                            [--device-group]
                            [--product]

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

Required Parameters

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--device-group -dg

List all device groups that have a specified name.

--product -p

List all device groups in a product.

Property	Value
Value from:	az sphere product list

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sphere device-group show

Show a device group's details.

az sphere device-group show --catalog
                            --device-group
                            --product
                            --resource-group

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

Required Parameters

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

--device-group -dg

The device group to show.

Property	Value
Value from:	az sphere device-group list

--product -p

The product name for which to show the device group.

Property	Value
Value from:	az sphere product list

--resource-group -g

Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sphere device-group update

Update a device group's details.

az sphere device-group update --catalog
                              --device-group
                              --product
                              --resource-group
                              [--allow-crash-dumps-collection {Disabled, Enabled}]
                              [--application-update {No3rdPartyAppUpdates, UpdateAll}]
                              [--description]
                              [--os-feed {Retail, RetailEval}]
                              [--regional-data-boundary {EU, None}]

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

Required Parameters

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

--device-group -dg

The device group name.

Property	Value
Value from:	az sphere device-group list

--product -p

The product name.

Property	Value
Value from:	az sphere product list

--resource-group -g

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Accepted values:	Disabled, Enabled

--application-update -a

Application update policy for this device group.

Property	Value
Accepted values:	No3rdPartyAppUpdates, UpdateAll

--description -d

A new description of the device group.

--os-feed -f

The OS feed type to use for OS updates.

Property	Value
Accepted values:	Retail, RetailEval

--regional-data-boundary -r

Regional data boundary for this device group.

Property	Value
Accepted values:	EU, None

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False