PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}/?api-version=2022-08-03
Update a gallery image version.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
galleryName |
String | Yes |
The name of the Shared Image Gallery in which the Image Definition resides. |
galleryImageVersionName |
String | Yes |
The name of the gallery image version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. |
subscriptionId |
String | Yes |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
resourceGroupName |
String | Yes |
The name of the resource group. |
galleryImageName |
String | Yes |
The name of the gallery image definition in which the Image Version is to be updated. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Resource Id |
name |
String | No |
Resource name |
properties |
Object | No |
Describes the properties of a gallery image version. |
properties.safetyProfile |
Object | No |
This is the safety profile of the Gallery Image Version. |
properties.safetyProfile.allowDeletionOfReplicatedLocations |
Boolean | No |
Indicates whether or not removing this Gallery Image Version from replicated regions is allowed. |
properties.safetyProfile.reportedForPolicyViolation |
Boolean | No |
Indicates whether this image has been reported as violating Microsoft's policies. |
properties.safetyProfile.policyViolations[] |
Array | No |
A list of Policy Violations that have been reported for this Gallery Image Version. |
properties.safetyProfile.policyViolations[].category |
String | No |
Describes the nature of the policy violation. Possible values:
|
properties.safetyProfile.policyViolations[].details |
String | No |
Describes specific details about why this policy violation was reported. |
properties.securityProfile |
Object | No |
The security profile of a gallery image version |
properties.securityProfile.uefiSettings |
Object | No |
Contains UEFI settings for the image version. |
properties.securityProfile.uefiSettings.signatureTemplateNames[] |
Array | No |
The name of the template(s) that contains default UEFI key signatures that will be added to the image. |
properties.securityProfile.uefiSettings.additionalSignatures |
Object | No |
Additional UEFI key signatures that will be added to the image in addition to the signature templates |
properties.securityProfile.uefiSettings.additionalSignatures.pk |
Object | No |
A UEFI key signature. |
properties.securityProfile.uefiSettings.additionalSignatures.pk.type |
String | No |
The type of key signature. Possible values:
|
properties.securityProfile.uefiSettings.additionalSignatures.pk.value[] |
Array | No |
The value of the key signature. |
properties.securityProfile.uefiSettings.additionalSignatures.db[] |
Array | No |
The database of UEFI keys for this image version. |
properties.securityProfile.uefiSettings.additionalSignatures.db[].type |
String | No |
The type of key signature. Possible values:
|
properties.securityProfile.uefiSettings.additionalSignatures.db[].value[] |
Array | No |
The value of the key signature. |
properties.securityProfile.uefiSettings.additionalSignatures.kek[] |
Array | No |
The Key Encryption Keys of this image version. |
properties.securityProfile.uefiSettings.additionalSignatures.kek[].type |
String | No |
The type of key signature. Possible values:
|
properties.securityProfile.uefiSettings.additionalSignatures.kek[].value[] |
Array | No |
The value of the key signature. |
properties.securityProfile.uefiSettings.additionalSignatures.dbx[] |
Array | No |
The database of revoked UEFI keys for this image version. |
properties.securityProfile.uefiSettings.additionalSignatures.dbx[].type |
String | No |
The type of key signature. Possible values:
|
properties.securityProfile.uefiSettings.additionalSignatures.dbx[].value[] |
Array | No |
The value of the key signature. |
properties.provisioningState |
String | No |
The provisioning state, which only appears in the response. Possible values:
|
properties.replicationStatus |
Object | No |
This is the replication status of the gallery image version. |
properties.replicationStatus.aggregatedState |
String | No |
This is the aggregated replication status based on all the regional replication status flags. Possible values:
|
properties.replicationStatus.summary[] |
Array | No |
This is a summary of replication status for each region. |
properties.replicationStatus.summary[].region |
String | No |
The region to which the gallery image version is being replicated to. |
properties.replicationStatus.summary[].progress |
Integer | No |
It indicates progress of the replication job. |
properties.replicationStatus.summary[].state |
String | No |
This is the regional replication state. Possible values:
|
properties.replicationStatus.summary[].details |
String | No |
The details of the replication status. |
properties.storageProfile |
Object | Yes |
This is the storage profile of a Gallery Image Version. |
properties.storageProfile.source |
Object | No |
The source of the gallery artifact version. |
properties.storageProfile.source.id |
String | No |
The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource. |
properties.storageProfile.source.communityGalleryImageId |
String | No |
The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. |
properties.storageProfile.osDiskImage |
Object | No |
This is the OS disk image. |
properties.storageProfile.osDiskImage.sizeInGB |
Integer | No |
This property indicates the size of the VHD to be created. |
properties.storageProfile.osDiskImage.source |
Object | No |
The source for the disk image. |
properties.storageProfile.osDiskImage.source.uri |
String | No |
The uri of the gallery artifact version source. Currently used to specify vhd/blob source. |
properties.storageProfile.osDiskImage.source.id |
String | No |
The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource. |
properties.storageProfile.osDiskImage.source.storageAccountId |
String | No |
The Storage Account Id that contains the vhd blob being used as a source for this artifact version. |
properties.storageProfile.osDiskImage.hostCaching |
String | No |
The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' Possible values:
|
properties.storageProfile.dataDiskImages[] |
Array | No |
A list of data disk images. |
properties.storageProfile.dataDiskImages[].sizeInGB |
Integer | No |
This property indicates the size of the VHD to be created. |
properties.storageProfile.dataDiskImages[].source |
Object | No |
The source for the disk image. |
properties.storageProfile.dataDiskImages[].source.uri |
String | No |
The uri of the gallery artifact version source. Currently used to specify vhd/blob source. |
properties.storageProfile.dataDiskImages[].source.id |
String | No |
The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource. |
properties.storageProfile.dataDiskImages[].source.storageAccountId |
String | No |
The Storage Account Id that contains the vhd blob being used as a source for this artifact version. |
properties.storageProfile.dataDiskImages[].lun |
Integer | Yes |
This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. |
properties.storageProfile.dataDiskImages[].hostCaching |
String | No |
The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' Possible values:
|
properties.publishingProfile |
Object | No |
The publishing profile of a gallery image Version. |
properties.publishingProfile.endOfLifeDate |
String | No |
The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable. |
properties.publishingProfile.targetRegions[] |
Array | No |
The target regions where the Image Version is going to be replicated to. This property is updatable. |
properties.publishingProfile.targetRegions[].name |
String | Yes |
The name of the region. |
properties.publishingProfile.targetRegions[].regionalReplicaCount |
Integer | No |
The number of replicas of the Image Version to be created per region. This property is updatable. |
properties.publishingProfile.targetRegions[].storageAccountType |
String | No |
Specifies the storage account type to be used to store the image. This property is not updatable. Possible values:
|
properties.publishingProfile.targetRegions[].excludeFromLatest |
Boolean | No |
Contains the flag setting to hide an image when users specify version='latest' |
properties.publishingProfile.targetRegions[].encryption |
Object | No |
Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. |
properties.publishingProfile.targetRegions[].encryption.osDiskImage |
Object | No |
Contains encryption settings for an OS disk image. |
properties.publishingProfile.targetRegions[].encryption.osDiskImage.diskEncryptionSetId |
String | No |
A relative URI containing the resource ID of the disk encryption set. |
properties.publishingProfile.targetRegions[].encryption.osDiskImage.securityProfile |
Object | No |
Contains security profile for an OS disk image. |
properties.publishingProfile.targetRegions[].encryption.osDiskImage.securityProfile.secureVMDiskEncryptionSetId |
String | No |
secure VM disk encryption set id |
properties.publishingProfile.targetRegions[].encryption.osDiskImage.securityProfile.confidentialVMEncryptionType |
String | No |
confidential VM encryption types Possible values:
|
properties.publishingProfile.targetRegions[].encryption.dataDiskImages[] |
Array | No |
A list of encryption specifications for data disk images. |
properties.publishingProfile.targetRegions[].encryption.dataDiskImages[].diskEncryptionSetId |
String | No |
A relative URI containing the resource ID of the disk encryption set. |
properties.publishingProfile.targetRegions[].encryption.dataDiskImages[].lun |
Integer | Yes |
This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. |
properties.publishingProfile.targetExtendedLocations[] |
Array | No |
The target extended locations where the Image Version is going to be replicated to. This property is updatable. |
properties.publishingProfile.targetExtendedLocations[].extendedLocation |
Object | No |
The name of the extended location. |
properties.publishingProfile.targetExtendedLocations[].extendedLocation.name |
String | No | |
properties.publishingProfile.targetExtendedLocations[].extendedLocation.type |
String | No |
It is type of the extended location. Possible values:
|
properties.publishingProfile.targetExtendedLocations[].name |
String | No |
The name of the region. |
properties.publishingProfile.targetExtendedLocations[].storageAccountType |
String | No |
Specifies the storage account type to be used to store the image. This property is not updatable. Possible values:
|
properties.publishingProfile.targetExtendedLocations[].extendedLocationReplicaCount |
Integer | No |
The number of replicas of the Image Version to be created per extended location. This property is updatable. |
properties.publishingProfile.targetExtendedLocations[].encryption |
Object | No |
Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. |
properties.publishingProfile.targetExtendedLocations[].encryption.osDiskImage |
Object | No |
Contains encryption settings for an OS disk image. |
properties.publishingProfile.targetExtendedLocations[].encryption.osDiskImage.diskEncryptionSetId |
String | No |
A relative URI containing the resource ID of the disk encryption set. |
properties.publishingProfile.targetExtendedLocations[].encryption.osDiskImage.securityProfile |
Object | No |
Contains security profile for an OS disk image. |
properties.publishingProfile.targetExtendedLocations[].encryption.osDiskImage.securityProfile.secureVMDiskEncryptionSetId |
String | No |
secure VM disk encryption set id |
properties.publishingProfile.targetExtendedLocations[].encryption.osDiskImage.securityProfile.confidentialVMEncryptionType |
String | No |
confidential VM encryption types Possible values:
|
properties.publishingProfile.targetExtendedLocations[].encryption.dataDiskImages[] |
Array | No |
A list of encryption specifications for data disk images. |
properties.publishingProfile.targetExtendedLocations[].encryption.dataDiskImages[].diskEncryptionSetId |
String | No |
A relative URI containing the resource ID of the disk encryption set. |
properties.publishingProfile.targetExtendedLocations[].encryption.dataDiskImages[].lun |
Integer | Yes |
This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. |
properties.publishingProfile.excludeFromLatest |
Boolean | No |
If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. |
properties.publishingProfile.publishedDate |
String | No |
The timestamp for when the gallery image version is published. |
properties.publishingProfile.storageAccountType |
String | No |
Specifies the storage account type to be used to store the image. This property is not updatable. Possible values:
|
properties.publishingProfile.replicaCount |
Integer | No |
The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable. |
properties.publishingProfile.replicationMode |
String | No |
Optional parameter which specifies the mode to be used for replication. This property is not updatable. Possible values:
|
tags |
Object | No |
Resource tags |
type |
String | No |
Resource type |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.