Gallery Application Versions - Create Or Update

Service:

Compute

API Version:

2025-03-03

Create or update a gallery Application Version.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}?api-version=2025-03-03

URI Parameters

Name	In	Required	Type	Description
galleryApplicationName	path	True	string	The name of the gallery Application Definition to be retrieved.
galleryApplicationVersionName	path	True	string	The name of the gallery Application Version to be retrieved.
galleryName	path	True	string pattern: ^[^_\W][\w-._]{0,79}(?	The name of the Shared Image Gallery.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
properties.publishingProfile	True	GalleryApplicationVersionPublishingProfile	The publishing profile of a gallery image version.
properties.safetyProfile		GalleryApplicationVersionSafetyProfile	The safety profile of the Gallery Application Version.
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	GalleryApplicationVersion	Resource 'GalleryApplicationVersion' update operation succeeded
201 Created	GalleryApplicationVersion	Resource 'GalleryApplicationVersion' create operation succeeded Headers Location: string Retry-After: integer
202 Accepted	GalleryApplicationVersion	The request has been accepted for processing, but processing has not yet completed. Headers Location: string Retry-After: integer
Other Status Codes	CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create or update a simple gallery Application Version.

Sample request

HTTP

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName/versions/1.0.0?api-version=2025-03-03

{
  "location": "West US",
  "properties": {
    "publishingProfile": {
      "source": {
        "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}"
      },
      "manageActions": {
        "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"",
        "remove": "del C:\\package "
      },
      "targetRegions": [
        {
          "name": "West US",
          "regionalReplicaCount": 1,
          "storageAccountType": "Standard_LRS",
          "excludeFromLatest": false
        }
      ],
      "replicaCount": 1,
      "endOfLifeDate": "2019-07-01T07:00:00Z",
      "storageAccountType": "Standard_LRS",
      "customActions": [
        {
          "name": "myCustomAction",
          "script": "myCustomActionScript",
          "description": "This is the custom action description.",
          "parameters": [
            {
              "name": "myCustomActionParameter",
              "required": false,
              "type": "String",
              "defaultValue": "default value of parameter.",
              "description": "This is the description of the parameter"
            }
          ]
        }
      ]
    },
    "safetyProfile": {
      "allowDeletionOfReplicatedLocations": false
    }
  }
}

Java

import com.azure.resourcemanager.compute.fluent.models.GalleryApplicationVersionInner;
import com.azure.resourcemanager.compute.models.GalleryApplicationCustomAction;
import com.azure.resourcemanager.compute.models.GalleryApplicationCustomActionParameter;
import com.azure.resourcemanager.compute.models.GalleryApplicationCustomActionParameterType;
import com.azure.resourcemanager.compute.models.GalleryApplicationVersionPublishingProfile;
import com.azure.resourcemanager.compute.models.GalleryApplicationVersionSafetyProfile;
import com.azure.resourcemanager.compute.models.StorageAccountType;
import com.azure.resourcemanager.compute.models.TargetRegion;
import com.azure.resourcemanager.compute.models.UserArtifactManage;
import com.azure.resourcemanager.compute.models.UserArtifactSource;
import java.time.OffsetDateTime;
import java.util.Arrays;

/**
 * Samples for GalleryApplicationVersions CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-03-03/galleryExamples/GalleryApplicationVersion_Create.json
     */
    /**
     * Sample code: Create or update a simple gallery Application Version.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void
        createOrUpdateASimpleGalleryApplicationVersion(com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getGalleryApplicationVersions().createOrUpdate("myResourceGroup", "myGalleryName",
            "myGalleryApplicationName", "1.0.0",
            new GalleryApplicationVersionInner().withLocation("West US")
                .withPublishingProfile(new GalleryApplicationVersionPublishingProfile()
                    .withTargetRegions(Arrays.asList(new TargetRegion().withName("West US").withRegionalReplicaCount(1)
                        .withStorageAccountType(StorageAccountType.STANDARD_LRS).withExcludeFromLatest(false)))
                    .withReplicaCount(1).withEndOfLifeDate(OffsetDateTime.parse("2019-07-01T07:00:00Z"))
                    .withStorageAccountType(StorageAccountType.STANDARD_LRS)
                    .withSource(new UserArtifactSource().withMediaLink(
                        "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}"))
                    .withManageActions(new UserArtifactManage()
                        .withInstall(
                            "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"")
                        .withRemove("del C:\\package "))
                    .withCustomActions(Arrays.asList(new GalleryApplicationCustomAction().withName("myCustomAction")
                        .withScript("myCustomActionScript").withDescription("This is the custom action description.")
                        .withParameters(Arrays
                            .asList(new GalleryApplicationCustomActionParameter().withName("myCustomActionParameter")
                                .withRequired(false).withType(GalleryApplicationCustomActionParameterType.STRING)
                                .withDefaultValue("default value of parameter.")
                                .withDescription("This is the description of the parameter"))))))
                .withSafetyProfile(
                    new GalleryApplicationVersionSafetyProfile().withAllowDeletionOfReplicatedLocations(false)),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python gallery_application_version_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.gallery_application_versions.begin_create_or_update(
        resource_group_name="myResourceGroup",
        gallery_name="myGalleryName",
        gallery_application_name="myGalleryApplicationName",
        gallery_application_version_name="1.0.0",
        gallery_application_version={
            "location": "West US",
            "properties": {
                "publishingProfile": {
                    "customActions": [
                        {
                            "description": "This is the custom action description.",
                            "name": "myCustomAction",
                            "parameters": [
                                {
                                    "defaultValue": "default value of parameter.",
                                    "description": "This is the description of the parameter",
                                    "name": "myCustomActionParameter",
                                    "required": False,
                                    "type": "String",
                                }
                            ],
                            "script": "myCustomActionScript",
                        }
                    ],
                    "endOfLifeDate": "2019-07-01T07:00:00Z",
                    "manageActions": {
                        "install": 'powershell -command "Expand-Archive -Path package.zip -DestinationPath C:\\package"',
                        "remove": "del C:\\package ",
                    },
                    "replicaCount": 1,
                    "source": {
                        "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}"
                    },
                    "storageAccountType": "Standard_LRS",
                    "targetRegions": [
                        {
                            "excludeFromLatest": False,
                            "name": "West US",
                            "regionalReplicaCount": 1,
                            "storageAccountType": "Standard_LRS",
                        }
                    ],
                },
                "safetyProfile": {"allowDeletionOfReplicatedLocations": False},
            },
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-03-03/galleryExamples/GalleryApplicationVersion_Create.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"
	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v8"
)

// Generated from example definition: 2025-03-03/galleryExamples/GalleryApplicationVersion_Create.json
func ExampleGalleryApplicationVersionsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewGalleryApplicationVersionsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myGalleryName", "myGalleryApplicationName", "1.0.0", armcompute.GalleryApplicationVersion{
		Location: to.Ptr("West US"),
		Properties: &armcompute.GalleryApplicationVersionProperties{
			PublishingProfile: &armcompute.GalleryApplicationVersionPublishingProfile{
				Source: &armcompute.UserArtifactSource{
					MediaLink: to.Ptr("https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}"),
				},
				ManageActions: &armcompute.UserArtifactManage{
					Install: to.Ptr("powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\""),
					Remove:  to.Ptr("del C:\\package "),
				},
				TargetRegions: []*armcompute.TargetRegion{
					{
						Name:                 to.Ptr("West US"),
						RegionalReplicaCount: to.Ptr[int32](1),
						StorageAccountType:   to.Ptr(armcompute.StorageAccountTypeStandardLRS),
						ExcludeFromLatest:    to.Ptr(false),
					},
				},
				ReplicaCount:       to.Ptr[int32](1),
				EndOfLifeDate:      to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-07-01T07:00:00Z"); return t }()),
				StorageAccountType: to.Ptr(armcompute.StorageAccountTypeStandardLRS),
				CustomActions: []*armcompute.GalleryApplicationCustomAction{
					{
						Name:        to.Ptr("myCustomAction"),
						Script:      to.Ptr("myCustomActionScript"),
						Description: to.Ptr("This is the custom action description."),
						Parameters: []*armcompute.GalleryApplicationCustomActionParameter{
							{
								Name:         to.Ptr("myCustomActionParameter"),
								Required:     to.Ptr(false),
								Type:         to.Ptr(armcompute.GalleryApplicationCustomActionParameterTypeString),
								DefaultValue: to.Ptr("default value of parameter."),
								Description:  to.Ptr("This is the description of the parameter"),
							},
						},
					},
				},
			},
			SafetyProfile: &armcompute.GalleryApplicationVersionSafetyProfile{
				AllowDeletionOfReplicatedLocations: to.Ptr(false),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armcompute.GalleryApplicationVersionsClientCreateOrUpdateResponse{
	// 	GalleryApplicationVersion: &armcompute.GalleryApplicationVersion{
	// 		Location: to.Ptr("West US"),
	// 		Name: to.Ptr("1.0.0"),
	// 		Type: to.Ptr("Microsoft.Compute/galleries/applications/versions"),
	// 		ID: to.Ptr("/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0"),
	// 		Properties: &armcompute.GalleryApplicationVersionProperties{
	// 			PublishingProfile: &armcompute.GalleryApplicationVersionPublishingProfile{
	// 				Source: &armcompute.UserArtifactSource{
	// 					MediaLink: to.Ptr("https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}"),
	// 				},
	// 				ManageActions: &armcompute.UserArtifactManage{
	// 					Install: to.Ptr("powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\""),
	// 					Remove: to.Ptr("del C:\\package "),
	// 				},
	// 				EnableHealthCheck: to.Ptr(false),
	// 				Settings: &armcompute.UserArtifactSettings{
	// 					PackageFileName: to.Ptr("package.zip"),
	// 					ConfigFileName: to.Ptr("configuration.cfg"),
	// 				},
	// 				AdvancedSettings: map[string]*string{
	// 					"timeout": to.Ptr("300"),
	// 					"user": to.Ptr("root"),
	// 				},
	// 				TargetRegions: []*armcompute.TargetRegion{
	// 					{
	// 						Name: to.Ptr("West US"),
	// 						RegionalReplicaCount: to.Ptr[int32](1),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypeStandardLRS),
	// 						ExcludeFromLatest: to.Ptr(false),
	// 					},
	// 				},
	// 				ReplicaCount: to.Ptr[int32](1),
	// 				ExcludeFromLatest: to.Ptr(false),
	// 				PublishedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-06-21T17:13:57.5972568+00:00"); return t}()),
	// 				EndOfLifeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-07-01T07:00:00+00:00"); return t}()),
	// 				StorageAccountType: to.Ptr(armcompute.StorageAccountTypeStandardLRS),
	// 				CustomActions: []*armcompute.GalleryApplicationCustomAction{
	// 					{
	// 						Name: to.Ptr("myCustomAction"),
	// 						Script: to.Ptr("myCustomActionScript"),
	// 						Description: to.Ptr("This is the custom action description."),
	// 						Parameters: []*armcompute.GalleryApplicationCustomActionParameter{
	// 							{
	// 								Name: to.Ptr("myCustomActionParameter"),
	// 								Required: to.Ptr(false),
	// 								Type: to.Ptr(armcompute.GalleryApplicationCustomActionParameterTypeString),
	// 								DefaultValue: to.Ptr("default value of parameter."),
	// 								Description: to.Ptr("This is the description of the parameter"),
	// 							},
	// 						},
	// 					},
	// 				},
	// 			},
	// 			SafetyProfile: &armcompute.GalleryApplicationVersionSafetyProfile{
	// 				AllowDeletionOfReplicatedLocations: to.Ptr(false),
	// 			},
	// 			ProvisioningState: to.Ptr(armcompute.GalleryProvisioningStateUpdating),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to create or update a gallery Application Version.
 *
 * @summary create or update a gallery Application Version.
 * x-ms-original-file: 2025-03-03/galleryExamples/GalleryApplicationVersion_Create.json
 */
async function createOrUpdateASimpleGalleryApplicationVersion() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscription-id}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.galleryApplicationVersions.createOrUpdate(
    "myResourceGroup",
    "myGalleryName",
    "myGalleryApplicationName",
    "1.0.0",
    {
      location: "West US",
      publishingProfile: {
        source: {
          mediaLink:
            "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}",
        },
        manageActions: {
          install:
            'powershell -command "Expand-Archive -Path package.zip -DestinationPath C:\\package"',
          remove: "del C:\\package ",
        },
        targetRegions: [
          {
            name: "West US",
            regionalReplicaCount: 1,
            storageAccountType: "Standard_LRS",
            excludeFromLatest: false,
          },
        ],
        replicaCount: 1,
        endOfLifeDate: new Date("2019-07-01T07:00:00Z"),
        storageAccountType: "Standard_LRS",
        customActions: [
          {
            name: "myCustomAction",
            script: "myCustomActionScript",
            description: "This is the custom action description.",
            parameters: [
              {
                name: "myCustomActionParameter",
                required: false,
                type: "String",
                defaultValue: "default value of parameter.",
                description: "This is the description of the parameter",
              },
            ],
          },
        ],
      },
      safetyProfile: { allowDeletionOfReplicatedLocations: false },
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-03-03/examples/galleryExamples/GalleryApplicationVersion_Create.json
// this example is just showing the usage of "GalleryApplicationVersions_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this GalleryApplicationResource created on azure
// for more information of creating GalleryApplicationResource, please refer to the document of GalleryApplicationResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string galleryName = "myGalleryName";
string galleryApplicationName = "myGalleryApplicationName";
ResourceIdentifier galleryApplicationResourceId = GalleryApplicationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, galleryName, galleryApplicationName);
GalleryApplicationResource galleryApplication = client.GetGalleryApplicationResource(galleryApplicationResourceId);

// get the collection of this GalleryApplicationVersionResource
GalleryApplicationVersionCollection collection = galleryApplication.GetGalleryApplicationVersions();

// invoke the operation
string galleryApplicationVersionName = "1.0.0";
GalleryApplicationVersionData data = new GalleryApplicationVersionData(new AzureLocation("West US"))
{
    PublishingProfile = new GalleryApplicationVersionPublishingProfile(new UserArtifactSource("https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}"))
    {
        ManageActions = new UserArtifactManagement("powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", "del C:\\package "),
        CustomActions = {new GalleryApplicationCustomAction("myCustomAction", "myCustomActionScript")
        {
        Description = "This is the custom action description.",
        Parameters = {new GalleryApplicationCustomActionParameter("myCustomActionParameter")
        {
        IsRequired = false,
        ParameterType = GalleryApplicationCustomActionParameterType.String,
        DefaultValue = "default value of parameter.",
        Description = "This is the description of the parameter",
        }},
        }},
        TargetRegions = {new TargetRegion("West US")
        {
        RegionalReplicaCount = 1,
        StorageAccountType = ImageStorageAccountType.StandardLrs,
        IsExcludedFromLatest = false,
        }},
        ReplicaCount = 1,
        EndOfLifeOn = DateTimeOffset.Parse("2019-07-01T07:00:00Z"),
        StorageAccountType = ImageStorageAccountType.StandardLrs,
    },
    AllowDeletionOfReplicatedLocations = false,
};
ArmOperation<GalleryApplicationVersionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, galleryApplicationVersionName, data);
GalleryApplicationVersionResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
GalleryApplicationVersionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "location": "West US",
  "name": "1.0.0",
  "type": "Microsoft.Compute/galleries/applications/versions",
  "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0",
  "properties": {
    "publishingProfile": {
      "source": {
        "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}"
      },
      "manageActions": {
        "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"",
        "remove": "del C:\\package "
      },
      "enableHealthCheck": false,
      "settings": {
        "packageFileName": "package.zip",
        "configFileName": "configuration.cfg"
      },
      "advancedSettings": {
        "timeout": "300",
        "user": "root"
      },
      "targetRegions": [
        {
          "name": "West US",
          "regionalReplicaCount": 1,
          "storageAccountType": "Standard_LRS",
          "excludeFromLatest": false
        }
      ],
      "replicaCount": 1,
      "excludeFromLatest": false,
      "publishedDate": "2019-06-21T17:13:57.5972568+00:00",
      "endOfLifeDate": "2019-07-01T07:00:00+00:00",
      "storageAccountType": "Standard_LRS",
      "customActions": [
        {
          "name": "myCustomAction",
          "script": "myCustomActionScript",
          "description": "This is the custom action description.",
          "parameters": [
            {
              "name": "myCustomActionParameter",
              "required": false,
              "type": "String",
              "defaultValue": "default value of parameter.",
              "description": "This is the description of the parameter"
            }
          ]
        }
      ]
    },
    "safetyProfile": {
      "allowDeletionOfReplicatedLocations": false
    },
    "provisioningState": "Updating"
  }
}

