Skip to content

azurermVirtualDesktopApplicationGroup

Manages a Virtual Desktop Application Group.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
new azurerm.provider.AzurermProvider(this, "azurerm", {
  features: [{}],
});
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
  this,
  "example",
  {
    location: "West Europe",
    name: "rg-example-virtualdesktop",
  }
);
const azurermVirtualDesktopHostPoolPersonalautomatic =
  new azurerm.virtualDesktopHostPool.VirtualDesktopHostPool(
    this,
    "personalautomatic",
    {
      load_balancer_type: "BreadthFirst",
      location: azurermResourceGroupExample.location,
      name: "personalautomatic",
      personal_desktop_assignment_type: "Automatic",
      resource_group_name: azurermResourceGroupExample.name,
      type: "Personal",
    }
  );
const azurermVirtualDesktopHostPoolPooledbreadthfirst =
  new azurerm.virtualDesktopHostPool.VirtualDesktopHostPool(
    this,
    "pooledbreadthfirst",
    {
      load_balancer_type: "BreadthFirst",
      location: azurermResourceGroupExample.location,
      name: "pooledbreadthfirst",
      resource_group_name: azurermResourceGroupExample.name,
      type: "Pooled",
    }
  );
new azurerm.virtualDesktopApplicationGroup.VirtualDesktopApplicationGroup(
  this,
  "desktopapp",
  {
    description: "Acceptance Test: An application group",
    friendly_name: "TestAppGroup",
    host_pool_id: azurermVirtualDesktopHostPoolPersonalautomatic.id,
    location: azurermResourceGroupExample.location,
    name: "appgroupdesktop",
    resource_group_name: azurermResourceGroupExample.name,
    type: "Desktop",
  }
);
new azurerm.virtualDesktopApplicationGroup.VirtualDesktopApplicationGroup(
  this,
  "remoteapp",
  {
    description: "Acceptance Test: An application group",
    friendly_name: "TestAppGroup",
    host_pool_id: azurermVirtualDesktopHostPoolPooledbreadthfirst.id,
    location: azurermResourceGroupExample.location,
    name: "acctag",
    resource_group_name: azurermResourceGroupExample.name,
    type: "RemoteApp",
  }
);

Argument Reference

The following arguments are supported:

  • name - (Required) The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.

  • resourceGroupName - (Required) The name of the resource group in which to create the Virtual Desktop Application Group. Changing this forces a new resource to be created.

  • location - (Required) The location/region where the Virtual Desktop Application Group is located. Changing this forces a new resource to be created.

  • type - (Required) Type of Virtual Desktop Application Group. Valid options are remoteApp or desktop application groups. Changing this forces a new resource to be created.

  • hostPoolId - (Required) Resource ID for a Virtual Desktop Host Pool to associate with the Virtual Desktop Application Group. Changing the name forces a new resource to be created.

  • friendlyName - (Optional) Option to set a friendly name for the Virtual Desktop Application Group.

  • defaultDesktopDisplayName - (Optional) Option to set the display name for the default sessionDesktop desktop when type is set to desktop.

  • description - (Optional) Option to set a description for the Virtual Desktop Application Group.

  • tags - (Optional) A mapping of tags to assign to the resource.

Attributes Reference

The following attributes are exported:

  • id - The ID of the Virtual Desktop Application Group.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 60 minutes) Used when creating the Virtual Desktop Application Group.
  • update - (Defaults to 60 minutes) Used when updating the Virtual Desktop Application Group.
  • read - (Defaults to 5 minutes) Used when retrieving the Virtual Desktop Application Group.
  • delete - (Defaults to 60 minutes) Used when deleting the Virtual Desktop Application Group.

Import

Virtual Desktop Application Groups can be imported using the resourceId, e.g.

terraform import azurerm_virtual_desktop_application_group.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/myapplicationgroup