Share via

Microsoft.DesktopVirtualization applicationGroups 2019-09-24-preview

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@2019-09-24-preview' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    applicationGroupType: 'string'
    description: 'string'
    friendlyName: 'string'
    hostPoolArmPath: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DesktopVirtualization/applicationGroups

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 24 (required)
properties Detailed properties for ApplicationGroup ApplicationGroupProperties (required)
scope Use when creating a resource at a scope that is different than the deployment scope. Set this property to the symbolic name of a resource to apply the extension resource.
tags Resource tags Dictionary of tag names and values. See Tags in templates

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)

TrackedResourceTags

Name Description Value

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Azure Virtual Desktop (AVD) Application Group AVM Resource Module for Azure Virtual Desktop (AVD) Application Group

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Creates AVD with Microsoft Entra ID Join This template allows you to create Azure Virtual Desktop resources such as host pool, application group, workspace, a test session host and its extensions with Microsoft Entra ID join

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": "2019-09-24-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "applicationGroupType": "string",
    "description": "string",
    "friendlyName": "string",
    "hostPoolArmPath": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DesktopVirtualization/applicationGroups

Name Description Value
apiVersion The api version '2019-09-24-preview'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 24 (required)
properties Detailed properties for ApplicationGroup ApplicationGroupProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DesktopVirtualization/applicationGroups'

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)

TrackedResourceTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Creates AVD with Microsoft Entra ID Join

Deploy to Azure		 This template allows you to create Azure Virtual Desktop resources such as host pool, application group, workspace, a test session host and its extensions with Microsoft Entra ID join

Terraform (AzAPI provider) 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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/applicationGroups@2019-09-24-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      applicationGroupType = "string"
      description = "string"
      friendlyName = "string"
      hostPoolArmPath = "string"
    }
  }
}

Property Values

Microsoft.DesktopVirtualization/applicationGroups

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 24 (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties Detailed properties for ApplicationGroup ApplicationGroupProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DesktopVirtualization/applicationGroups@2019-09-24-preview"

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)

TrackedResourceTags

Name Description Value

Usage Examples

Terraform Samples

A basic example of deploying Virtual Desktop Application Group.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "hostPool" {
  type      = "Microsoft.DesktopVirtualization/hostPools@2024-04-03"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-hp"
  location  = var.location
  body = {
    properties = {
      customRdpProperty             = ""
      description                   = ""
      friendlyName                  = ""
      hostPoolType                  = "Pooled"
      loadBalancerType              = "BreadthFirst"
      maxSessionLimit               = 999999
      personalDesktopAssignmentType = ""
      preferredAppGroupType         = "Desktop"
      publicNetworkAccess           = "Enabled"
      startVMOnConnect              = false
      validationEnvironment         = false
      vmTemplate                    = ""
    }
  }
}

resource "azapi_resource" "applicationGroup" {
  type      = "Microsoft.DesktopVirtualization/applicationGroups@2024-04-03"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-ag"
  location  = var.location
  body = {
    properties = {
      applicationGroupType = "Desktop"
      description          = ""
      friendlyName         = ""
      hostPoolArmPath      = azapi_resource.hostPool.id
    }
  }
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Azure Virtual Desktop (AVD) Application Group AVM Resource Module for Azure Virtual Desktop (AVD) Application Group
  • Last updated on