Manage products
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.
A product identifies an Azure Sphere MCU that is incorporated into a connected device to perform a specific function. As the manufacturer, you create a product for each model of a connected device, such as a dishwasher or coffeemaker. For example, Contoso creates a product for its DW100 dishwashers and assigns this product to each DW100 dishwasher during manufacturing. Each product has a GUID that is unique within the tenant and cannot be changed.
Every connected device has a single product, but a single product can be associated with many devices. Each product has a name that must be unique within its tenant, along with a description. The product name and description provide a human-readable way to distinguish one product from another. The name and description of the product can be modified as often as you wish.
List products
List all products in your Azure Sphere tenant using the azsphere product list command or by using the Azure Sphere Public API.
To list all products:
azsphere product list
A message may be displayed if the default tenant is not selected. Select the required tenant from the list and retry the command.
To list all products in an Azure Sphere tenant:
Select the Azure Sphere Explorer icon in Visual Studio Code's Activity Bar to open Azure Sphere Explorer. If the Tenant pane shows Log in to see tenants, log in to Azure Sphere and select Refresh to see the available tenants.
Expand the tenant you are interested in.
Expand the product node.
Select View > Other Windows > Azure Sphere Explorer to open Azure Sphere Explorer. If the Tenant pane shows Log in to see tenants, log in to Azure Sphere and select Refresh to see the available tenants.
Expand the tenant you are interested in.
Expand the product node.
Create a product
Create a product in your Azure Sphere tenant using the azsphere product create command or by using the Azure Sphere Public API.
To create a product:
azsphere product create --name <product-name>
Replace <product-name> with a human-readable name for your product, such as DW100. Names for products can contain only alphanumeric characters and spaces. They cannot exceed 50 characters. If either the name or description includes spaces, enclose it in quotation marks.
By default, when you create a new product, Azure Sphere automatically creates five device groups for use in creating deployments. The five default device groups are Development, Field Test, Production, Field Test OS Evaluation, and Production OS Evaluation. To create the product without the default device groups use the command:
azsphere product create --name <product-name> --no-default-device-groups
A tenant may contain many products, it can be useful to provide a description of each one. You can add a description to a product as follows:
azsphere product create --name <product-name> --description <product-description>
To create a product:
For the tenant you are interested in, right-click the Product node and select New Product.
Specify a name for the product and press Enter. Names for products can contain only alphanumeric characters and spaces. They cannot exceed 50 characters. If you specify an invalid name, an error is reported in the Output window.
When you create a product in Azure Sphere Explorer, the five default device groups are automatically created. If you want to create a product without device groups, use the azsphere product create command or the Azure Sphere Public API and specify --no-default-device-groups.
You can create a product in Azure Sphere Explorer, but not delete it. To delete products, use the azsphere product delete command or the Azure Sphere Public API.
To create a product:
For the tenant you are interested in, right-click the Product node and select New Product.
Specify a name for the product and then press Enter or click Apply. Names for products can contain only alphanumeric characters and spaces. They cannot exceed 50 characters. If you specify an invalid name, an error is reported in the Output window.
When you create a product in Azure Sphere Explorer, the five default device groups are automatically created. If you want to create a product without device groups, use the azsphere product create command or the Azure Sphere Public API and specify --no-default-device-groups.
You can create a product in Azure Sphere Explorer, but not delete it. To delete products, use the azsphere product delete command or the Azure Sphere Public API.
Update a product
Modify a product's name or description at any time using the azsphere product update command or by using the Azure Sphere Public API. To update a product's name and description:
azsphere product update --product <product-name> --new-name <new-product-name> --new-description <new-product-description>
Delete a product
Delete a product at any time using the azsphere product delete command or by using the Azure Sphere Public API.
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.
To delete a product:
azsphere product delete --product <product-name>
For the tenant you are interested in, expand the Product node.
To rename the product, right-click the product name and select Rename, specify a new product name, and then press Enter.
To update the description, right-click the product name and select Update Description, specify a new description, and then press Enter.
For the tenant you are interested in, expand the Product node.
To rename the product, select the product name and press F2 or right-click the product name and select Rename, specify a new product name, and then press Enter or click Apply.
To update the description, expand the product, select Description and press F2 or right-click Description and select Modify, specify a new description, and then press Enter or click Apply.
Show product details
View the details of a product in your tenant using the azsphere product show command or by using the Azure Sphere Public API.
azsphere product show --product <product-name>
To view the details of a product in your tenant:
Select the Azure Sphere Explorer icon in Visual Studio Code's Activity Bar to open Azure Sphere Explorer. If the Tenant pane shows Log in to see tenants, log in to Azure Sphere and select Refresh to see the available tenants.
For the tenant you are interested in, expand the Product node.
Expand the product you are interested in.
Select View > Other Windows > Azure Sphere Explorer to open Azure Sphere Explorer. If the Tenant pane shows Log in to see tenants, log in to Azure Sphere and select Refresh to see the available tenants.
For the tenant you are interested in, expand the Product node.
Expand the product you are interested in.