az sig image-version

Commands

Name	Description	Type	Status
az sig image-version create	Create a new image version.	Core	GA
az sig image-version delete	Delete a gallery image version.	Core	GA
az sig image-version list	List gallery image versions in a gallery image definition.	Core	GA
az sig image-version list-community	List VM Image Versions in a gallery community.	Core	GA
az sig image-version list-community (image-gallery extension)	List VM Image Versions in a gallery community (preview).	Extension	Experimental
az sig image-version list-shared	List VM Image Versions in a gallery shared directly to your subscription or tenant.	Core	GA
az sig image-version show	Get information about a gallery image version.	Core	GA
az sig image-version show-community	Get a community gallery image version.	Core	GA
az sig image-version show-community (image-gallery extension)	Get an image version in a gallery community (preview).	Extension	Experimental
az sig image-version show-shared	Get an image version in a gallery shared directly to your subscription or tenant.	Core	GA
az sig image-version undelete	Restore soft deleted Image Version.	Core	Preview
az sig image-version update	Update a share image version.	Core	GA
az sig image-version wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az sig image-version create --gallery-image-definition
                            --gallery-image-version
                            --gallery-name
                            --resource-group
                            [--allow-replicated-location-deletion {false, true}]
                            [--block-delete-before-eol --block-deletion-before-end-of-life {false, true}]
                            [--data-snapshot-luns]
                            [--data-snapshots]
                            [--data-vhds-luns]
                            [--data-vhds-sa --data-vhds-storage-accounts]
                            [--data-vhds-uris]
                            [--end-of-life-date]
                            [--exclude-from-latest {false, true}]
                            [--image-version]
                            [--location]
                            [--managed-image]
                            [--no-wait]
                            [--os-snapshot]
                            [--os-vhd-storage-account]
                            [--os-vhd-uri]
                            [--replica-count]
                            [--replication-mode]
                            [--storage-account-type {Premium_LRS, Standard_LRS, Standard_ZRS}]
                            [--tags]
                            [--target-edge-zone-encryption --zone-encryption]
                            [--target-edge-zones]
                            [--target-region-cvm-encryption]
                            [--target-region-encryption]
                            [--target-regions]
                            [--virtual-machine]

Examples

Add a new image version from a virtual machine

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--virtual-machine /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/virtualMachines/MyVM

Add a new image version from a managed image

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--managed-image /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/images/MyManagedImage

Add a new image version from another image version

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--image-version /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/galleries/MyGallery/images/MyImageDefinition/versions/1.0.0

Add a new image version from a managed disk

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--os-snapshot /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/disks/MyOSDisk

Add a new image version from a managed disk and add additional data disks

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--os-snapshot /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/disks/MyOSDisk \
--data-snapshots /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/disks/MyDataDisk \
--data-snapshot-luns 0

Add a new image version from a snapshot of an OS disk.

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--os-snapshot /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/snapshots/MyOsDiskSnapshot

Add a new image version from a snapshot of an OS disk and add additional snapshots as data disks

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--os-snapshot /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/snapshots/MyOsDiskSnapshot \
--data-snapshots /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/snapshots/MyDiskSnapshot \
--data-snapshot-luns 0

Add a new image version from a VHD of an OS disk.

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--os-vhd-storage-account /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Storage/storageAccounts/mystorageaccount \
--os-vhd-uri https://mystorageaccount.blob.core.windows.net/container/path_to_vhd_file

Add a new image version from a VHD of an OS disk and add additional VHDs as data disks

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--os-vhd-storage-account /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Storage/storageAccounts/mystorageaccount \
--os-vhd-uri https://mystorageaccount.blob.core.windows.net/container/path_to_vhd_file \
--data-vhds-sa /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Storage/storageAccounts/myotherstorageaccount \
--data-vhds-uris https://myotherstorageaccount.blob.core.windows.net/container/path_to_vhd_file \
--data-vhds-luns 0

You can combine snapshots, managed disks, and VHDs to create a new image version. Add a new image version using a VHD as the OS disk and a managed disk and a snapshot as data disks.

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--os-vhd-storage-account /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Storage/storageAccounts/mystorageaccount \
--os-vhd-uri https://mystorageaccount.blob.core.windows.net/container/path_to_vhd_file \
--data-snapshots /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/disks/MyDataDisk subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/snapshots/MyDiskSnapshot \
--data-snapshot-luns 0 1

