Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. desktopvirtualization
  5. ApplicationGroup

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.desktopvirtualization.ApplicationGroup

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Virtual Desktop Application Group.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "rg-example-virtualdesktop",
    location: "West Europe",
});
const pooledbreadthfirst = new azure.desktopvirtualization.HostPool("pooledbreadthfirst", {
    name: "pooledbreadthfirst",
    location: example.location,
    resourceGroupName: example.name,
    type: "Pooled",
    loadBalancerType: "BreadthFirst",
});
const personalautomatic = new azure.desktopvirtualization.HostPool("personalautomatic", {
    name: "personalautomatic",
    location: example.location,
    resourceGroupName: example.name,
    type: "Personal",
    personalDesktopAssignmentType: "Automatic",
    loadBalancerType: "BreadthFirst",
});
const remoteapp = new azure.desktopvirtualization.ApplicationGroup("remoteapp", {
    name: "acctag",
    location: example.location,
    resourceGroupName: example.name,
    type: "RemoteApp",
    hostPoolId: pooledbreadthfirst.id,
    friendlyName: "TestAppGroup",
    description: "Acceptance Test: An application group",
});
const desktopapp = new azure.desktopvirtualization.ApplicationGroup("desktopapp", {
    name: "appgroupdesktop",
    location: example.location,
    resourceGroupName: example.name,
    type: "Desktop",
    hostPoolId: personalautomatic.id,
    friendlyName: "TestAppGroup",
    description: "Acceptance Test: An application group",
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="rg-example-virtualdesktop",
    location="West Europe")
pooledbreadthfirst = azure.desktopvirtualization.HostPool("pooledbreadthfirst",
    name="pooledbreadthfirst",
    location=example.location,
    resource_group_name=example.name,
    type="Pooled",
    load_balancer_type="BreadthFirst")
personalautomatic = azure.desktopvirtualization.HostPool("personalautomatic",
    name="personalautomatic",
    location=example.location,
    resource_group_name=example.name,
    type="Personal",
    personal_desktop_assignment_type="Automatic",
    load_balancer_type="BreadthFirst")
remoteapp = azure.desktopvirtualization.ApplicationGroup("remoteapp",
    name="acctag",
    location=example.location,
    resource_group_name=example.name,
    type="RemoteApp",
    host_pool_id=pooledbreadthfirst.id,
    friendly_name="TestAppGroup",
    description="Acceptance Test: An application group")
desktopapp = azure.desktopvirtualization.ApplicationGroup("desktopapp",
    name="appgroupdesktop",
    location=example.location,
    resource_group_name=example.name,
    type="Desktop",
    host_pool_id=personalautomatic.id,
    friendly_name="TestAppGroup",
    description="Acceptance Test: An application group")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/desktopvirtualization"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("rg-example-virtualdesktop"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		pooledbreadthfirst, err := desktopvirtualization.NewHostPool(ctx, "pooledbreadthfirst", &desktopvirtualization.HostPoolArgs{
			Name:              pulumi.String("pooledbreadthfirst"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Type:              pulumi.String("Pooled"),
			LoadBalancerType:  pulumi.String("BreadthFirst"),
		})
		if err != nil {
			return err
		}
		personalautomatic, err := desktopvirtualization.NewHostPool(ctx, "personalautomatic", &desktopvirtualization.HostPoolArgs{
			Name:                          pulumi.String("personalautomatic"),
			Location:                      example.Location,
			ResourceGroupName:             example.Name,
			Type:                          pulumi.String("Personal"),
			PersonalDesktopAssignmentType: pulumi.String("Automatic"),
			LoadBalancerType:              pulumi.String("BreadthFirst"),
		})
		if err != nil {
			return err
		}
		_, err = desktopvirtualization.NewApplicationGroup(ctx, "remoteapp", &desktopvirtualization.ApplicationGroupArgs{
			Name:              pulumi.String("acctag"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Type:              pulumi.String("RemoteApp"),
			HostPoolId:        pooledbreadthfirst.ID(),
			FriendlyName:      pulumi.String("TestAppGroup"),
			Description:       pulumi.String("Acceptance Test: An application group"),
		})
		if err != nil {
			return err
		}
		_, err = desktopvirtualization.NewApplicationGroup(ctx, "desktopapp", &desktopvirtualization.ApplicationGroupArgs{
			Name:              pulumi.String("appgroupdesktop"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Type:              pulumi.String("Desktop"),
			HostPoolId:        personalautomatic.ID(),
			FriendlyName:      pulumi.String("TestAppGroup"),
			Description:       pulumi.String("Acceptance Test: An application group"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "rg-example-virtualdesktop",
        Location = "West Europe",
    });

    var pooledbreadthfirst = new Azure.DesktopVirtualization.HostPool("pooledbreadthfirst", new()
    {
        Name = "pooledbreadthfirst",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Type = "Pooled",
        LoadBalancerType = "BreadthFirst",
    });

    var personalautomatic = new Azure.DesktopVirtualization.HostPool("personalautomatic", new()
    {
        Name = "personalautomatic",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Type = "Personal",
        PersonalDesktopAssignmentType = "Automatic",
        LoadBalancerType = "BreadthFirst",
    });

    var remoteapp = new Azure.DesktopVirtualization.ApplicationGroup("remoteapp", new()
    {
        Name = "acctag",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Type = "RemoteApp",
        HostPoolId = pooledbreadthfirst.Id,
        FriendlyName = "TestAppGroup",
        Description = "Acceptance Test: An application group",
    });

    var desktopapp = new Azure.DesktopVirtualization.ApplicationGroup("desktopapp", new()
    {
        Name = "appgroupdesktop",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Type = "Desktop",
        HostPoolId = personalautomatic.Id,
        FriendlyName = "TestAppGroup",
        Description = "Acceptance Test: An application group",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.desktopvirtualization.HostPool;
import com.pulumi.azure.desktopvirtualization.HostPoolArgs;
import com.pulumi.azure.desktopvirtualization.ApplicationGroup;
import com.pulumi.azure.desktopvirtualization.ApplicationGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("rg-example-virtualdesktop")
            .location("West Europe")
            .build());

        var pooledbreadthfirst = new HostPool("pooledbreadthfirst", HostPoolArgs.builder()
            .name("pooledbreadthfirst")
            .location(example.location())
            .resourceGroupName(example.name())
            .type("Pooled")
            .loadBalancerType("BreadthFirst")
            .build());

        var personalautomatic = new HostPool("personalautomatic", HostPoolArgs.builder()
            .name("personalautomatic")
            .location(example.location())
            .resourceGroupName(example.name())
            .type("Personal")
            .personalDesktopAssignmentType("Automatic")
            .loadBalancerType("BreadthFirst")
            .build());

        var remoteapp = new ApplicationGroup("remoteapp", ApplicationGroupArgs.builder()
            .name("acctag")
            .location(example.location())
            .resourceGroupName(example.name())
            .type("RemoteApp")
            .hostPoolId(pooledbreadthfirst.id())
            .friendlyName("TestAppGroup")
            .description("Acceptance Test: An application group")
            .build());

        var desktopapp = new ApplicationGroup("desktopapp", ApplicationGroupArgs.builder()
            .name("appgroupdesktop")
            .location(example.location())
            .resourceGroupName(example.name())
            .type("Desktop")
            .hostPoolId(personalautomatic.id())
            .friendlyName("TestAppGroup")
            .description("Acceptance Test: An application group")
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: rg-example-virtualdesktop
      location: West Europe
  pooledbreadthfirst:
    type: azure:desktopvirtualization:HostPool
    properties:
      name: pooledbreadthfirst
      location: ${example.location}
      resourceGroupName: ${example.name}
      type: Pooled
      loadBalancerType: BreadthFirst
  personalautomatic:
    type: azure:desktopvirtualization:HostPool
    properties:
      name: personalautomatic
      location: ${example.location}
      resourceGroupName: ${example.name}
      type: Personal
      personalDesktopAssignmentType: Automatic
      loadBalancerType: BreadthFirst
  remoteapp:
    type: azure:desktopvirtualization:ApplicationGroup
    properties:
      name: acctag
      location: ${example.location}
      resourceGroupName: ${example.name}
      type: RemoteApp
      hostPoolId: ${pooledbreadthfirst.id}
      friendlyName: TestAppGroup
      description: 'Acceptance Test: An application group'
  desktopapp:
    type: azure:desktopvirtualization:ApplicationGroup
    properties:
      name: appgroupdesktop
      location: ${example.location}
      resourceGroupName: ${example.name}
      type: Desktop
      hostPoolId: ${personalautomatic.id}
      friendlyName: TestAppGroup
      description: 'Acceptance Test: An application group'
Copy

Create ApplicationGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ApplicationGroup(name: string, args: ApplicationGroupArgs, opts?: CustomResourceOptions);
@overload
def ApplicationGroup(resource_name: str,
                     args: ApplicationGroupArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def ApplicationGroup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     host_pool_id: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     type: Optional[str] = None,
                     default_desktop_display_name: Optional[str] = None,
                     description: Optional[str] = None,
                     friendly_name: Optional[str] = None,
                     location: Optional[str] = None,
                     name: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
func NewApplicationGroup(ctx *Context, name string, args ApplicationGroupArgs, opts ...ResourceOption) (*ApplicationGroup, error)
public ApplicationGroup(string name, ApplicationGroupArgs args, CustomResourceOptions? opts = null)
public ApplicationGroup(String name, ApplicationGroupArgs args)
public ApplicationGroup(String name, ApplicationGroupArgs args, CustomResourceOptions options)

type: azure:desktopvirtualization:ApplicationGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ApplicationGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ApplicationGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ApplicationGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApplicationGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ApplicationGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var applicationGroupResource = new Azure.DesktopVirtualization.ApplicationGroup("applicationGroupResource", new()
{
    HostPoolId = "string",
    ResourceGroupName = "string",
    Type = "string",
    DefaultDesktopDisplayName = "string",
    Description = "string",
    FriendlyName = "string",
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := desktopvirtualization.NewApplicationGroup(ctx, "applicationGroupResource", &desktopvirtualization.ApplicationGroupArgs{
	HostPoolId:                pulumi.String("string"),
	ResourceGroupName:         pulumi.String("string"),
	Type:                      pulumi.String("string"),
	DefaultDesktopDisplayName: pulumi.String("string"),
	Description:               pulumi.String("string"),
	FriendlyName:              pulumi.String("string"),
	Location:                  pulumi.String("string"),
	Name:                      pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var applicationGroupResource = new ApplicationGroup("applicationGroupResource", ApplicationGroupArgs.builder()
    .hostPoolId("string")
    .resourceGroupName("string")
    .type("string")
    .defaultDesktopDisplayName("string")
    .description("string")
    .friendlyName("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
application_group_resource = azure.desktopvirtualization.ApplicationGroup("applicationGroupResource",
    host_pool_id="string",
    resource_group_name="string",
    type="string",
    default_desktop_display_name="string",
    description="string",
    friendly_name="string",
    location="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const applicationGroupResource = new azure.desktopvirtualization.ApplicationGroup("applicationGroupResource", {
    hostPoolId: "string",
    resourceGroupName: "string",
    type: "string",
    defaultDesktopDisplayName: "string",
    description: "string",
    friendlyName: "string",
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:desktopvirtualization:ApplicationGroup
properties:
    defaultDesktopDisplayName: string
    description: string
    friendlyName: string
    hostPoolId: string
    location: string
    name: string
    resourceGroupName: string
    tags:
        string: string
    type: string
Copy

ApplicationGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ApplicationGroup resource accepts the following input properties:

HostPoolId
This property is required.
Changes to this property will trigger replacement.
string
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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the Virtual Desktop Application Group. Changing this forces a new resource to be created.
Type
This property is required.
Changes to this property will trigger replacement.
string
Type of Virtual Desktop Application Group. Valid options are RemoteApp or Desktop application groups. Changing this forces a new resource to be created.
DefaultDesktopDisplayName string
Option to set the display name for the default sessionDesktop desktop when type is set to Desktop. A value here is mandatory for connections to the desktop using the Windows 365 portal. Without it the connection will hang at 'Loading Client'.
Description string
Option to set a description for the Virtual Desktop Application Group.
FriendlyName string
Option to set a friendly name for the Virtual Desktop Application Group.
Location Changes to this property will trigger replacement. string
The location/region where the Virtual Desktop Application Group is located. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
HostPoolId
This property is required.
Changes to this property will trigger replacement.
string
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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the Virtual Desktop Application Group. Changing this forces a new resource to be created.
Type
This property is required.
Changes to this property will trigger replacement.
string
Type of Virtual Desktop Application Group. Valid options are RemoteApp or Desktop application groups. Changing this forces a new resource to be created.
DefaultDesktopDisplayName string
Option to set the display name for the default sessionDesktop desktop when type is set to Desktop. A value here is mandatory for connections to the desktop using the Windows 365 portal. Without it the connection will hang at 'Loading Client'.
Description string
Option to set a description for the Virtual Desktop Application Group.
FriendlyName string
Option to set a friendly name for the Virtual Desktop Application Group.
Location Changes to this property will trigger replacement. string
The location/region where the Virtual Desktop Application Group is located. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
hostPoolId
This property is required.
Changes to this property will trigger replacement.
String
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the Virtual Desktop Application Group. Changing this forces a new resource to be created.
type
This property is required.
Changes to this property will trigger replacement.
String
Type of Virtual Desktop Application Group. Valid options are RemoteApp or Desktop application groups. Changing this forces a new resource to be created.
defaultDesktopDisplayName String
Option to set the display name for the default sessionDesktop desktop when type is set to Desktop. A value here is mandatory for connections to the desktop using the Windows 365 portal. Without it the connection will hang at 'Loading Client'.
description String
Option to set a description for the Virtual Desktop Application Group.
friendlyName String
Option to set a friendly name for the Virtual Desktop Application Group.
location Changes to this property will trigger replacement. String
The location/region where the Virtual Desktop Application Group is located. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assign to the resource.
hostPoolId
This property is required.
Changes to this property will trigger replacement.
string
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the Virtual Desktop Application Group. Changing this forces a new resource to be created.
type
This property is required.
Changes to this property will trigger replacement.
string
Type of Virtual Desktop Application Group. Valid options are RemoteApp or Desktop application groups. Changing this forces a new resource to be created.
defaultDesktopDisplayName string
Option to set the display name for the default sessionDesktop desktop when type is set to Desktop. A value here is mandatory for connections to the desktop using the Windows 365 portal. Without it the connection will hang at 'Loading Client'.
description string
Option to set a description for the Virtual Desktop Application Group.
friendlyName string
Option to set a friendly name for the Virtual Desktop Application Group.
location Changes to this property will trigger replacement. string
The location/region where the Virtual Desktop Application Group is located. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
host_pool_id
This property is required.
Changes to this property will trigger replacement.
str
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.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group in which to create the Virtual Desktop Application Group. Changing this forces a new resource to be created.
type
This property is required.
Changes to this property will trigger replacement.
str
Type of Virtual Desktop Application Group. Valid options are RemoteApp or Desktop application groups. Changing this forces a new resource to be created.
default_desktop_display_name str
Option to set the display name for the default sessionDesktop desktop when type is set to Desktop. A value here is mandatory for connections to the desktop using the Windows 365 portal. Without it the connection will hang at 'Loading Client'.
description str
Option to set a description for the Virtual Desktop Application Group.
friendly_name str
Option to set a friendly name for the Virtual Desktop Application Group.
location Changes to this property will trigger replacement. str
The location/region where the Virtual Desktop Application Group is located. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
hostPoolId
This property is required.
Changes to this property will trigger replacement.
String
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the Virtual Desktop Application Group. Changing this forces a new resource to be created.
type
This property is required.
Changes to this property will trigger replacement.
String
Type of Virtual Desktop Application Group. Valid options are RemoteApp or Desktop application groups. Changing this forces a new resource to be created.
defaultDesktopDisplayName String
Option to set the display name for the default sessionDesktop desktop when type is set to Desktop. A value here is mandatory for connections to the desktop using the Windows 365 portal. Without it the connection will hang at 'Loading Client'.
description String
Option to set a description for the Virtual Desktop Application Group.
friendlyName String
Option to set a friendly name for the Virtual Desktop Application Group.
location Changes to this property will trigger replacement. String
The location/region where the Virtual Desktop Application Group is located. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.
tags Map<String>
A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the ApplicationGroup resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ApplicationGroup Resource

Get an existing ApplicationGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ApplicationGroupState, opts?: CustomResourceOptions): ApplicationGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        default_desktop_display_name: Optional[str] = None,
        description: Optional[str] = None,
        friendly_name: Optional[str] = None,
        host_pool_id: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        type: Optional[str] = None) -> ApplicationGroup
func GetApplicationGroup(ctx *Context, name string, id IDInput, state *ApplicationGroupState, opts ...ResourceOption) (*ApplicationGroup, error)
public static ApplicationGroup Get(string name, Input<string> id, ApplicationGroupState? state, CustomResourceOptions? opts = null)
public static ApplicationGroup get(String name, Output<String> id, ApplicationGroupState state, CustomResourceOptions options)
resources:  _:    type: azure:desktopvirtualization:ApplicationGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
DefaultDesktopDisplayName string
Option to set the display name for the default sessionDesktop desktop when type is set to Desktop. A value here is mandatory for connections to the desktop using the Windows 365 portal. Without it the connection will hang at 'Loading Client'.
Description string
Option to set a description for the Virtual Desktop Application Group.
FriendlyName string
Option to set a friendly name for the Virtual Desktop Application Group.
HostPoolId Changes to this property will trigger replacement. string
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.
Location Changes to this property will trigger replacement. string
The location/region where the Virtual Desktop Application Group is located. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the Virtual Desktop Application Group. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
Type Changes to this property will trigger replacement. string
Type of Virtual Desktop Application Group. Valid options are RemoteApp or Desktop application groups. Changing this forces a new resource to be created.
DefaultDesktopDisplayName string
Option to set the display name for the default sessionDesktop desktop when type is set to Desktop. A value here is mandatory for connections to the desktop using the Windows 365 portal. Without it the connection will hang at 'Loading Client'.
Description string
Option to set a description for the Virtual Desktop Application Group.
FriendlyName string
Option to set a friendly name for the Virtual Desktop Application Group.
HostPoolId Changes to this property will trigger replacement. string
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.
Location Changes to this property will trigger replacement. string
The location/region where the Virtual Desktop Application Group is located. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the Virtual Desktop Application Group. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
Type Changes to this property will trigger replacement. string
Type of Virtual Desktop Application Group. Valid options are RemoteApp or Desktop application groups. Changing this forces a new resource to be created.
defaultDesktopDisplayName String
Option to set the display name for the default sessionDesktop desktop when type is set to Desktop. A value here is mandatory for connections to the desktop using the Windows 365 portal. Without it the connection will hang at 'Loading Client'.
description String
Option to set a description for the Virtual Desktop Application Group.
friendlyName String
Option to set a friendly name for the Virtual Desktop Application Group.
hostPoolId Changes to this property will trigger replacement. String
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.
location Changes to this property will trigger replacement. String
The location/region where the Virtual Desktop Application Group is located. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the Virtual Desktop Application Group. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assign to the resource.
type Changes to this property will trigger replacement. String
Type of Virtual Desktop Application Group. Valid options are RemoteApp or Desktop application groups. Changing this forces a new resource to be created.
defaultDesktopDisplayName string
Option to set the display name for the default sessionDesktop desktop when type is set to Desktop. A value here is mandatory for connections to the desktop using the Windows 365 portal. Without it the connection will hang at 'Loading Client'.
description string
Option to set a description for the Virtual Desktop Application Group.
friendlyName string
Option to set a friendly name for the Virtual Desktop Application Group.
hostPoolId Changes to this property will trigger replacement. string
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.
location Changes to this property will trigger replacement. string
The location/region where the Virtual Desktop Application Group is located. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the Virtual Desktop Application Group. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
type Changes to this property will trigger replacement. string
Type of Virtual Desktop Application Group. Valid options are RemoteApp or Desktop application groups. Changing this forces a new resource to be created.
default_desktop_display_name str
Option to set the display name for the default sessionDesktop desktop when type is set to Desktop. A value here is mandatory for connections to the desktop using the Windows 365 portal. Without it the connection will hang at 'Loading Client'.
description str
Option to set a description for the Virtual Desktop Application Group.
friendly_name str
Option to set a friendly name for the Virtual Desktop Application Group.
host_pool_id Changes to this property will trigger replacement. str
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.
location Changes to this property will trigger replacement. str
The location/region where the Virtual Desktop Application Group is located. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group in which to create the Virtual Desktop Application Group. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
type Changes to this property will trigger replacement. str
Type of Virtual Desktop Application Group. Valid options are RemoteApp or Desktop application groups. Changing this forces a new resource to be created.
defaultDesktopDisplayName String
Option to set the display name for the default sessionDesktop desktop when type is set to Desktop. A value here is mandatory for connections to the desktop using the Windows 365 portal. Without it the connection will hang at 'Loading Client'.
description String
Option to set a description for the Virtual Desktop Application Group.
friendlyName String
Option to set a friendly name for the Virtual Desktop Application Group.
hostPoolId Changes to this property will trigger replacement. String
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.
location Changes to this property will trigger replacement. String
The location/region where the Virtual Desktop Application Group is located. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the Virtual Desktop Application Group. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assign to the resource.
type Changes to this property will trigger replacement. String
Type of Virtual Desktop Application Group. Valid options are RemoteApp or Desktop application groups. Changing this forces a new resource to be created.

Import

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

$ pulumi import azure:desktopvirtualization/applicationGroup:ApplicationGroup example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/myapplicationgroup
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure