product

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 Supported version
-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. - Azure Sphere CLI
- Azure Sphere classic CLI

Optional parameters

Parameter Type Description Supported version
-g, --no-default-device-groups Boolean Specifies an optional flag that prevents the creation of the default device groups. Azure Sphere CLI
-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. Azure Sphere CLI
-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. - Azure Sphere CLI
- Azure Sphere classic CLI
-ndg, --nodefaultdevicegroups Boolean Specifies an optional flag that prevents the creation of the default device groups. Azure Sphere classic CLI
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
 ====================================================================================================
 a323c263-2aa3-2559-aabb-a3fc32631900 Contoso DW100 models DW100 6gae21e6-g661-4b01-b935-3c5bf2ba0f72
 ------------------------------------ -------------------- ----- ------------------------------------

delete

Deletes the specified product in your Azure Sphere tenant.

A product can only be deleted when:

Note

This command is not available in Azure Sphere classic CLI.

Required parameters

Parameter Type Description Supported version
-p, --product GUID or name Specifies the product to delete. You can specify either the ID or name of the Azure Sphere product. Azure Sphere CLI

Optional parameters

Parameter Type Description Supported version
-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. Azure Sphere CLI
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 6gae21e6-g661-4b01-b935-3c5bf2ba0f72

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 Supported version
-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. Azure Sphere CLI
-i, --productid GUID Specifies the ID of the product for which to display devices. Either --productid or --productname must be present. Azure Sphere classic CLI
-n, --productname String Specifies the name of the product for which to display devices. Either --productid or --productname must be present. Azure Sphere classic CLI

Optional parameters

Parameter Type Description Supported version
-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. Azure Sphere CLI
-ni, --noninteractive Boolean Displays all devices by turning on non-interactive mode. Azure Sphere classic CLI
-o, --output String Specifies the path to the new csv file to contain the device list data. You may provide a relative or absolute path. Azure Sphere classic CLI
-si, --showids Boolean Displays device IDs in the results. Azure Sphere classic CLI
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 6gae21e6-g661-4b01-b935-3c5bf2ba0f72

Example to specify product by name:

azsphere product device list --product DW100

You should see output like this:

-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ ------------------------------------ ------------------------------------
DeviceId                                                                                                                         TenantId                             ProductId                            DeviceGroupId
===============================================================================================================================================================================================================================================
6A06X8X8CXDXA8ED4223A267656CXD59X99A0CED693A2446884A236D925AAAEX9AXDD0550438595658ADDC66723X32DECX5494X7A20D067C6C8X77A6020C9A46 a323c263-2aa3-2559-aabb-a3fc32631900 6gae21e6-g661-4b01-b935-3c5bf2ba0f72 0e78m0mm-47d9-42m5-8572-a20b315d8045
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ ------------------------------------ ------------------------------------

device show-count

Returns the total number of all devices in all device groups within a product.

Required parameters

Parameter Type Description Supported version
-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. Azure Sphere CLI
-i, --productid GUID Specifies the ID of the product for which to display the device count. Either --productid or --productname must be present. Azure Sphere classic CLI
-n, --productname String Specifies the name of the product for which to display the device count. Either --productid or --productname must be present. Azure Sphere classic CLI

Optional parameters

Parameter Type Description Supported version
-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. Azure Sphere CLI
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 6gae21e6-g661-4b01-b935-3c5bf2ba0f72

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 Supported version
-p, --product GUID or name Specifies the product to get. You can specify either the ID or name of the Azure Sphere product. Azure Sphere CLI
-i, --productid GUID Specifies the ID of the product for which to create default device groups. Either --productid OR --productname must be present. Azure Sphere classic CLI
-n, --productname String Specifies the name of the product for which to create default device groups. Either --productid OR --productname must be present. Azure Sphere classic CLI

Optional parameters

Parameter Type Description Supported version
-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. Azure Sphere CLI
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 6gae21e6-g661-4b01-b935-3c5bf2ba0f72

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

device-group list

Lists all device groups in a product.

Required parameters

Parameter Type Description Supported version
-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. Azure Sphere CLI
-i, --productid GUID Specifies the ID of the product for which to display device groups. Either --productid or --productname must be present. Azure Sphere classic CLI
-n, --productname String Specifies the name of the product for which to display device groups. Either --productid or --productname must be present. Azure Sphere classic CLI

Optional parameters

Parameter Type Description Supported version
-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. Azure Sphere CLI
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 6gae21e6-g661-4b01-b935-3c5bf2ba0f72

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
=================================================================================================================================================================================================================================================================================================
6406868c-19bb-4bea-b4cf-fd80608ee5cb 143adbc9-a5c4-4be2-84a2-c4f00f73a472 Retail     4f48d618-09f7-45dc-a5a4-1433cabbee91 Development              Default development device group              Accept only system software updates. Don't accept application updates. False
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- -------------------------
d2e2b2e7-e219-4af8-8876-f8d10624778b 143adbc9-a5c4-4be2-84a2-c4f00f73a472 Retail     4f48d618-09f7-45dc-a5a4-1433cabbee91 Field Test               Default test device group                     Accept all updates from the Azure Sphere Security Service.             False
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- -------------------------
822f1bda-32d7-404a-bf37-9f90aad09509 143adbc9-a5c4-4be2-84a2-c4f00f73a472 Retail     4f48d618-09f7-45dc-a5a4-1433cabbee91 Production               Default production device group               Accept all updates from the Azure Sphere Security Service.             False
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- -------------------------
a6c64cda-4ff0-48bb-8a30-6ffab322b846 143adbc9-a5c4-4be2-84a2-c4f00f73a472 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
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- -------------------------
3fafc0e1-f336-4a8a-9be4-fb275322d2cc 143adbc9-a5c4-4be2-84a2-c4f00f73a472 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
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- -------------------------
b9b7f388-2ad4-4a7e-a4dc-6559fb80741d 143adbc9-a5c4-4be2-84a2-c4f00f73a472 Retail     4f48d618-09f7-45dc-a5a4-1433cabbee91 Marketing                Default Marketing device group                Accept all updates from the Azure Sphere Security Service.             False
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- -------------------------

list

Lists all products in the Azure Sphere tenant.

Optional parameters

Parameter Type Description Supported version
-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. Azure Sphere CLI
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
========================================================================================================
6gae21e6-g661-4b01-b935-3c5bf2ba0f72 a323c263-2aa3-2559-aabb-a3fc32631900 DW100     Contoso DW100 models
------------------------------------ ------------------------------------ --------- --------------------
6a82518f-8965-4bd6-ba79-43aa3fcafe5e a323c263-2aa3-2559-aabb-a3fc32631900 DW200     Contoso DW200 models
------------------------------------ ------------------------------------ --------- --------------------

show

Displays details about a product.

Required parameters

Parameter Type Description Supported version
-p, --product GUID or name Specifies the product to get. You can specify either the ID or name of the Azure Sphere product. Azure Sphere CLI
-i, --productid GUID Specifies the ID of the product for which to display details. Either --productid or --productname must be present. Azure Sphere classic CLI
-n, --productname String Specifies the name of the product for which to display details. Either --productid or --productname must be present. Azure Sphere classic CLI

Optional parameters

Parameter Type Description Supported version
-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. Azure Sphere CLI
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 6gae21e6-g661-4b01-b935-3c5bf2ba0f72 --tenant a323c263-2aa3-2559-aabb-a3fc32631900

Example to specify product and tenant by name:

azsphere product show --product DW100 --tenant Tenant1

You should see output like this:

------------------------------------ ------------------------------------ ----- --------------------
Id                                   TenantId                             Name  Description
====================================================================================================
6gae21e6-g661-4b01-b935-3c5bf2ba0f72 a323c263-2aa3-2559-aabb-a3fc32631900 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 Supported version
-p, --product GUID or name Specifies the product to update. You can specify either the ID or name of the Azure Sphere product. Azure Sphere CLI
-i, --productid GUID Specifies the ID of the product to update. Either --productid or --productname must be present. Azure Sphere classic CLI
-n, --productname String Specifies the name of the product to update. Either --productid or --productname must be present. Azure Sphere classic CLI

Optional parameters

Parameter Type Description Supported version
-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. Azure Sphere CLI
-d, --new-description String Specifies optional text to describe the product. The maximum length is 100 characters. Azure Sphere CLI
-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. Azure Sphere CLI
-nn, --newname 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, are case insensitive, and must be unique within a tenant. Azure Sphere classic CLI
-nd, --newdescription String Specifies optional text to describe the product. The maximum length is 100 characters. Azure Sphere classic CLI
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 6gae21e6-g661-4b01-b935-3c5bf2ba0f72 --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 a323c263-2aa3-2559-aabb-a3fc32631900 DW200 Contoso DW200 models
------------------------------------ ------------------------------------ ----- ------------------