Add a new image version and copy it to additional regions. The home location for the source of the image version must be included in the list of target regions. For each additional region, you can specify a different replica count and storage account type. Otherwise, the region will inherit from the global. The default replica count is 1 and the default storage account type is Standard LRS. In this example, eastus2 will have one replica stored on Standard ZRS storage, ukwest will have 3 replicas stored on Standard ZRS storage, southindia will have one replica stored on Standard LRS storage, and brazilsouth will have 2 replicas stored on Standard LRS storage.

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 --replica-count 1 \
--storage-account-type Standard_ZRS --managed-image image-name \
--target-regions eastus2 ukwest=3 southindia=standard_lrs \
brazilsouth=2=standard_lrs

Add a new image version with encryption using a disk encryption set. Encryption is applied to each disk that is a part of the image version.

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--virtual-machine /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/virtualMachines/MyVM \
--target-regions westus=2=standard eastus \
--target-region-encryption WestUSDiskEncryptionSet1,0,WestUSDiskEncryptionSet2 \
EastUSDiskEncryptionSet1,0,EastUSDiskEncryptionSet2

Add a new image version and copy it to extended locations.

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 --replica-count 1 \
--storage-account-type Standard_ZRS --managed-image image-name \
--target-edge-zones westus=microsoftlosangeles1 eastus=microsoftlosangeles2=1 \
brazilsouth=2=standard_lrs

Add a new image version and copy it to extended locations with encryption using a disk encryption set.

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--virtual-machine /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/virtualMachines/MyVM \
--target-edge-zones westus=microsoftlosangeles1 \
--target-edge-zone-encryption microsoftlosangeles1,WestUSDiskEncryptionSet1,0,WestUSDiskEncryptionSet2

Add a new image version and don't wait on it. Later you can invoke "az sig image-version wait" command when ready to create a vm from the gallery image version

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--virtual-machine /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/virtualMachines/MyVM \
--no-wait

Add a new image version but remove it from consideration as latest version in its image definition

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--virtual-machine /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/virtualMachines/MyVM \
--exclude-from-latest true

Add a new image version and set its end-of-life date. The image version can still be used to create a virtual machine after its end-of-life date.

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--virtual-machine /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/virtualMachines/MyVM \
--end-of-life-date 2024-08-02T00:00:00+00:00

Add a new image version and block the deletion for this image version if its end of life has not expired

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--virtual-machine /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/virtualMachines/MyVM \
--end-of-life-date 2024-08-02T00:00:00+00:00 \
--block-deletion-before-end-of-life true

