Microsoft.Compute galleries/applications 2023-07-03
Bicep resource definition
The galleries/applications resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Compute/galleries/applications resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Compute/galleries/applications@2023-07-03' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
customActions: [
{
description: 'string'
name: 'string'
parameters: [
{
defaultValue: 'string'
description: 'string'
name: 'string'
required: bool
type: 'string'
}
]
script: 'string'
}
]
description: 'string'
endOfLifeDate: 'string'
eula: 'string'
privacyStatementUri: 'string'
releaseNoteUri: 'string'
supportedOSType: 'string'
}
}
Property values
galleries/applications
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 1-80 Valid characters: Alphanumerics, hyphens, and periods. Start and end with alphanumeric. |
| location | Resource location | string (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: galleries |
| properties | Describes the properties of a gallery Application Definition. | GalleryApplicationProperties |
GalleryApplicationProperties
| Name | Description | Value |
|---|---|---|
| customActions | A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. | GalleryApplicationCustomAction[] |
| description | The description of this gallery Application Definition resource. This property is updatable. | string |
| endOfLifeDate | The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. | string |
| eula | The Eula agreement for the gallery Application Definition. | string |
| privacyStatementUri | The privacy statement uri. | string |
| releaseNoteUri | The release note uri. | string |
| supportedOSType | This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux. | 'Linux' 'Windows' (required) |
GalleryApplicationCustomAction
| Name | Description | Value |
|---|---|---|
| description | Description to help the users understand what this custom action does. | string |
| name | The name of the custom action. Must be unique within the Gallery Application Version. | string (required) |
| parameters | The parameters that this custom action uses | GalleryApplicationCustomActionParameter[] |
| script | The script to run when executing this custom action. | string (required) |
GalleryApplicationCustomActionParameter
| Name | Description | Value |
|---|---|---|
| defaultValue | The default value of the parameter. Only applies to string types | string |
| description | A description to help users understand what this parameter means | string |
| name | The name of the custom action. Must be unique within the Gallery Application Version. | string (required) |
| required | Indicates whether this parameter must be passed when running the custom action. | bool |
| type | Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob | 'ConfigurationDataBlob' 'LogOutputBlob' 'String' |
ARM template resource definition
The galleries/applications resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Compute/galleries/applications resource, add the following JSON to your template.
{
"type": "Microsoft.Compute/galleries/applications",
"apiVersion": "2023-07-03",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"customActions": [
{
"description": "string",
"name": "string",
"parameters": [
{
"defaultValue": "string",
"description": "string",
"name": "string",
"required": "bool",
"type": "string"
}
],
"script": "string"
}
],
"description": "string",
"endOfLifeDate": "string",
"eula": "string",
"privacyStatementUri": "string",
"releaseNoteUri": "string",
"supportedOSType": "string"
}
}
Property values
galleries/applications
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Compute/galleries/applications' |
| apiVersion | The resource api version | '2023-07-03' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 1-80 Valid characters: Alphanumerics, hyphens, and periods. Start and end with alphanumeric. |
| location | Resource location | string (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| properties | Describes the properties of a gallery Application Definition. | GalleryApplicationProperties |
GalleryApplicationProperties
| Name | Description | Value |
|---|---|---|
| customActions | A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. | GalleryApplicationCustomAction[] |
| description | The description of this gallery Application Definition resource. This property is updatable. | string |
| endOfLifeDate | The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. | string |
| eula | The Eula agreement for the gallery Application Definition. | string |
| privacyStatementUri | The privacy statement uri. | string |
| releaseNoteUri | The release note uri. | string |
| supportedOSType | This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux. | 'Linux' 'Windows' (required) |
GalleryApplicationCustomAction
| Name | Description | Value |
|---|---|---|
| description | Description to help the users understand what this custom action does. | string |
| name | The name of the custom action. Must be unique within the Gallery Application Version. | string (required) |
| parameters | The parameters that this custom action uses | GalleryApplicationCustomActionParameter[] |
| script | The script to run when executing this custom action. | string (required) |
GalleryApplicationCustomActionParameter
| Name | Description | Value |
|---|---|---|
| defaultValue | The default value of the parameter. Only applies to string types | string |
| description | A description to help users understand what this parameter means | string |
| name | The name of the custom action. Must be unique within the Gallery Application Version. | string (required) |
| required | Indicates whether this parameter must be passed when running the custom action. | bool |
| type | Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob | 'ConfigurationDataBlob' 'LogOutputBlob' 'String' |
Terraform (AzAPI provider) resource definition
The galleries/applications resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Compute/galleries/applications resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/galleries/applications@2023-07-03"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
customActions = [
{
description = "string"
name = "string"
parameters = [
{
defaultValue = "string"
description = "string"
name = "string"
required = bool
type = "string"
}
]
script = "string"
}
]
description = "string"
endOfLifeDate = "string"
eula = "string"
privacyStatementUri = "string"
releaseNoteUri = "string"
supportedOSType = "string"
}
})
}
Property values
galleries/applications
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Compute/galleries/applications@2023-07-03" |
| name | The resource name | string (required) Character limit: 1-80 Valid characters: Alphanumerics, hyphens, and periods. Start and end with alphanumeric. |
| location | Resource location | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: galleries |
| tags | Resource tags | Dictionary of tag names and values. |
| properties | Describes the properties of a gallery Application Definition. | GalleryApplicationProperties |
GalleryApplicationProperties
| Name | Description | Value |
|---|---|---|
| customActions | A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. | GalleryApplicationCustomAction[] |
| description | The description of this gallery Application Definition resource. This property is updatable. | string |
| endOfLifeDate | The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. | string |
| eula | The Eula agreement for the gallery Application Definition. | string |
| privacyStatementUri | The privacy statement uri. | string |
| releaseNoteUri | The release note uri. | string |
| supportedOSType | This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux. | "Linux" "Windows" (required) |
GalleryApplicationCustomAction
| Name | Description | Value |
|---|---|---|
| description | Description to help the users understand what this custom action does. | string |
| name | The name of the custom action. Must be unique within the Gallery Application Version. | string (required) |
| parameters | The parameters that this custom action uses | GalleryApplicationCustomActionParameter[] |
| script | The script to run when executing this custom action. | string (required) |
GalleryApplicationCustomActionParameter
| Name | Description | Value |
|---|---|---|
| defaultValue | The default value of the parameter. Only applies to string types | string |
| description | A description to help users understand what this parameter means | string |
| name | The name of the custom action. Must be unique within the Gallery Application Version. | string (required) |
| required | Indicates whether this parameter must be passed when running the custom action. | bool |
| type | Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob | "ConfigurationDataBlob" "LogOutputBlob" "String" |