This browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
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. |
Show details of an existing image from your catalog.
| 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. |
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
List all images in your resource group and catalog.
| 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. |
List all images in a resource group and catalog.
az sphere image list --resource-group MyResourceGroup --catalog MyCatalog
Add an image to your catalog from your local machine.
| 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. |
| Parameter | Description |
|---|---|
| --regional-data-boundary -r | Regional data boundary for this image. |
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
Training
Module
Create and manage session host image for Azure Virtual Desktop - Training
A Shared Image Gallery simplifies custom image sharing across your organization. Custom images can be used to bootstrap deployment tasks like preloading applications, application configurations, and other OS configurations.