Status code:

201

{
  "location": "West US",
  "name": "1.0.0",
  "type": "Microsoft.Compute/galleries/applications/versions",
  "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0",
  "properties": {
    "publishingProfile": {
      "source": {
        "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}"
      },
      "manageActions": {
        "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"",
        "remove": "del C:\\package "
      },
      "enableHealthCheck": false,
      "settings": {
        "packageFileName": "package.zip",
        "configFileName": "configuration.cfg",
        "scriptBehaviorAfterReboot": "Rerun"
      },
      "advancedSettings": {
        "timeout": "300",
        "user": "root"
      },
      "targetRegions": [
        {
          "name": "West US",
          "regionalReplicaCount": 1,
          "storageAccountType": "Standard_LRS",
          "excludeFromLatest": false
        }
      ],
      "replicaCount": 1,
      "excludeFromLatest": false,
      "publishedDate": "2019-06-21T17:13:57.5972568+00:00",
      "endOfLifeDate": "2019-07-01T07:00:00+00:00",
      "storageAccountType": "Standard_LRS",
      "customActions": [
        {
          "name": "myCustomAction",
          "script": "myCustomActionScript",
          "description": "This is the custom action description.",
          "parameters": [
            {
              "name": "myCustomActionParameter",
              "required": false,
              "type": "String",
              "defaultValue": "default value of parameter.",
              "description": "This is the description of the parameter"
            }
          ]
        }
      ]
    },
    "safetyProfile": {
      "allowDeletionOfReplicatedLocations": false
    },
    "provisioningState": "Creating"
  }
}

