Gallery Application Versions - Create Or Update

Service:

Compute

API Version:

2023-07-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=2023-07-03

URI Parameters

Name	In	Required	Type	Description
galleryApplicationName	path	True	string	The name of the gallery Application Definition in which the Application Version is to be created.
galleryApplicationVersionName	path	True	string	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: ..
galleryName	path	True	string	The name of the Shared Application Gallery in which the Application Definition resides.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Request Body

Name	Required	Type	Description
location	True	string	Resource location
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	OK
201 Created	GalleryApplicationVersion	Created
202 Accepted	GalleryApplicationVersion	Accepted
Other Status Codes	CloudError	Error response describing why the operation failed.

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=2023-07-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
    }
  }
}

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/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{
				EndOfLifeDate:      to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-07-01T07:00:00.000Z"); return t }()),
				ReplicaCount:       to.Ptr[int32](1),
				StorageAccountType: to.Ptr(armcompute.StorageAccountTypeStandardLRS),
				TargetRegions: []*armcompute.TargetRegion{
					{
						Name:                 to.Ptr("West US"),
						ExcludeFromLatest:    to.Ptr(false),
						RegionalReplicaCount: to.Ptr[int32](1),
						StorageAccountType:   to.Ptr(armcompute.StorageAccountTypeStandardLRS),
					}},
				CustomActions: []*armcompute.GalleryApplicationCustomAction{
					{
						Name:        to.Ptr("myCustomAction"),
						Description: to.Ptr("This is the custom action description."),
						Parameters: []*armcompute.GalleryApplicationCustomActionParameter{
							{
								Name:         to.Ptr("myCustomActionParameter"),
								Type:         to.Ptr(armcompute.GalleryApplicationCustomActionParameterTypeString),
								Description:  to.Ptr("This is the description of the parameter"),
								DefaultValue: to.Ptr("default value of parameter."),
								Required:     to.Ptr(false),
							}},
						Script: to.Ptr("myCustomActionScript"),
					}},
				ManageActions: &armcompute.UserArtifactManage{
					Install: to.Ptr("powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\""),
					Remove:  to.Ptr("del C:\\package "),
				},
				Source: &armcompute.UserArtifactSource{
					MediaLink: to.Ptr("https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}"),
				},
			},
			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.GalleryApplicationVersion = armcompute.GalleryApplicationVersion{
	// 	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"),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armcompute.GalleryApplicationVersionProperties{
	// 		ProvisioningState: to.Ptr(armcompute.GalleryProvisioningStateSucceeded),
	// 		PublishingProfile: &armcompute.GalleryApplicationVersionPublishingProfile{
	// 			EndOfLifeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-07-01T07:00:00.000Z"); return t}()),
	// 			ExcludeFromLatest: to.Ptr(false),
	// 			PublishedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-06-21T17:13:57.597Z"); return t}()),
	// 			ReplicaCount: to.Ptr[int32](1),
	// 			StorageAccountType: to.Ptr(armcompute.StorageAccountTypeStandardLRS),
	// 			TargetRegions: []*armcompute.TargetRegion{
	// 				{
	// 					Name: to.Ptr("West US"),
	// 					ExcludeFromLatest: to.Ptr(false),
	// 					RegionalReplicaCount: to.Ptr[int32](1),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypeStandardLRS),
	// 			}},
	// 			AdvancedSettings: map[string]*string{
	// 				"timeout": to.Ptr("300"),
	// 				"user": to.Ptr("root"),
	// 			},
	// 			CustomActions: []*armcompute.GalleryApplicationCustomAction{
	// 				{
	// 					Name: to.Ptr("myCustomAction"),
	// 					Description: to.Ptr("This is the custom action description."),
	// 					Parameters: []*armcompute.GalleryApplicationCustomActionParameter{
	// 						{
	// 							Name: to.Ptr("myCustomActionParameter"),
	// 							Type: to.Ptr(armcompute.GalleryApplicationCustomActionParameterTypeString),
	// 							Description: to.Ptr("This is the description of the parameter"),
	// 							DefaultValue: to.Ptr("default value of parameter."),
	// 							Required: to.Ptr(false),
	// 					}},
	// 					Script: to.Ptr("myCustomActionScript"),
	// 			}},
	// 			EnableHealthCheck: to.Ptr(false),
	// 			ManageActions: &armcompute.UserArtifactManage{
	// 				Install: to.Ptr("powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\""),
	// 				Remove: to.Ptr("del C:\\package "),
	// 			},
	// 			Settings: &armcompute.UserArtifactSettings{
	// 				ConfigFileName: to.Ptr("configuration.cfg"),
	// 				PackageFileName: to.Ptr("package.zip"),
	// 			},
	// 			Source: &armcompute.UserArtifactSource{
	// 				MediaLink: to.Ptr("https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}"),
	// 			},
	// 		},
	// 		SafetyProfile: &armcompute.GalleryApplicationVersionSafetyProfile{
	// 			AllowDeletionOfReplicatedLocations: to.Ptr(false),
	// 		},
	// 	},
	// }
}

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: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Create.json
 */
