List, update, and delete gallery resources

Article
05/06/2023

You can manage your Azure Compute Gallery (formerly known as Shared Image Gallery) resources using the Azure CLI or Azure PowerShell.

List galleries shared with you

List Galleries shared with your subscription.

region=chinanorth
az sig list-shared --location $region

List Galleries shared with your tenant.

region=chinanorth
az sig list-shared --location $region --shared-to tenant

The output will contain the public name and uniqueID of the gallery that is shared with you. You can use the name of the gallery to query for images that are available through the gallery.

Here is example output:

[
  {
    "location": "chinanorth",
    "name": "1231b567-8a99-1a2b-1a23-123456789abc-MYDIRECTSHARED",
    "uniqueId": "/SharedGalleries/1231b567-8a99-1a2b-1a23-123456789abc-MYDIRECTSHARED"
  }
]

List galleries shared with a subscription.

GET
https://management.chinacloudapi.cn/subscriptions/{subscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Compute/Locations/{location}/SharedGalleries?api-version=2020-09-30

The response should look similar to this:

{	 
"value": [ 
{ 
"identifier": { 
"uniqueId": "/SharedGalleries/{SharedGalleryUniqueName}"         
}, 
"name": "galleryuniquename1", 
   		"type": "Microsoft. Compute/sharedGalleries", 
   		"location": "location" 
  	}, 
  	{ 
"identifier": { 
"uniqueName": "/SharedGalleries/{SharedGalleryUniqueName}"       
}, 
"name": "galleryuniquename2", 
"type": "Microsoft. Compute/sharedGalleries", 
"location": "location" 
  	} 
], 
}

List the galleries shared with a tenant.

GET
https://management.chinacloudapi.cn/subscriptions/{subscriptionId}/providers/Microsoft.Compute/Locations/{location}/SharedGalleries?api-version=2020-09-30&sharedTo=tenant

The response should look similar to this:

{	 
"value": [ 
{ 
"identifier": { 
"uniqueName": "/SharedGalleries/{SharedGalleryUniqueName}"         
}, 
"name": "galleryuniquename1", 
   		"type": "Microsoft. Compute/sharedGalleries", 
   		"location": "location" 
  	}, 
  	{ 
"identifier": { 
"uniqueName": "/SharedGalleries/{SharedGalleryUniqueName}"       
}, 
"name": "galleryuniquename2", 
"type": "Microsoft. Compute/sharedGalleries", 
"location": "location" 
  	} 
], 
} 

---

## List your gallery information

### [CLI](#tab/cli)

