PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}/?api-version=2022-08-03
Create or update a gallery Application Version.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
galleryName |
String | Yes |
The name of the Shared Application Gallery in which the Application Definition resides. |
galleryApplicationVersionName |
String | Yes |
The name of the gallery Application Version to be created. 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: .. |
galleryApplicationName |
String | Yes |
The name of the gallery Application Definition in which the Application Version is to be created. |
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. |
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 |
The safety profile of the Gallery Application Version. |
properties.safetyProfile.allowDeletionOfReplicatedLocations |
Boolean | No |
Indicates whether or not removing this Gallery Image Version from replicated regions is allowed. |
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.publishingProfile |
Object | Yes |
The publishing profile of a gallery image version. |
properties.publishingProfile.source |
Object | Yes |
The source image from which the Image Version is going to be created. |
properties.publishingProfile.source.mediaLink |
String | Yes |
Required. The mediaLink of the artifact, must be a readable storage page blob. |
properties.publishingProfile.source.defaultConfigurationLink |
String | No |
Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. |
properties.publishingProfile.enableHealthCheck |
Boolean | No |
Optional. Whether or not this application reports health. |
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.customActions[] |
Array | No |
A list of custom actions that can be performed with this Gallery Application Version. |
properties.publishingProfile.customActions[].name |
String | Yes |
The name of the custom action. Must be unique within the Gallery Application Version. |
properties.publishingProfile.customActions[].description |
String | No |
Description to help the users understand what this custom action does. |
properties.publishingProfile.customActions[].script |
String | Yes |
The script to run when executing this custom action. |
properties.publishingProfile.customActions[].parameters[] |
Array | No |
The parameters that this custom action uses |
properties.publishingProfile.customActions[].parameters[].name |
String | Yes |
The name of the custom action. Must be unique within the Gallery Application Version. |
properties.publishingProfile.customActions[].parameters[].defaultValue |
String | No |
The default value of the parameter. Only applies to string types |
properties.publishingProfile.customActions[].parameters[].description |
String | No |
A description to help users understand what this parameter means |
properties.publishingProfile.customActions[].parameters[].required |
Boolean | No |
Indicates whether this parameter must be passed when running the custom action. |
properties.publishingProfile.customActions[].parameters[].type |
String | No |
Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob Possible values:
|
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.manageActions |
Object | No | |
properties.publishingProfile.manageActions.remove |
String | Yes |
Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. |
properties.publishingProfile.manageActions.install |
String | Yes |
Required. The path and arguments to install the gallery application. This is limited to 4096 characters. |
properties.publishingProfile.manageActions.update |
String | No |
Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. |
properties.publishingProfile.advancedSettings |
Object | No |
Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. |
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:
|
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.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.settings |
Object | No |
Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. |
properties.publishingProfile.settings.packageFileName |
String | No |
Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. |
properties.publishingProfile.settings.configFileName |
String | No |
Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". |
location |
String | No |
Resource location |
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.