async function createOrUpdateASimpleGalleryApplicationVersion() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const galleryName = "myGalleryName";
  const galleryApplicationName = "myGalleryApplicationName";
  const galleryApplicationVersionName = "1.0.0";
  const galleryApplicationVersion = {
    location: "West US",
    publishingProfile: {
      customActions: [
        {
          name: "myCustomAction",
          description: "This is the custom action description.",
          parameters: [
            {
              name: "myCustomActionParameter",
              type: "String",
              description: "This is the description of the parameter",
              defaultValue: "default value of parameter.",
              required: false,
            },
          ],
          script: "myCustomActionScript",
        },
      ],
      endOfLifeDate: new Date("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: [
        {
          name: "West US",
          excludeFromLatest: false,
          regionalReplicaCount: 1,
          storageAccountType: "Standard_LRS",
        },
      ],
    },
    safetyProfile: { allowDeletionOfReplicatedLocations: false },
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.galleryApplicationVersions.beginCreateOrUpdateAndWait(
    resourceGroupName,
    galleryName,
    galleryApplicationName,
    galleryApplicationVersionName,
    galleryApplicationVersion,
  );
  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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Compute;
using Azure.ResourceManager.Compute.Models;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-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"
      },
      "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
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
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
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 current state of the gallery or gallery artifact.
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.
StorageAccountType	Specifies the storage account type to be used to store the image. This property is not updatable.
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.

AggregatedReplicationState

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

Name	Type	Description
Completed	string
Failed	string
InProgress	string
Unknown	string

ApiError

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

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

An error response from the Compute service.

Name	Type	Description
error	ApiError	Api error.

ConfidentialVMEncryptionType

confidential VM encryption types

Name	Type	Description
EncryptedVMGuestStateOnlyWithPmk	string
EncryptedWithCmk	string
EncryptedWithPmk	string
NonPersistedTPM	string

DataDiskImageEncryption

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	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

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

Name	Type	Description
Premium_LRS	string
StandardSSD_LRS	string
Standard_LRS	string
Standard_ZRS	string

EncryptionImages

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

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

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

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

Name	Type	Description
ConfigurationDataBlob	string
LogOutputBlob	string
String	string

GalleryApplicationVersion

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

Name	Type	Description
id	string	Resource Id
location	string	Resource location
name	string	Resource name
properties.provisioningState	GalleryProvisioningState	The current state of the gallery or gallery artifact. 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.
tags	object	Resource tags
type	string	Resource type

GalleryApplicationVersionPublishingProfile

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	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	The timestamp for when the gallery image version is published.
replicaCount	integer	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.
storageAccountType	StorageAccountType	Specifies the storage account type to be used to store the image. 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

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

The name of the extended location.

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

GalleryExtendedLocationType

It is type of the extended location.

Name	Type	Description
EdgeZone	string
Unknown	string

GalleryProvisioningState

The current state of the gallery or gallery artifact.

Name	Type	Description
Creating	string
Deleting	string
Failed	string
Migrating	string
Succeeded	string
Updating	string

GalleryTargetExtendedLocation

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	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

Inner error details.

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

OSDiskImageEncryption

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

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

This is the regional replication status.

Name	Type	Description
details	string	The details of the replication status.
progress	integer	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

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

Name	Type	Description
Full	string
Shallow	string

ReplicationState

This is the regional replication state.

Name	Type	Description
Completed	string
Failed	string
Replicating	string
Unknown	string

ReplicationStatus

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.

StorageAccountType

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

Name	Type	Description
Premium_LRS	string
Standard_LRS	string
Standard_ZRS	string

TargetRegion

Describes the target region information.

Name	Type	Description
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	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

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

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.

UserArtifactSource

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.