Status code:

202

{
  "location": "West US",
  "name": "1.0.0",
  "type": "Microsoft.Compute/galleries/applications/versions",
  "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0",
  "properties": {
    "publishingProfile": {
      "source": {
        "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}"
      },
      "manageActions": {
        "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"",
        "remove": "del C:\\package "
      },
      "enableHealthCheck": false,
      "targetRegions": [
        {
          "name": "West US",
          "regionalReplicaCount": 1,
          "storageAccountType": "Standard_LRS",
          "excludeFromLatest": false
        }
      ],
      "replicaCount": 1,
      "excludeFromLatest": false,
      "publishedDate": "2019-06-21T17:13:57.5972568+00:00",
      "endOfLifeDate": "2019-07-01T07:00:00+00:00",
      "storageAccountType": "Standard_LRS",
      "customActions": [
        {
          "name": "myCustomAction",
          "script": "myCustomActionScript",
          "description": "This is the custom action description.",
          "parameters": [
            {
              "name": "myCustomActionParameter",
              "required": false,
              "type": "String",
              "defaultValue": "default value of parameter.",
              "description": "This is the description of the parameter"
            }
          ]
        }
      ]
    },
    "safetyProfile": {
      "allowDeletionOfReplicatedLocations": false
    },
    "provisioningState": "Updating"
  }
}

