az sphere deployment
Manage deployments in your resource group and catalog.
| Operation | Description |
|---|---|
| az sphere deployment show | Show details of a deployment. |
| az sphere deployment list | List all deployments. |
| az sphere deployment create | Create a deployment. |
Commands
az sphere deployment show
Show details of a deployment.
Required Parameters
| Parameter | Description |
|---|---|
| --deployment-id -di | The deployment ID. |
| --product -p | The product name. Values from: az sphere product list |
| --device-group -dg | The device group to show. Values from: az sphere device |
| --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 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
az sphere deployment list
List all deployments.
Required Parameters
| Parameter | Description |
|---|---|
| --product -p | The product name. Values from: az sphere product list |
| --device-group -dg | The device group to show. Values from: az sphere device |
| --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 deployments in a resource group, catalog, product, and device group.
az sphere deployment list --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup
az sphere deployment create
Create a deployment.
Required Parameters
| Parameter | Description |
|---|---|
| --product -p | The product name. Values from: az sphere product list |
| --device-group -dg | The device group to show. Values from: az sphere device |
| --images -i | Space-separated list of images to deploy. Values from: az sphere image 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
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