product
Important
This is the Azure Sphere (Legacy) documentation. Azure Sphere (Legacy) is retiring on 27 September 2027, and users must migrate to Azure Sphere (Integrated) by this time. Use the Version selector located above the TOC to view the Azure Sphere (Integrated) documentation.
Manages products.
| Operation | Description |
|---|---|
| create | Creates a new product. |
| delete | Deletes an existing product. |
| device | Displays devices in this product. |
| device-group | Manages product device groups. |
| list | Lists all products in the Azure Sphere tenant. |
| show | Displays details about a product. |
| update | Updates specified metadata. |
create
Creates a new product.
The azsphere product create command automatically adds five default device groups to the created product:
- Development device group disables cloud application updates and delivers the Retail OS.
- Field Test device group enables cloud application updates and delivers the Retail OS.
- Production device group enables cloud application updates and delivers the Retail OS.
- Production OS Evaluation device group enables cloud application updates and delivers the Retail Evaluation OS.
- Field Test OS Evaluation device group enables cloud application updates and delivers the Retail Evaluation OS.
Required parameters
| Parameter | Type | Description |
|---|---|---|
| -n, --name | String | Specifies a name for the product. The name can only include alphanumeric characters. If the name includes spaces, enclose it in quotation marks. The product name cannot exceed 50 characters, is case insensitive, and must be unique within a tenant. |
Optional parameters
| Parameter | Type | Description |
|---|---|---|
| -g, --no-default-device-groups | Boolean | Specifies an optional flag that prevents the creation of the default device groups. |
| -t, --tenant | GUID or name | Specifies the tenant to perform this operation in. Overrides the default selected tenant. You can specify either the tenant ID or tenant name. |
| -d, --description | String | Specifies the optional text to describe the product. The maximum length is 100 characters. If the description includes spaces, enclose it in quotation marks. |
Global parameters
The following global parameters are available for the Azure Sphere CLI:
| Parameter | Description |
|---|---|
| --debug | Increases logging verbosity to show all debug logs. If you find a bug, provide output generated with the --debug flag on when submitting a bug report. |
| -h, --help | Prints CLI reference information about commands and their arguments and lists available subgroups and commands. |
| --only-show-errors | Shows only errors, suppressing warnings. |
| -o, --output | Changes the output format. The available output formats are json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. By default the CLI outputs table. To learn more about the available output formats, see Output format for Azure Sphere CLI commands. |
| --query | Uses the JMESPath query language to filter the output returned from Azure Sphere Security Services. See JMESPath tutorial and Query Azure CLI command output for more information and examples. |
| --verbose | Prints information about resources created in Azure Sphere during an operation and other useful information. Use --debug for full debug logs. |
Note
If you are using Azure Sphere classic CLI, see Global parameters for more information on available options.
Example
azsphere product create --name DW100 --description "Contoso DW100 models"
Default device groups will been created for this product, use the 'azsphere product device-group list' command to see them.
------------------------------------ -------------------- ----- ------------------------------------
TenantId Description Name Id
====================================================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb Contoso DW100 models DW100 6f52bead-700d-4289-bdc2-2f11f774270e
------------------------------------ -------------------- ----- ------------------------------------
delete
Deletes the specified product in your Azure Sphere tenant.
A product can only be deleted when:
- The user has administrator permissions to the tenant.
- The product is empty and the device groups have no devices in it. The azsphere product device list command lists all the devices in a product. Run azsphere device update --device-group to move the device to a different device group or azsphere device-group delete to delete a device group.
Required parameters
| Parameter | Type | Description |
|---|---|---|
| -p, --product | GUID or name | Specifies the product to delete. You can specify either the ID or name of the Azure Sphere product. |
Optional parameters
| Parameter | Type | Description |
|---|---|---|
| -t, --tenant | GUID or name | Specifies the tenant to perform this operation in. Overrides the default selected tenant. You can specify either the tenant ID or tenant name. |
Global parameters
The following global parameters are available for the Azure Sphere CLI:
| Parameter | Description |
|---|---|
| --debug | Increases logging verbosity to show all debug logs. If you find a bug, provide output generated with the --debug flag on when submitting a bug report. |
| -h, --help | Prints CLI reference information about commands and their arguments and lists available subgroups and commands. |
| --only-show-errors | Shows only errors, suppressing warnings. |
| -o, --output | Changes the output format. The available output formats are json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. By default the CLI outputs table. To learn more about the available output formats, see Output format for Azure Sphere CLI commands. |
| --query | Uses the JMESPath query language to filter the output returned from Azure Sphere Security Services. See JMESPath tutorial and Query Azure CLI command output for more information and examples. |
| --verbose | Prints information about resources created in Azure Sphere during an operation and other useful information. Use --debug for full debug logs. |
Note
If you are using Azure Sphere classic CLI, see Global parameters for more information on available options.
Example
Example to specify product by ID:
azsphere product delete --product 6f52bead-700d-4289-bdc2-2f11f774270e
Example to specify product by name:
azsphere product delete --product DW100
You should see output like this:
Successfully deleted the product
device
Shows devices within a product.
| Operation | Description |
|---|---|
| list | Displays devices within the specified product. |
| show-count | Returns a count of devices within the product. |
device list
Displays devices within the specified product, listed by device ID.
Required parameters
| Parameter | Type | Description |
|---|---|---|
| -p, --product | GUID or name | Specifies the product in which to list the devices. You can specify either the ID or name of the Azure Sphere product. |
Optional parameters
| Parameter | Type | Description |
|---|---|---|
| -t, --tenant | GUID or name | Specifies the tenant to perform this operation in. Overrides the default selected tenant. You can specify either the tenant ID or tenant name. |
Global parameters
The following global parameters are available for the Azure Sphere CLI:
| Parameter | Description |
|---|---|
| --debug | Increases logging verbosity to show all debug logs. If you find a bug, provide output generated with the --debug flag on when submitting a bug report. |
| -h, --help | Prints CLI reference information about commands and their arguments and lists available subgroups and commands. |
| --only-show-errors | Shows only errors, suppressing warnings. |
| -o, --output | Changes the output format. The available output formats are json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. By default the CLI outputs table. To learn more about the available output formats, see Output format for Azure Sphere CLI commands. |
| --query | Uses the JMESPath query language to filter the output returned from Azure Sphere Security Services. See JMESPath tutorial and Query Azure CLI command output for more information and examples. |
| --verbose | Prints information about resources created in Azure Sphere during an operation and other useful information. Use --debug for full debug logs. |
Note
If you are using Azure Sphere classic CLI, see Global parameters for more information on available options.
Example
Example to specify product by ID:
azsphere product device list --product 6f52bead-700d-4289-bdc2-2f11f774270e
Example to specify product by name:
azsphere product device list --product DW100
You should see output like this:
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ ------------------------------------ ------------------------------------
DeviceId TenantId ProductId DeviceGroupId
===============================================================================================================================================================================================================================================
352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 143adbc9-1bf0-4be2-84a2-084a331d81cb 6f52bead-700d-4289-bdc2-2f11f774270e 7f860cc1-4949-4000-a541-9a988ba4c3cd
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ ------------------------------------ ------------------------------------
device show-count
Returns the total number of all devices in all device groups within a product.
Required parameters
| Parameter | Type | Description |
|---|---|---|
| -p, --product | GUID or name | Specifies the product for which the number of targeted devices is shown. You can specify either the ID or name of the Azure Sphere product. |
Optional parameters
| Parameter | Type | Description |
|---|---|---|
| -t, --tenant | GUID or name | Specifies the tenant to perform this operation in. Overrides the default selected tenant. You can specify either the tenant ID or tenant name. |
Global parameters
The following global parameters are available for the Azure Sphere CLI:
| Parameter | Description |
|---|---|
| --debug | Increases logging verbosity to show all debug logs. If you find a bug, provide output generated with the --debug flag on when submitting a bug report. |
| -h, --help | Prints CLI reference information about commands and their arguments and lists available subgroups and commands. |
| --only-show-errors | Shows only errors, suppressing warnings. |
| -o, --output | Changes the output format. The available output formats are json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. By default the CLI outputs table. To learn more about the available output formats, see Output format for Azure Sphere CLI commands. |
| --query | Uses the JMESPath query language to filter the output returned from Azure Sphere Security Services. See JMESPath tutorial and Query Azure CLI command output for more information and examples. |
| --verbose | Prints information about resources created in Azure Sphere during an operation and other useful information. Use --debug for full debug logs. |
Note
If you are using Azure Sphere classic CLI, see Global parameters for more information on available options.
Example
Example to specify product by ID:
azsphere product device show-count --product 6f52bead-700d-4289-bdc2-2f11f774270e
Example to specify product by name:
azsphere product device show-count --product DW100
You should see output like this:
------
Result
======
2
------
device-group
Manages product device groups.
| Operation | Description |
|---|---|
| create-defaults | Creates the default device groups within the specified product. |
| list | Displays device groups within the specified product. |
device-group create-defaults
Creates the default device groups within an existing product.
Required parameters
| Parameter | Type | Description |
|---|---|---|
| -p, --product | GUID or name | Specifies the product to get. You can specify either the ID or name of the Azure Sphere product. |
Optional parameters
| Parameter | Type | Description |
|---|---|---|
| -t, --tenant | GUID or name | Specifies the tenant to perform this operation in. Overrides the default selected tenant. You can specify either the tenant ID or tenant name. |
Global parameters
The following global parameters are available for the Azure Sphere CLI:
| Parameter | Description |
|---|---|
| --debug | Increases logging verbosity to show all debug logs. If you find a bug, provide output generated with the --debug flag on when submitting a bug report. |
| -h, --help | Prints CLI reference information about commands and their arguments and lists available subgroups and commands. |
| --only-show-errors | Shows only errors, suppressing warnings. |
| -o, --output | Changes the output format. The available output formats are json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. By default the CLI outputs table. To learn more about the available output formats, see Output format for Azure Sphere CLI commands. |
| --query | Uses the JMESPath query language to filter the output returned from Azure Sphere Security Services. See JMESPath tutorial and Query Azure CLI command output for more information and examples. |
| --verbose | Prints information about resources created in Azure Sphere during an operation and other useful information. Use --debug for full debug logs. |
Note
If you are using Azure Sphere classic CLI, see Global parameters for more information on available options.
Example
Example to specify product by ID:
azsphere product device-group create-defaults --product 6f52bead-700d-4289-bdc2-2f11f774270e
Example to specify product by name:
azsphere product device-group create-defaults --product DW100
You should see output like this:
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- -------------------------
Id Name Description ProductId OsFeedType UpdatePolicy AllowCrashDumpsCollection RegionalDataBoundary
=====================================================================================================================================================================================================================================================================================
6406868c-19bb-4bea-b4cf-fd80608ee5cb Development Default development device group ac181192-2569-4d95-8f70-f8fd9e8dd2e3 Retail Accept only system software updates. Don't accept application updates. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
d2e2b2e7-e219-4af8-8876-f8d10624778b Field Test Default test device group ac181192-2569-4d95-8f70-f8fd9e8dd2e3 Retail Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
822f1bda-32d7-404a-bf37-9f90aad09509 Production Default production device group ac181192-2569-4d95-8f70-f8fd9e8dd2e3 Retail Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
3fafc0e1-f336-4a8a-9be4-fb275322d2cc Production OS Evaluation Default Production OS Evaluation device group ac181192-2569-4d95-8f70-f8fd9e8dd2e3 RetailEval Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
b9b7f388-2ad4-4a7e-a4dc-6559fb80741d Field Test OS Evaluation Default Field Test OS Evaluation device group ac181192-2569-4d95-8f70-f8fd9e8dd2e3 RetailEval Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
device-group list
Lists all device groups in a product.
Required parameters
| Parameter | Type | Description |
|---|---|---|
| -p, --product | GUID or name | Specifies the product to list the device groups for. You can specify either the ID or name of the Azure Sphere product. |
Optional parameters
| Parameter | Type | Description |
|---|---|---|
| -t, --tenant | GUID or name | Specifies the tenant to perform this operation in. Overrides the default selected tenant. You can specify either the tenant ID or tenant name. |
Global parameters
The following global parameters are available for the Azure Sphere CLI:
| Parameter | Description |
|---|---|
| --debug | Increases logging verbosity to show all debug logs. If you find a bug, provide output generated with the --debug flag on when submitting a bug report. |
| -h, --help | Prints CLI reference information about commands and their arguments and lists available subgroups and commands. |
| --only-show-errors | Shows only errors, suppressing warnings. |
| -o, --output | Changes the output format. The available output formats are json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. By default the CLI outputs table. To learn more about the available output formats, see Output format for Azure Sphere CLI commands. |
| --query | Uses the JMESPath query language to filter the output returned from Azure Sphere Security Services. See JMESPath tutorial and Query Azure CLI command output for more information and examples. |
| --verbose | Prints information about resources created in Azure Sphere during an operation and other useful information. Use --debug for full debug logs. |
Note
If you are using Azure Sphere classic CLI, see Global parameters for more information on available options.
Example
Example to specify product by ID:
azsphere product device-group list --product 6f52bead-700d-4289-bdc2-2f11f774270e
Example to specify product by name:
azsphere product device-group list --product DW100
You should see output like this:
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- -------------------------
Id TenantId OsFeedType ProductId Name Description UpdatePolicy AllowCrashDumpsCollection RegionalDataBoundary
==========================================================================================================================================================================================================================================================================================================================
6406868c-19bb-4bea-b4cf-fd80608ee5cb 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail 4f48d618-09f7-45dc-a5a4-1433cabbee91 Development Default development device group Accept only system software updates. Don't accept application updates. False None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
d2e2b2e7-e219-4af8-8876-f8d10624778b 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail 4f48d618-09f7-45dc-a5a4-1433cabbee91 Field Test Default test device group Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
822f1bda-32d7-404a-bf37-9f90aad09509 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail 4f48d618-09f7-45dc-a5a4-1433cabbee91 Production Default production device group Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
a6c64cda-4ff0-48bb-8a30-6ffab322b846 143adbc9-1bf0-4be2-84a2-084a331d81cb RetailEval 4f48d618-09f7-45dc-a5a4-1433cabbee91 Production OS Evaluation Default Production OS Evaluation device group Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
3fafc0e1-f336-4a8a-9be4-fb275322d2cc 143adbc9-1bf0-4be2-84a2-084a331d81cb RetailEval 4f48d618-09f7-45dc-a5a4-1433cabbee91 Field Test OS Evaluation Default Field Test OS Evaluation device group Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
b9b7f388-2ad4-4a7e-a4dc-6559fb80741d 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail 4f48d618-09f7-45dc-a5a4-1433cabbee91 Marketing Default Marketing device group Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
list
Lists all products in the Azure Sphere tenant.
Optional parameters
| Parameter | Type | Description |
|---|---|---|
| -t, --tenant | GUID or name | Specifies the tenant to perform this operation in. Overrides the default selected tenant. You can specify either the tenant ID or tenant name. |
Global parameters
The following global parameters are available for the Azure Sphere CLI:
| Parameter | Description |
|---|---|
| --debug | Increases logging verbosity to show all debug logs. If you find a bug, provide output generated with the --debug flag on when submitting a bug report. |
| -h, --help | Prints CLI reference information about commands and their arguments and lists available subgroups and commands. |
| --only-show-errors | Shows only errors, suppressing warnings. |
| -o, --output | Changes the output format. The available output formats are json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. By default the CLI outputs table. To learn more about the available output formats, see Output format for Azure Sphere CLI commands. |
| --query | Uses the JMESPath query language to filter the output returned from Azure Sphere Security Services. See JMESPath tutorial and Query Azure CLI command output for more information and examples. |
| --verbose | Prints information about resources created in Azure Sphere during an operation and other useful information. Use --debug for full debug logs. |
Note
If you are using Azure Sphere classic CLI, see Global parameters for more information on available options.
Example
azsphere product list
------------------------------------ ------------------------------------ --------- --------------------
Id TenantId Name Description
========================================================================================================
6f52bead-700d-4289-bdc2-2f11f774270e 143adbc9-1bf0-4be2-84a2-084a331d81cb DW100 Contoso DW100 models
------------------------------------ ------------------------------------ --------- --------------------
6a82518f-8965-4bd6-ba79-43aa3fcafe5e 143adbc9-1bf0-4be2-84a2-084a331d81cb DW200 Contoso DW200 models
------------------------------------ ------------------------------------ --------- --------------------
show
Displays details about a product.
Required parameters
| Parameter | Type | Description |
|---|---|---|
| -p, --product | GUID or name | Specifies the product to get. You can specify either the ID or name of the Azure Sphere product. |
Optional parameters
| Parameter | Type | Description |
|---|---|---|
| -t, --tenant | GUID or name | Specifies the tenant to perform this operation in. Overrides the default selected tenant. You can specify either the tenant ID or tenant name. |
Global parameters
The following global parameters are available for the Azure Sphere CLI:
| Parameter | Description |
|---|---|
| --debug | Increases logging verbosity to show all debug logs. If you find a bug, provide output generated with the --debug flag on when submitting a bug report. |
| -h, --help | Prints CLI reference information about commands and their arguments and lists available subgroups and commands. |
| --only-show-errors | Shows only errors, suppressing warnings. |
| -o, --output | Changes the output format. The available output formats are json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. By default the CLI outputs table. To learn more about the available output formats, see Output format for Azure Sphere CLI commands. |
| --query | Uses the JMESPath query language to filter the output returned from Azure Sphere Security Services. See JMESPath tutorial and Query Azure CLI command output for more information and examples. |
| --verbose | Prints information about resources created in Azure Sphere during an operation and other useful information. Use --debug for full debug logs. |
Note
If you are using Azure Sphere classic CLI, see Global parameters for more information on available options.
Example
Example to specify product and tenant by ID:
azsphere product show --product 6f52bead-700d-4289-bdc2-2f11f774270e --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
Example to specify product and tenant by name:
azsphere product show --product DW100 --tenant MyTenant
You should see output like this:
------------------------------------ ------------------------------------ ----- --------------------
Id TenantId Name Description
====================================================================================================
6f52bead-700d-4289-bdc2-2f11f774270e 143adbc9-1bf0-4be2-84a2-084a331d81cb DW100 Contoso DW100 models
------------------------------------ ------------------------------------ ----- --------------------
update
Updates specified product metadata.
At least one optional parameter must be provided, either --newname or --newdescription. Both can be specified in a single command.
Required parameters
| Parameter | Type | Description |
|---|---|---|
| -p, --product | GUID or name | Specifies the product to update. You can specify either the ID or name of the Azure Sphere product. |
Optional parameters
| Parameter | Type | Description |
|---|---|---|
| -n, --new-name | String | Specifies a new name for the product. The name can only include alphanumeric characters. If the name includes spaces, enclose it in quotation marks. The product name cannot exceed 50 characters, is case insensitive, and must be unique within a tenant. |
| -d, --new-description | String | Specifies optional text to describe the product. The maximum length is 100 characters. |
| -t, --tenant | String | Specifies the tenant to perform this operation in. Overrides the default selected tenant. You can specify either the tenant ID or tenant name. |
Global parameters
The following global parameters are available for the Azure Sphere CLI:
| Parameter | Description |
|---|---|
| --debug | Increases logging verbosity to show all debug logs. If you find a bug, provide output generated with the --debug flag on when submitting a bug report. |
| -h, --help | Prints CLI reference information about commands and their arguments and lists available subgroups and commands. |
| --only-show-errors | Shows only errors, suppressing warnings. |
| -o, --output | Changes the output format. The available output formats are json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. By default the CLI outputs table. To learn more about the available output formats, see Output format for Azure Sphere CLI commands. |
| --query | Uses the JMESPath query language to filter the output returned from Azure Sphere Security Services. See JMESPath tutorial and Query Azure CLI command output for more information and examples. |
| --verbose | Prints information about resources created in Azure Sphere during an operation and other useful information. Use --debug for full debug logs. |
Note
If you are using Azure Sphere classic CLI, see Global parameters for more information on available options.
Example
Example to specify product by ID:
azsphere product update --product 6f52bead-700d-4289-bdc2-2f11f774270e --new-description Contoso DW100 models
Example to specify product by name:
azsphere product update --product DW100 --new-description Contoso DW100 models
You should see output like this:
------------------------------------ ------------------------------------ ----- ------------------
Id TenantId Name Description
==================================================================================================
6a82518f-8965-4bd6-ba79-43aa3fcafe5e 143adbc9-1bf0-4be2-84a2-084a331d81cb DW200 Contoso DW200 models
------------------------------------ ------------------------------------ ----- ------------------