Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Manage images in your resource group and catalog.
| Operation | Description |
|---|---|
| az sphere image show | Show details of an existing image from your catalog. |
| az sphere image list | List all images in your resource group and catalog. |
| az sphere image add | Add an image to your catalog from your local machine. |
Commands
az sphere image show
Show details of an existing image from your catalog.
Required Parameters
| Parameter | Description |
|---|---|
| --image | The image ID. 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 -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. |
Examples
Show details of an image using resource group, catalog name, and image ID.
az sphere image show --resource-group MyResourceGroup --catalog MyCatalog --image adb44b96-2642-4643-8c30-5f681f466425
az sphere image list
List all images in your resource group and catalog.
Required Parameters
| Parameter | Description |
|---|---|
| --image-path -img | Path to a local image file. |
| --regional-data-boundary -r | Regional data boundary for this image. |
| --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. |
Examples
List all images in a resource group and catalog.
az sphere image list --resource-group MyResourceGroup --catalog MyCatalog
az sphere image add
Add an image to your catalog from your local machine.
Required Parameters
| Parameter | Description |
|---|---|
| --image-path -img | Path to a local image file. |
| --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. |
Optional Parameters
| Parameter | Description |
|---|---|
| --regional-data-boundary -r | Regional data boundary for this image. |
Examples
Add a new image in resource group MyResourceGroup and catalog MyCatalog.
az sphere image add --resource-group MyResourceGroup --catalog MyCatalog --image-path MyImage.imagepackage
Add a new image in resource group MyResourceGroup, catalog MyCatalog, and Regional data boundary EU.
az sphere image add --resource-group MyResourceGroup --catalog MyCatalog --image-path MyImage.imagepackage --regional-data-boundary EU