Definitions

Name	Description
AdditionalReplicaSet	Describes the additional replica set information.
AggregatedReplicationState	This is the aggregated replication status based on all the regional replication status flags.
ApiError	Api error.
ApiErrorBase	Api error base.
CloudError	An error response from the Compute service.
ConfidentialVMEncryptionType	confidential VM encryption types
createdByType	The type of identity that created the resource.
DataDiskImageEncryption	Contains encryption settings for a data disk image.
EdgeZoneStorageAccountType	Specifies the storage account type to be used to store the image. This property is not updatable.
EncryptionImages	Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.
GalleryApplicationCustomAction	A custom action that can be performed with a Gallery Application Version.
GalleryApplicationCustomActionParameter	The definition of a parameter that can be passed to a custom action of a Gallery Application Version.
GalleryApplicationCustomActionParameterType	Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob
GalleryApplicationScriptRebootBehavior	Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot.
GalleryApplicationVersion	Specifies information about the gallery Application Version that you want to create or update.
GalleryApplicationVersionPublishingProfile	The publishing profile of a gallery image version.
GalleryApplicationVersionSafetyProfile	The safety profile of the Gallery Application Version.
GalleryExtendedLocation	The name of the extended location.
GalleryExtendedLocationType	It is type of the extended location.
GalleryProvisioningState	The provisioning state, which only appears in the response.
GalleryTargetExtendedLocation
InnerError	Inner error details.
OSDiskImageEncryption	Contains encryption settings for an OS disk image.
OSDiskImageSecurityProfile	Contains security profile for an OS disk image.
RegionalReplicationStatus	This is the regional replication status.
ReplicationMode	Optional parameter which specifies the mode to be used for replication. This property is not updatable.
ReplicationState	This is the regional replication state.
ReplicationStatus	This is the replication status of the gallery image version.
StorageAccountStrategy	Specifies the strategy to be used when selecting the storage account type. Cannot be specified along with storageAccountType, but can be overridden per region by specifying targetRegions[].storageAccountType. This property is not updatable.
StorageAccountType	Specifies the storage account type to be used to store the image. This property is not updatable.
systemData	Metadata pertaining to creation and last modification of the resource.
TargetRegion	Describes the target region information.
UserArtifactManage
UserArtifactSettings	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.
UserArtifactSource	The source image from which the Image Version is going to be created.

