PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/?api-version=2022-08-03
Update a gallery image definition.
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 is to be updated. |
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 to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. |
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 definition. |
properties.endOfLifeDate |
String | No |
The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. |
properties.releaseNoteUri |
String | No |
The release note uri. |
properties.description |
String | No |
The description of this gallery image definition resource. This property is updatable. |
properties.recommended |
Object | No |
The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. |
properties.recommended.memory |
Object | No |
Describes the resource range. |
properties.recommended.memory.min |
Integer | No |
The minimum number of the resource. |
properties.recommended.memory.max |
Integer | No |
The maximum number of the resource. |
properties.recommended.vCPUs |
Object | No |
Describes the resource range. |
properties.recommended.vCPUs.min |
Integer | No |
The minimum number of the resource. |
properties.recommended.vCPUs.max |
Integer | No |
The maximum number of the resource. |
properties.architecture |
String | No |
The architecture of the image. Applicable to OS disks only. Possible values:
|
properties.purchasePlan |
Object | No |
Describes the gallery image definition purchase plan. This is used by marketplace images. |
properties.purchasePlan.name |
String | No |
The plan ID. |
properties.purchasePlan.publisher |
String | No |
The publisher ID. |
properties.purchasePlan.product |
String | No |
The product ID. |
properties.privacyStatementUri |
String | No |
The privacy statement uri. |
properties.eula |
String | No |
The Eula agreement for the gallery image definition. |
properties.osType |
String | Yes |
This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux. Possible values:
|
properties.identifier |
Object | Yes |
This is the gallery image definition identifier. |
properties.identifier.sku |
String | Yes |
The name of the gallery image definition SKU. |
properties.identifier.publisher |
String | Yes |
The name of the gallery image definition publisher. |
properties.identifier.offer |
String | Yes |
The name of the gallery image definition offer. |
properties.provisioningState |
String | No |
The provisioning state, which only appears in the response. Possible values:
|
properties.disallowed |
Object | No |
Describes the disallowed disk types. |
properties.disallowed.diskTypes[] |
Array | No |
A list of disk types. |
properties.osState |
String | Yes |
This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. Possible values:
|
properties.hyperVGeneration |
String | No |
The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values:
|
properties.features[] |
Array | No |
A list of gallery image features. |
properties.features[].name |
String | No |
The name of the gallery image feature. |
properties.features[].value |
String | No |
The value of the gallery image feature. |
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.