Azure Desktop Virtualization Application Group

This page shows how to write Terraform and Azure Resource Manager for Desktop Virtualization Application Group and write them securely.

azurerm_virtual_desktop_application_group (Terraform)

The Application Group in Desktop Virtualization can be configured in Terraform with the resource name azurerm_virtual_desktop_application_group. The following sections describe 10 examples of how to use the resource and its parameters.

Example Usage from GitHub

main.tf#L31
resource "azurerm_virtual_desktop_application_group" "avdplrag1" {
  name                = var.pooledhpremoteappname
  location            = var.region
  resource_group_name = azurerm_resource_group.avdrg1.name

  type          = "RemoteApp"
main.tf#L18
resource "azurerm_virtual_desktop_application_group" "pooledremoteapp" {
  name                = var.pooledhpremoteappname
  location            = var.region
  resource_group_name = var.rgname
  type                = "RemoteApp"
  host_pool_id        = azurerm_virtual_desktop_host_pool.pooleddepthfirst.id
main.tf#L30
resource "azurerm_virtual_desktop_application_group" "pooledremoteapp" {
  name                = var.pooledhpremoteappname
  location            = var.region
  resource_group_name = var.rgname

  type          = "RemoteApp"
main.tf#L27
resource "azurerm_virtual_desktop_application_group" "pooledremoteapp" {
  name                = var.pooledhpremoteappname
  location            = var.region
  resource_group_name = azurerm_resource_group.default.name

  type          = "RemoteApp"
main.tf#L44
resource "azurerm_virtual_desktop_application_group" "wvdpool01DAG" {
  name                = var.pooledhpdesktopappname
  location            = var.region
  resource_group_name = azurerm_resource_group.rgwvd01.name

  type          = "Desktop"
DAGs.tf#L2
resource "azurerm_virtual_desktop_application_group" "pooleddesktopapp" {
  name                = var.pooledhpdesktopappname
  location            = var.region
  resource_group_name = var.rgname
  type                = "Desktop"
  host_pool_id        = azurerm_virtual_desktop_host_pool.pooleddepthfirst.id
azure-rdp.tf#L19
resource "azurerm_virtual_desktop_application_group" "remoteapp" {
  name                = "remoteapp"
  location            = azurerm_resource_group.example.location
  resource_group_name = azurerm_resource_group.example.name
  type                = "RemoteApp"
  host_pool_id        = azurerm_virtual_desktop_host_pool.pooledbreadthfirst.id
wvd.tf#L29
resource "azurerm_virtual_desktop_application_group" "remoteapp" {
  name                = var.appgname
  location            = var.location
  resource_group_name = azurerm_resource_group.hp.name

  type          = "Desktop"
virtual_desktop_application_group.tf#L11
resource "azurerm_virtual_desktop_application_group" "dag" {
  name                = azurecaf_name.dag.result
  location            = var.location
  resource_group_name = var.resource_group_name
  friendly_name       = try(var.settings.friendly_name, null)
  description         = try(var.settings.description, null)
Hostpool.tf#L24
resource "azurerm_virtual_desktop_application_group" "desktopapp" {
  name                = var.appgrp-name
  location            = var.location
  resource_group_name = var.resourcename

  type          = "Desktop"

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

Explanation in Terraform Registry

Manages a Virtual Desktop Application Group.

Microsoft.DesktopVirtualization/applicationGroups (Azure Resource Manager)

The applicationGroups in Microsoft.DesktopVirtualization can be configured in Azure Resource Manager with the resource name Microsoft.DesktopVirtualization/applicationGroups. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

avdCustomWorkbookCreationTemplate.json
{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "workbookDisplayName": {

Parameters

  • apiVersion required - string
  • identity optional
      • type optional - string

        The identity type.

  • kind optional - string

    Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

  • location optional - string

    The geo-location where the resource lives

  • managedBy optional - string

    The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

  • name required - string

    The name of the application group

  • plan optional
      • name required - string

        A user defined name of the 3rd Party Artifact that is being procured.

      • product required - string

        The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.

      • promotionCode optional - string

        A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

      • publisher required - string

        The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic

      • version optional - string

        The version of the desired product/artifact.

  • properties required
      • applicationGroupType required - string

        Resource Type of ApplicationGroup.

      • description optional - string

        Description of ApplicationGroup.

      • friendlyName optional - string

        Friendly name of ApplicationGroup.

      • hostPoolArmPath required - string

        HostPool arm path of ApplicationGroup.

      • migrationRequest optional
          • migrationPath optional - string

            The path to the legacy object to migrate.

          • operation optional - string

            The type of operation for migration.

  • sku optional
      • capacity optional - integer

        If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

      • family optional - string

        If the service has different generations of hardware, for the same SKU, then that can be captured here.

      • name required - string

        The name of the SKU. Ex - P3. It is typically a letter+number code

      • size optional - string

        The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

      • tier optional - string

        This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

  • tags optional - string

    Resource tags.

  • type required - string

Frequently asked questions

What is Azure Desktop Virtualization Application Group?

Azure Desktop Virtualization Application Group is a resource for Desktop Virtualization of Microsoft Azure. Settings can be wrote in Terraform.

Where can I find the example code for the Azure Desktop Virtualization Application Group?

For Terraform, the rslwxyz/avd-tf-small, deanl1982/Pub-Terraform and deanl1982/Pub-Terraform source code examples are useful. See the Terraform Example section for further details.

For Azure Resource Manager, the Bistech/Azure source code example is useful. See the Azure Resource Manager Example section for further details.