AdditionalReplicaSet

Object

Describes the additional replica set information.

Name	Type	Description
regionalReplicaCount	integer (int32)	The number of direct drive replicas of the Image Version to be created.This Property is updatable
storageAccountType	StorageAccountType	Specifies the storage account type to be used to create the direct drive replicas

AggregatedReplicationState

Enumeration

This is the aggregated replication status based on all the regional replication status flags.

Value	Description
Unknown
InProgress
Completed
Failed

ApiError

Object

Api error.

Name	Type	Description
code	string	The error code.
details	ApiErrorBase[]	The Api error details
innererror	InnerError	The Api inner error
message	string	The error message.
target	string	The target of the particular error.

ApiErrorBase

Object

Api error base.

Name	Type	Description
code	string	The error code.
message	string	The error message.
target	string	The target of the particular error.

CloudError

Object

An error response from the Compute service.

Name	Type	Description
error	ApiError	Api error.

ConfidentialVMEncryptionType

Enumeration

confidential VM encryption types

Value	Description
EncryptedVMGuestStateOnlyWithPmk
EncryptedWithPmk
EncryptedWithCmk
NonPersistedTPM

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DataDiskImageEncryption

Object

Contains encryption settings for a data disk image.

Name	Type	Description
diskEncryptionSetId	string	A relative URI containing the resource ID of the disk encryption set.
lun	integer (int32)	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.

