Share via

az sphere deployment

  • Reference

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

Manage deployments in your resource group and catalog.

Commands

Name Description Type Status
az sphere deployment create

Create a deployment.

 Extension GA
az sphere deployment list

List all deployments.

 Extension GA
az sphere deployment show

Show details of a deployment.

 Extension GA

az sphere deployment create

Create a deployment.

az sphere deployment create --catalog
                            --device-group
                            --images
                            --product
                            --resource-group

Examples

Create a new deployment with image in resource group "MyResourceGroup", catalog "MyCatalog", product "MyProduct", and device group "MyDeviceGroup".

az sphere deployment create --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup --images 25b91eed-1996-4049-ab9f-70982b87ad58

Create a new deployment with images in resource group "MyResourceGroup", catalog "MyCatalog", product "MyProduct", and device group "MyDeviceGroup".

az sphere deployment create --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup --images 25b91eed-1996-4049-ab9f-70982b87ad58 48ecb7b3-c296-49cb-8dec-5fdaea0abb62

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.

--device-group -dg

The device group name.

value from: az sphere device-group list
--images -i

Space-separated list of images to deploy.

value from: az sphere image list
--product -p

The product in which to create a deployment.

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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az sphere deployment list

List all deployments.

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

Examples

List all deployments in a resource group, catalog, product, and device group.

az sphere deployment list --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup

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.

--device-group -dg

The device group name.

value from: az sphere device-group list
--product -p

The product in which to list deployments.

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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az sphere deployment show

Show details of a deployment.

az sphere deployment show --catalog
                          --deployment-id
                          --device-group
                          --product
                          --resource-group

Examples

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

az sphere deployment show --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup --deployment-id 5422a862-cfc7-4cb8-a2d7-7ba71873b7b6

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.

--deployment-id -di

The deployment ID.

--device-group -dg

The device group name.

value from: az sphere device-group list
--product -p

The product in which to list deployments.

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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.