Get the location, status and other information about your image galleries using [az sig list](https://learn.microsoft.com/cli/azure/sig#az-sig-list).

```azurecli 
az sig list -o table

List the image definitions

List the image definitions in your gallery, including information about OS type and status, using az sig image-definition list.

az sig image-definition list --resource-group myGalleryRG --gallery-name myGallery -o table

List image versions

List image versions in your gallery using az sig image-version list:

az sig image-version list --resource-group myGalleryRG --gallery-name myGallery --gallery-image-definition myImageDefinition -o table

Get a specific image version

Get the ID of a specific image version in your gallery using az sig image-version show.

az sig image-version show \
   --resource-group myGalleryRG \
   --gallery-name myGallery \
   --gallery-image-definition myImageDefinition \
   --gallery-image-version 1.0.0 \
   --query "id"

List all galleries by name.

$galleries = Get-AzResource -ResourceType Microsoft.Compute/galleries
$galleries.Name

List all image definitions by name.

$imageDefinitions = Get-AzResource -ResourceType Microsoft.Compute/galleries/images
$imageDefinitions.Name

List all image versions by name.

$imageVersions = Get-AzResource -ResourceType Microsoft.Compute/galleries/images/versions
$imageVersions.Name

Delete an image version. This example deletes the image version named 1.0.0.

Remove-AzGalleryImageVersion `
   -GalleryImageDefinitionName myImageDefinition `
   -GalleryName myGallery `
   -Name 1.0.0 `
   -ResourceGroupName myGalleryRG

Update resources

There are some limitations on what can be updated. The following items can be updated:

Azure Compute Gallery:

Description

Image definition:

Recommended vCPUs
Recommended memory
Description
End of life date

Image version:

Regional replica count
Target regions
Exclusion from latest
End of life date

CLI
PowerShell

Update the description of a gallery using (az sig update.

az sig update \
   --gallery-name myGallery \
   --resource-group myGalleryRG \
   --set description="My updated description."

Update the description of an image definition using az sig image-definition update.

az sig image-definition update \
   --gallery-name myGallery\
   --resource-group myGalleryRG \
   --gallery-image-definition myImageDefinition \
   --set description="My updated description."

Update an image version to add a region to replicate to using az sig image-version update. This change will take a while as the image gets replicated to the new region.

az sig image-version update \
   --resource-group myGalleryRG \
   --gallery-name myGallery \
   --gallery-image-definition myImageDefinition \
   --gallery-image-version 1.0.0 \
   --add publishingProfile.targetRegions  name=chinanorth

This example shows how to use az sig image-version update to exclude this image version from being used as the latest image.

az sig image-version update \
   --resource-group myGalleryRG \
   --gallery-name myGallery \
   --gallery-image-definition myImageDefinition \
   --gallery-image-version 1.0.0 \
   --set publishingProfile.excludeFromLatest=true

This example shows how to use az sig image-version update to include this image version in being considered for latest image.

az sig image-version update \
   --resource-group myGalleryRG \
   --gallery-name myGallery \
   --gallery-image-definition myImageDefinition \
   --gallery-image-version 1.0.0 \
   --set publishingProfile.excludeFromLatest=false

To update the description of a gallery, use Update-AzGallery.

Update-AzGallery `
   -Name $gallery.Name ` 
   -ResourceGroupName $resourceGroup.Name

This example shows how to use Update-AzGalleryImageDefinition to update the end-of-life date for our image definition.

Update-AzGalleryImageDefinition `
   -GalleryName $gallery.Name `
   -Name $galleryImage.Name `
   -ResourceGroupName $resourceGroup.Name `
   -EndOfLifeDate 01/01/2030

This example shows how to use Update-AzGalleryImageVersion to exclude this image version from being used as the latest image.

Update-AzGalleryImageVersion `
   -GalleryImageDefinitionName $galleryImage.Name `
   -GalleryName $gallery.Name `
   -Name $galleryVersion.Name `
   -ResourceGroupName $resourceGroup.Name `
   -PublishingProfileExcludeFromLatest

This example shows how to use Update-AzGalleryImageVersion to include this image version in being considered for latest image.

Update-AzGalleryImageVersion `
   -GalleryImageDefinitionName $galleryImage.Name `
   -GalleryName $gallery.Name `
   -Name $galleryVersion.Name `
   -ResourceGroupName $resourceGroup.Name `
   -PublishingProfileExcludeFromLatest:$false

Delete resources

You have to delete resources in reverse order, by deleting the image version first. After you delete all of the image versions, you can delete the image definition. After you delete all image definitions, you can delete the gallery.

CLI
PowerShell

Before you can delete a community shared gallery, you need to use az sig share reset to stop sharing the gallery publicly.

Delete an image version using az sig image-version delete.

az sig image-version delete \
   --resource-group myGalleryRG \
   --gallery-name myGallery \
   --gallery-image-definition myImageDefinition \
   --gallery-image-version 1.0.0

Delete an image definition using az sig image-definition delete.

az sig image-definition delete \
   --resource-group myGalleryRG \
   --gallery-name myGallery \
   --gallery-image-definition myImageDefinition

Delete a gallery using az sig delete.

az sig delete \
   --resource-group myGalleryRG \
   --gallery-name myGallery

$resourceGroup = "myResourceGroup"
$gallery = "myGallery"
$imageDefinition = "myImageDefinition"
$imageVersion = "myImageVersion"

Remove-AzGalleryImageVersion `
   -GalleryImageDefinitionName $imageDefinition `
   -GalleryName $gallery `
   -Name $imageVersion `
   -ResourceGroupName $resourceGroup

Remove-AzGalleryImageDefinition `
   -ResourceGroupName $resourceGroup `
   -GalleryName $gallery `
   -GalleryImageDefinitionName $imageDefinition

Remove-AzGallery `
   -Name $gallery `
   -ResourceGroupName $resourceGroup

Remove-AzResourceGroup -Name $resourceGroup

Next steps

Create an image definition and an image version.
Create a VM from a generalized or specialized image in an Azure Compute Gallery.

List, update, and delete gallery resources

List galleries shared with you

Update resources

Delete resources

Additional resources