EdgeZoneStorageAccountType

Enumeration

Specifies the storage account type to be used to store the image. This property is not updatable.

Value	Description
Standard_LRS
Standard_ZRS
StandardSSD_LRS
Premium_LRS

EncryptionImages

Object

Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.

Name	Type	Description
dataDiskImages	DataDiskImageEncryption[]	A list of encryption specifications for data disk images.
osDiskImage	OSDiskImageEncryption	Contains encryption settings for an OS disk image.

GalleryApplicationCustomAction

Object

A custom action that can be performed with a Gallery Application Version.

Name	Type	Description
description	string	Description to help the users understand what this custom action does.
name	string	The name of the custom action. Must be unique within the Gallery Application Version.
parameters	GalleryApplicationCustomActionParameter[]	The parameters that this custom action uses
script	string	The script to run when executing this custom action.

GalleryApplicationCustomActionParameter

Object

The definition of a parameter that can be passed to a custom action of a Gallery Application Version.

Name	Type	Description
defaultValue	string	The default value of the parameter. Only applies to string types
description	string	A description to help users understand what this parameter means
name	string	The name of the custom action. Must be unique within the Gallery Application Version.
required	boolean	Indicates whether this parameter must be passed when running the custom action.
type	GalleryApplicationCustomActionParameterType	Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob

