PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/?api-version=2022-08-03
Update a gallery Application Definition.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
galleryName |
String | Yes |
The name of the Shared Application Gallery in which the Application Definition is to be updated. |
galleryApplicationName |
String | Yes |
The name of the gallery Application Definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. |
subscriptionId |
String | Yes |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
resourceGroupName |
String | Yes |
The name of the resource group. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Resource Id |
name |
String | No |
Resource name |
properties |
Object | No |
Describes the properties of a gallery Application Definition. |
properties.privacyStatementUri |
String | No |
The privacy statement uri. |
properties.endOfLifeDate |
String | No |
The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. |
properties.releaseNoteUri |
String | No |
The release note uri. |
properties.description |
String | No |
The description of this gallery Application Definition resource. This property is updatable. |
properties.eula |
String | No |
The Eula agreement for the gallery Application Definition. |
properties.customActions[] |
Array | No |
A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. |
properties.customActions[].name |
String | Yes |
The name of the custom action. Must be unique within the Gallery Application Version. |
properties.customActions[].description |
String | No |
Description to help the users understand what this custom action does. |
properties.customActions[].script |
String | Yes |
The script to run when executing this custom action. |
properties.customActions[].parameters[] |
Array | No |
The parameters that this custom action uses |
properties.customActions[].parameters[].name |
String | Yes |
The name of the custom action. Must be unique within the Gallery Application Version. |
properties.customActions[].parameters[].defaultValue |
String | No |
The default value of the parameter. Only applies to string types |
properties.customActions[].parameters[].description |
String | No |
A description to help users understand what this parameter means |
properties.customActions[].parameters[].required |
Boolean | No |
Indicates whether this parameter must be passed when running the custom action. |
properties.customActions[].parameters[].type |
String | No |
Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob Possible values:
|
properties.supportedOSType |
String | Yes |
This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux. Possible values:
|
tags |
Object | No |
Resource tags |
type |
String | No |
Resource type |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.