Share via

az sphere product

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 product command. Learn more about extensions.

Manage products in your resource group and catalog.

Commands

Name Description Type Status
az sphere product create

Create a new product in your resource group and catalog.

 Extension GA
az sphere product delete

Delete the specified product.

 Extension GA
az sphere product list

List all products in your resource group and catalog.

 Extension GA
az sphere product show

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

 Extension GA
az sphere product update

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

 Extension GA

az sphere product create

Create a new product in your resource group and catalog.

az sphere product create --catalog
                         --description
                         --name
                         --resource-group
                         [--no-default-device-groups]

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

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

A description of the product.

--name -n

Alphanumeric name of the product.

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

--no-default-device-groups

If set, no default device groups will be created for this product.

Property Value
Default value: False
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 product delete

Delete the specified product.

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

Examples

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

az sphere product delete --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 product list

List all products in your resource group and catalog.

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

Examples

List all products in a resource group and catalog.

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

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.

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 product show

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

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

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

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 product update

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

az sphere product update --catalog
                         --description
                         --product
                         --resource-group

Examples

Update the properties of a product.

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

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

The new product description to update the product to.

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