GalleryApplicationCustomActionParameterType

Enumeration

Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob

Value	Description
String
ConfigurationDataBlob
LogOutputBlob

GalleryApplicationScriptRebootBehavior

Enumeration

Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot.

Value	Description
None
Rerun

GalleryApplicationVersion

Object

Specifies information about the gallery Application Version that you want to create or update.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.provisioningState	GalleryProvisioningState	The provisioning state, which only appears in the response.
properties.publishingProfile	GalleryApplicationVersionPublishingProfile	The publishing profile of a gallery image version.
properties.replicationStatus	ReplicationStatus	This is the replication status of the gallery image version.
properties.safetyProfile	GalleryApplicationVersionSafetyProfile	The safety profile of the Gallery Application Version.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

GalleryApplicationVersionPublishingProfile

Object

The publishing profile of a gallery image version.

Name	Type	Description
advancedSettings	object	Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only.
customActions	GalleryApplicationCustomAction[]	A list of custom actions that can be performed with this Gallery Application Version.
enableHealthCheck	boolean	Optional. Whether or not this application reports health.
endOfLifeDate	string (date-time)	The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable.
excludeFromLatest	boolean	If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.
manageActions	UserArtifactManage
publishedDate	string (date-time)	The timestamp for when the gallery image version is published.
replicaCount	integer (int32)	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.
replicationMode	ReplicationMode	Optional parameter which specifies the mode to be used for replication. This property is not updatable.
settings	UserArtifactSettings	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.
source	UserArtifactSource	The source image from which the Image Version is going to be created.
storageAccountStrategy	StorageAccountStrategy	Specifies the strategy to be used when selecting the storage account type. Cannot be specified along with storageAccountType, but can be overridden per region by specifying targetRegions[].storageAccountType. This property is not updatable.
storageAccountType	StorageAccountType	Specifies the storage account type to be used to store the image. Cannot be specified along with storageAccountStrategy. This property is not updatable.
targetExtendedLocations	GalleryTargetExtendedLocation[]	The target extended locations where the Image Version is going to be replicated to. This property is updatable.
targetRegions	TargetRegion[]	The target regions where the Image Version is going to be replicated to. This property is updatable.

GalleryApplicationVersionSafetyProfile

Object

The safety profile of the Gallery Application Version.

Name	Type	Description
allowDeletionOfReplicatedLocations	boolean	Indicates whether or not removing this Gallery Image Version from replicated regions is allowed.

GalleryExtendedLocation

Object

The name of the extended location.

Name	Type	Description
name	string
type	GalleryExtendedLocationType	It is type of the extended location.

GalleryExtendedLocationType

Enumeration

It is type of the extended location.

Value	Description
EdgeZone
Unknown

GalleryProvisioningState

Enumeration

The provisioning state, which only appears in the response.

Value	Description
Creating
Updating
Failed
Succeeded
Deleting
Migrating

GalleryTargetExtendedLocation

