az sphere product

Manage products in your resource group and catalog.

Operation	Description
az sphere product create	Create a new product in your resource group and catalog.
az sphere product update	Update a product's details in your resource group and catalog.
az sphere product delete	Delete the specified product.
az sphere product list	List all products in your resource group and catalog.
az sphere product show	Show details of a product in your resource group and catalog.

Commands

az sphere product create

Create a new product in your resource group and catalog.

Required Parameters

Parameter	Description
--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	A description of the product.
--no-default-device-groups	If set, no default device groups will be created for this product.
--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 a new product MyProduct in resource group MyResourceGroup and catalog MyCatalog.

az sphere product create --resource-group MyResourceGroup --catalog MyCatalog --name MyProduct --description MyDescription

Create a new product MyProduct without default device groups in resource group MyResourceGroup and catalog MyCatalog.

az sphere product create --resource-group MyResourceGroup --catalog MyCatalog --name MyProduct --description MyDescription --no-default-device-groups

az sphere product update

Update a product's details in your resource group and catalog.

Required Parameters

Parameter	Description
--product -p	The product name. Values from: az sphere product list
--description -d	The new product description to update the product to.
--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

Update the properties of a product.

az sphere product update --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --description MyDescription

az sphere product delete

Delete the specified 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

Delete a product using resource group, catalog name, and product name.

az sphere product delete --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct

az sphere product list

List all products in your resource group and 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.

Examples

List all products in a resource group and catalog.

az sphere product list --resource-group MyResourceGroup --catalog MyCatalog

az sphere product show

Show details of a product in your resource group and catalog.

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

Show details of a product using resource group, catalog name, and product name.

az sphere product show --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct