Gallery Applications - Update

Service:

Compute

API Version:

2024-03-03

Update a gallery Application Definition.

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

URI Parameters

Name	In	Required	Type	Description
galleryApplicationName	path	True	string	The name of the gallery Application Definition to be retrieved.
galleryName	path	True	string	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
properties.supportedOSType	True	OperatingSystemTypes	This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux.
properties.customActions		GalleryApplicationCustomAction[]	A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application.
properties.description		string	The description of this gallery Application Definition resource. This property is updatable.
properties.endOfLifeDate		string (date-time)	The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
properties.eula		string	The Eula agreement for the gallery Application Definition.
properties.privacyStatementUri		string	The privacy statement uri.
properties.releaseNoteUri		string	The release note uri.
tags		object	Resource tags

Responses

Name	Type	Description
200 OK	GalleryApplication	The request has succeeded. 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

Update a simple gallery Application.

Sample request

HTTP

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

{
  "properties": {
    "description": "This is the gallery application description.",
    "eula": "This is the gallery application EULA.",
    "privacyStatementUri": "myPrivacyStatementUri}",
    "releaseNoteUri": "myReleaseNoteUri",
    "supportedOSType": "Windows",
    "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"
          }
        ]
      }
    ]
  }
}

Java

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.GalleryApplicationUpdate;
import com.azure.resourcemanager.compute.models.OperatingSystemTypes;
import java.util.Arrays;

/**
 * Samples for GalleryApplications Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/galleryExamples/
     * GalleryApplication_Update.json
     */
    /**
     * Sample code: Update a simple gallery Application.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateASimpleGalleryApplication(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getGalleryApplications()
            .update("myResourceGroup", "myGalleryName", "myGalleryApplicationName",
                new GalleryApplicationUpdate().withDescription("This is the gallery application description.")
                    .withEula("This is the gallery application EULA.").withPrivacyStatementUri("myPrivacyStatementUri}")
                    .withReleaseNoteUri("myReleaseNoteUri").withSupportedOSType(OperatingSystemTypes.WINDOWS)
                    .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"))))),
                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

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/250861bb6a886b75255edfa0aa5ee2dd0d6e7a11/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/galleryExamples/GalleryApplication_Update.json
func ExampleGalleryApplicationsClient_BeginUpdate() {
	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.NewGalleryApplicationsClient().BeginUpdate(ctx, "myResourceGroup", "myGalleryName", "myGalleryApplicationName", armcompute.GalleryApplicationUpdate{
		Properties: &armcompute.GalleryApplicationProperties{
			Description: to.Ptr("This is the gallery application description."),
			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"),
				}},
			Eula:                to.Ptr("This is the gallery application EULA."),
			PrivacyStatementURI: to.Ptr("myPrivacyStatementUri}"),
			ReleaseNoteURI:      to.Ptr("myReleaseNoteUri"),
			SupportedOSType:     to.Ptr(armcompute.OperatingSystemTypesWindows),
		},
	}, 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.GalleryApplication = armcompute.GalleryApplication{
	// 	Name: to.Ptr("myGalleryApplicationName"),
	// 	Type: to.Ptr("Microsoft.Compute/galleries"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName"),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armcompute.GalleryApplicationProperties{
	// 		Description: to.Ptr("This is the gallery application description."),
	// 		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"),
	// 		}},
	// 		Eula: to.Ptr("This is the gallery application EULA."),
	// 		PrivacyStatementURI: to.Ptr("myPrivacyStatementUri}"),
	// 		ReleaseNoteURI: to.Ptr("myReleaseNoteUri"),
	// 		SupportedOSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 	},
	// }
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Update a gallery Application Definition.
 *
 * @summary Update a gallery Application Definition.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/galleryExamples/GalleryApplication_Update.json
 */
async function updateASimpleGalleryApplication() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const galleryName = "myGalleryName";
  const galleryApplicationName = "myGalleryApplicationName";
  const galleryApplication = {
    description: "This is the gallery application description.",
    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",
      },
    ],
    eula: "This is the gallery application EULA.",
    privacyStatementUri: "myPrivacyStatementUri}",
    releaseNoteUri: "myReleaseNoteUri",
    supportedOSType: "Windows",
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.galleryApplications.beginUpdateAndWait(
    resourceGroupName,
    galleryName,
    galleryApplicationName,
    galleryApplication,
  );
  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/GalleryRP/stable/2024-03-03/examples/galleryExamples/GalleryApplication_Update.json
// this example is just showing the usage of "GalleryApplications_Update" 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);

// invoke the operation
GalleryApplicationPatch patch = new GalleryApplicationPatch
{
    Description = "This is the gallery application description.",
    Eula = "This is the gallery application EULA.",
    PrivacyStatementUri = new Uri("myPrivacyStatementUri}"),
    ReleaseNoteUri = new Uri("myReleaseNoteUri"),
    SupportedOSType = SupportedOperatingSystemType.Windows,
    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",
    }},
    }},
};
ArmOperation<GalleryApplicationResource> lro = await galleryApplication.UpdateAsync(WaitUntil.Completed, patch);
GalleryApplicationResource 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
GalleryApplicationData 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

{
  "properties": {
    "description": "This is the gallery application description.",
    "eula": "This is the gallery application EULA.",
    "privacyStatementUri": "myPrivacyStatementUri}",
    "releaseNoteUri": "myReleaseNoteUri",
    "supportedOSType": "Windows",
    "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"
          }
        ]
      }
    ]
  },
  "location": "West US",
  "name": "myGalleryApplicationName",
  "type": "Microsoft.Compute/galleries",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName"
}

Definitions

Name	Description
ApiError	Api error.
ApiErrorBase	Api error base.
CloudError	An error response from the Compute service.
createdByType	The type of identity that created the resource.
GalleryApplication	Specifies information about the gallery Application Definition that you want to create or update.
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
GalleryApplicationUpdate	Specifies information about the gallery Application Definition that you want to update.
InnerError	Inner error details.
OperatingSystemTypes	This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux.
systemData	Metadata pertaining to creation and last modification of the resource.

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.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

GalleryApplication

Object

Specifies information about the gallery Application Definition 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.customActions	GalleryApplicationCustomAction[]	A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application.
properties.description	string	The description of this gallery Application Definition resource. This property is updatable.
properties.endOfLifeDate	string (date-time)	The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
properties.eula	string	The Eula agreement for the gallery Application Definition.
properties.privacyStatementUri	string	The privacy statement uri.
properties.releaseNoteUri	string	The release note uri.
properties.supportedOSType	OperatingSystemTypes	This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux.
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"

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

GalleryApplicationUpdate

Object

Specifies information about the gallery Application Definition that you want to update.

Name	Type	Description
id	string	Resource Id
name	string	Resource name
properties.customActions	GalleryApplicationCustomAction[]	A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application.
properties.description	string	The description of this gallery Application Definition resource. This property is updatable.
properties.endOfLifeDate	string (date-time)	The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
properties.eula	string	The Eula agreement for the gallery Application Definition.
properties.privacyStatementUri	string	The privacy statement uri.
properties.releaseNoteUri	string	The release note uri.
properties.supportedOSType	OperatingSystemTypes	This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux.
tags	object	Resource tags
type	string	Resource type

InnerError

Object

Inner error details.

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

OperatingSystemTypes

Enumeration

This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux.

Value	Description
Windows
Linux

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.