Microsoft.DesktopVirtualization applicationGroups 2020-10-19-preview

  • Article

Bicep resource definition

The applicationGroups resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DesktopVirtualization/applicationGroups resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DesktopVirtualization/applicationGroups@2020-10-19-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    applicationGroupType: 'string'
    description: 'string'
    friendlyName: 'string'
    hostPoolArmPath: 'string'
  }
}

Property values

applicationGroups

Name Description Value
name The resource name string (required)

Character limit: 3-64

Valid characters:
Alphanumerics, underscores, periods, and hyphens.

Start with letter or number. End with letter, number, or underscore.
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Detailed properties for ApplicationGroup ApplicationGroupProperties (required)

ApplicationGroupProperties

Name Description Value
applicationGroupType Resource Type of ApplicationGroup. 'Desktop'
'RemoteApp' (required)
description Description of ApplicationGroup. string
friendlyName Friendly name of ApplicationGroup. string
hostPoolArmPath HostPool arm path of ApplicationGroup. string (required)

ARM template resource definition

The applicationGroups resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DesktopVirtualization/applicationGroups resource, add the following JSON to your template.

{
  "type": "Microsoft.DesktopVirtualization/applicationGroups",
  "apiVersion": "2020-10-19-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "applicationGroupType": "string",
    "description": "string",
    "friendlyName": "string",
    "hostPoolArmPath": "string"
  }
}

Property values

applicationGroups

Name Description Value
type The resource type 'Microsoft.DesktopVirtualization/applicationGroups'
apiVersion The resource api version '2020-10-19-preview'
name The resource name string (required)

Character limit: 3-64

Valid characters:
Alphanumerics, underscores, periods, and hyphens.

Start with letter or number. End with letter, number, or underscore.
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Detailed properties for ApplicationGroup ApplicationGroupProperties (required)

ApplicationGroupProperties

Name Description Value
applicationGroupType Resource Type of ApplicationGroup. 'Desktop'
'RemoteApp' (required)
description Description of ApplicationGroup. string
friendlyName Friendly name of ApplicationGroup. string
hostPoolArmPath HostPool arm path of ApplicationGroup. string (required)

Terraform (AzAPI provider) resource definition

The applicationGroups 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.DesktopVirtualization/applicationGroups resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/applicationGroups@2020-10-19-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      applicationGroupType = "string"
      description = "string"
      friendlyName = "string"
      hostPoolArmPath = "string"
    }
  })
}

Property values

applicationGroups

Name Description Value
type The resource type "Microsoft.DesktopVirtualization/applicationGroups@2020-10-19-preview"
name The resource name string (required)

Character limit: 3-64

Valid characters:
Alphanumerics, underscores, periods, and hyphens.

Start with letter or number. End with letter, number, or underscore.
location The geo-location where the resource lives string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
properties Detailed properties for ApplicationGroup ApplicationGroupProperties (required)

ApplicationGroupProperties

Name Description Value
applicationGroupType Resource Type of ApplicationGroup. "Desktop"
"RemoteApp" (required)
description Description of ApplicationGroup. string
friendlyName Friendly name of ApplicationGroup. string
hostPoolArmPath HostPool arm path of ApplicationGroup. string (required)