PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}/?api-version=2023-09-01
Update an image.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
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. |
imageName |
String | Yes |
The name of the image. |
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 |
|---|---|---|---|
properties |
Object | No |
Describes the properties of an Image. |
properties.provisioningState |
String | No |
The provisioning state. |
properties.storageProfile |
Object | No |
Describes a storage profile. |
properties.storageProfile.dataDisks[] |
Array | No |
Specifies the parameters that are used to add a data disk to a virtual machine. |
properties.storageProfile.dataDisks[].snapshot |
Object | No | |
properties.storageProfile.dataDisks[].snapshot.id |
String | No |
Resource Id |
properties.storageProfile.dataDisks[].caching |
String | No |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. Possible values:
|
properties.storageProfile.dataDisks[].storageAccountType |
String | No |
Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types Possible values:
|
properties.storageProfile.dataDisks[].diskSizeGB |
Integer | No |
Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB. |
properties.storageProfile.dataDisks[].lun |
Integer | Yes |
Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. |
properties.storageProfile.dataDisks[].managedDisk |
Object | No | |
properties.storageProfile.dataDisks[].managedDisk.id |
String | No |
Resource Id |
properties.storageProfile.dataDisks[].blobUri |
String | No |
The Virtual Hard Disk. |
properties.storageProfile.dataDisks[].diskEncryptionSet |
Object | No |
Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. Note: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. |
properties.storageProfile.dataDisks[].diskEncryptionSet.id |
String | No |
Resource Id |
properties.storageProfile.osDisk |
Object | No |
Describes an Operating System disk. |
properties.storageProfile.osDisk.snapshot |
Object | No | |
properties.storageProfile.osDisk.snapshot.id |
String | No |
Resource Id |
properties.storageProfile.osDisk.osType |
String | Yes |
This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows, Linux. Possible values:
|
properties.storageProfile.osDisk.caching |
String | No |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. Possible values:
|
properties.storageProfile.osDisk.storageAccountType |
String | No |
Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types Possible values:
|
properties.storageProfile.osDisk.diskSizeGB |
Integer | No |
Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB. |
properties.storageProfile.osDisk.osState |
String | Yes |
The OS State. For managed images, use Generalized. Possible values:
|
properties.storageProfile.osDisk.managedDisk |
Object | No | |
properties.storageProfile.osDisk.managedDisk.id |
String | No |
Resource Id |
properties.storageProfile.osDisk.blobUri |
String | No |
The Virtual Hard Disk. |
properties.storageProfile.osDisk.diskEncryptionSet |
Object | No |
Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. Note: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. |
properties.storageProfile.osDisk.diskEncryptionSet.id |
String | No |
Resource Id |
properties.storageProfile.zoneResilient |
Boolean | No |
Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS). |
properties.hyperVGeneration |
String | No |
Specifies the HyperVGeneration Type Possible values:
|
properties.sourceVirtualMachine |
Object | No | |
properties.sourceVirtualMachine.id |
String | No |
Resource Id |
tags |
Object | No |
Resource tags |
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.