Required Parameters

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az sig image-version delete [--gallery-image-definition --gallery-image-name]
                            [--gallery-image-version --gallery-image-version-name]
                            [--gallery-name]
                            [--ids]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--resource-group]
                            [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sig image-version list --gallery-image-definition --gallery-image-name
                          --gallery-name
                          --resource-group
                          [--max-items]
                          [--next-token]

Required Parameters

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az sig image-version list-community --gallery-image-definition
                                    --location
                                    --public-gallery-name
                                    [--max-items]
                                    [--next-token]

Examples

List an image versions in a gallery community.

az sig image-version list-community --public-gallery-name publicGalleryName --gallery-image-definition MyImage --location myLocation

Required Parameters

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az sig image-version list-community [--gallery-image-definition]
                                    [--ids]
                                    [--location]
                                    [--marker]
                                    [--public-gallery-name]
                                    [--show-next-marker]
                                    [--subscription]

Examples

List an image versions in a gallery community.

az sig image-version list-community --public-gallery-name publicGalleryName \
--gallery-image-definition MyImage --location myLocation

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sig image-version list-shared --gallery-image-definition
                                 --gallery-unique-name
                                 --location
                                 [--max-items]
                                 [--next-token]
                                 [--shared-to {tenant}]

Examples

List image versions in a gallery shared directly to your subscription in the given location and image definition.

az sig image-version list-shared --gallery-unique-name galleryUniqueName --gallery-image-definition MyImage --location myLocation

List image versions in a gallery shared directly to your tenant in the given location and image definition.

az sig image-version list-shared --gallery-unique-name galleryUniqueName --gallery-image-definition MyImage --location myLocation --shared-to tenant

Required Parameters

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az sig image-version show [--expand {ReplicationStatus, UefiSettings}]
                          [--gallery-image-definition]
                          [--gallery-image-version --gallery-image-version-name]
                          [--gallery-name]
                          [--ids]
                          [--resource-group]
                          [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sig image-version show-community [--gallery-image-definition --gallery-image-name]
                                    [--gallery-image-version --gallery-image-version-name]
                                    [--ids]
                                    [--location]
                                    [--public-gallery-name]
                                    [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sig image-version show-community [--gallery-image-definition]
                                    [--gallery-image-version]
                                    [--ids]
                                    [--location]
                                    [--public-gallery-name]
                                    [--subscription]

Examples

Get an image version in a gallery community in the given location.

az sig image-version show-community --public-gallery-name publicGalleryName \
--gallery-image-definition MyImage --gallery-image-version 1.0.0 --location myLocation

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sig image-version show-shared [--gallery-image-definition --gallery-image-name]
                                 [--gallery-image-version --gallery-image-version-name]
                                 [--gallery-unique-name]
                                 [--ids]
                                 [--location]
                                 [--subscription]

Examples

Get an image version in a gallery shared directly to your subscription or tenant in the given location.

az sig image-version show-shared --gallery-unique-name galleryUniqueName --gallery-image-definition MyImage --gallery-image-version 1.0.0 --location myLocation

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sig image-version undelete --gallery-image-definition
                              --gallery-image-version
                              --gallery-name
                              --resource-group
                              [--allow-replicated-location-deletion {false, true}]
                              [--location]
                              [--no-wait]
                              [--tags]

Examples

Restore a soft deleted Image Version

az sig image-version undelete --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.1.1

Required Parameters

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az sig image-version update --gallery-image-definition
                            --gallery-image-version
                            --gallery-name
                            --resource-group
                            [--add]
                            [--allow-replicated-location-deletion {false, true}]
                            [--block-delete-before-eol --block-deletion-before-end-of-life {false, true}]
                            [--force-string]
                            [--no-wait]
                            [--remove]
                            [--replica-count]
                            [--set]
                            [--target-edge-zones]
                            [--target-regions]

Examples

Change the replication regions and replica count

az sig image-version update --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--target-regions westcentralus=2 eastus2

Change the replication extended locations

az sig image-version update --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--target-edge-zones westus=microsoftlosangeles1 eastus=microsoftlosangeles2=1

Clear the replication extended locations

az sig image-version update --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--target-edge-zones None

Replicate to an additional region. Optional, you can set the replica count for the region and exclude this image when using the latest version of the image definition.

az sig image-version update --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--add publishingProfile.targetRegions name=westcentralus \
regionalReplicaCount=3 excludeFromLatest=true

Change whether an image should be included in consideration for latest version in the image definition. Setting this value to true excludes the image from consideration and setting this value to false includes the image for consideration.

az sig image-version update -g MyResourceGroup --gallery-name MyGallery \
--gallery-image-definition MyImage --gallery-image-version 1.0.0 \
--set publishingProfile.excludeFromLatest=true

Change the end of life date for an image version. The image can still be used to create virtual machines after the end of life date.

az sig image-version update -g MyResourceGroup --gallery-name MyGallery \
--gallery-image-definition MyImage --gallery-image-version 1.0.0 \
--set publishingProfile.endOfLifeDate=2024-08-02T00:00:00+00:00

Allow to remove the gallery image version from replicated regions.

az sig image-version update -g MyResourceGroup --gallery-name MyGallery \
--gallery-image-definition MyImage --gallery-image-version 1.0.0 \
--set safetyProfile.allowDeletionOfReplicatedLocations=true

Block the deletion for this gallery image version if its end of life has not expired.

az sig image-version update -g MyResourceGroup --gallery-name MyGallery \
--gallery-image-definition MyImage --gallery-image-version 1.0.0 \
--block-deletion-before-end-of-life true

Required Parameters

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az sig image-version wait [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--expand {ReplicationStatus, UefiSettings}]
                          [--gallery-image-definition]
                          [--gallery-image-version --gallery-image-version-name]
                          [--gallery-name]
                          [--ids]
                          [--interval]
                          [--resource-group]
                          [--subscription]
                          [--timeout]
                          [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False