Object

Name	Type	Description
encryption	EncryptionImages	Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.
extendedLocation	GalleryExtendedLocation	The name of the extended location.
extendedLocationReplicaCount	integer (int32)	The number of replicas of the Image Version to be created per extended location. This property is updatable.
name	string	The name of the region.
storageAccountType	EdgeZoneStorageAccountType	Specifies the storage account type to be used to store the image. This property is not updatable.

InnerError

Object

Inner error details.

Name	Type	Description
errordetail	string	The internal error message or exception dump.
exceptiontype	string	The exception type.

OSDiskImageEncryption

Object

Contains encryption settings for an OS disk image.

Name	Type	Description
diskEncryptionSetId	string	A relative URI containing the resource ID of the disk encryption set.
securityProfile	OSDiskImageSecurityProfile	This property specifies the security profile of an OS disk image.

OSDiskImageSecurityProfile

Object

Contains security profile for an OS disk image.

Name	Type	Description
confidentialVMEncryptionType	ConfidentialVMEncryptionType	confidential VM encryption types
secureVMDiskEncryptionSetId	string	secure VM disk encryption set id

RegionalReplicationStatus

Object

This is the regional replication status.

Name	Type	Description
details	string	The details of the replication status.
progress	integer (int32)	It indicates progress of the replication job.
region	string	The region to which the gallery image version is being replicated to.
state	ReplicationState	This is the regional replication state.

ReplicationMode

Enumeration

Optional parameter which specifies the mode to be used for replication. This property is not updatable.

Value	Description
Full
Shallow

ReplicationState

Enumeration

This is the regional replication state.

Value	Description
Unknown
Replicating
Completed
Failed

ReplicationStatus

Object

This is the replication status of the gallery image version.

Name	Type	Description
aggregatedState	AggregatedReplicationState	This is the aggregated replication status based on all the regional replication status flags.
summary	RegionalReplicationStatus[]	This is a summary of replication status for each region.

StorageAccountStrategy

Enumeration

Specifies the strategy to be used when selecting the storage account type. Cannot be specified along with storageAccountType, but can be overridden per region by specifying targetRegions[].storageAccountType. This property is not updatable.

Value	Description
PreferStandard_ZRS	Choose Standard_ZRS storage if the region supports it, else choose Standard_LRS storage, unless overridden by specifying regional storageAccountType. If no storageAccountStrategy is specified, this is the default strategy (from API version 2025-03-03 onwards).
DefaultStandard_LRS	Choose Standard_LRS storage unless overridden by specifying regional storageAccountType.

StorageAccountType

Enumeration

Specifies the storage account type to be used to store the image. This property is not updatable.

Value	Description
Standard_LRS
Standard_ZRS
Premium_LRS
PremiumV2_LRS

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

TargetRegion

Object

Describes the target region information.

Name	Type	Description
additionalReplicaSets	AdditionalReplicaSet[]	List of storage sku with replica count to create direct drive replicas.
encryption	EncryptionImages	Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.
excludeFromLatest	boolean	Contains the flag setting to hide an image when users specify version='latest'
name	string	The name of the region.
regionalReplicaCount	integer (int32)	The number of replicas of the Image Version to be created per region. This property is updatable.
storageAccountType	StorageAccountType	Specifies the storage account type to be used to store the image. This property is not updatable.

UserArtifactManage

Object

Name	Type	Description
install	string	Required. The path and arguments to install the gallery application. This is limited to 4096 characters.
remove	string	Required. The path and arguments to remove the gallery application. This is limited to 4096 characters.
update	string	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.

UserArtifactSettings

Object

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.

Name	Type	Description
configFileName	string	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".
packageFileName	string	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.
scriptBehaviorAfterReboot	GalleryApplicationScriptRebootBehavior	Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot.

UserArtifactSource

Object

The source image from which the Image Version is going to be created.

Name	Type	Description
defaultConfigurationLink	string	Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob.
mediaLink	string	Required. The mediaLink of the artifact, must be a readable storage page blob.