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

We recommend using Azure Native.

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

azure.desktopvirtualization.HostPool

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 Host Pool.

Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleHostPool = new azure.desktopvirtualization.HostPool("example", {
    location: example.location,
    resourceGroupName: example.name,
    name: "pooleddepthfirst",
    friendlyName: "pooleddepthfirst",
    validateEnvironment: true,
    startVmOnConnect: true,
    customRdpProperties: "audiocapturemode:i:1;audiomode:i:0;",
    description: "Acceptance Test: A pooled host pool - pooleddepthfirst",
    type: "Pooled",
    maximumSessionsAllowed: 50,
    loadBalancerType: "DepthFirst",
    scheduledAgentUpdates: {
        enabled: true,
        schedules: [{
            dayOfWeek: "Saturday",
            hourOfDay: 2,
        }],
    },
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_host_pool = azure.desktopvirtualization.HostPool("example",
    location=example.location,
    resource_group_name=example.name,
    name="pooleddepthfirst",
    friendly_name="pooleddepthfirst",
    validate_environment=True,
    start_vm_on_connect=True,
    custom_rdp_properties="audiocapturemode:i:1;audiomode:i:0;",
    description="Acceptance Test: A pooled host pool - pooleddepthfirst",
    type="Pooled",
    maximum_sessions_allowed=50,
    load_balancer_type="DepthFirst",
    scheduled_agent_updates={
        "enabled": True,
        "schedules": [{
            "day_of_week": "Saturday",
            "hour_of_day": 2,
        }],
    })
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("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = desktopvirtualization.NewHostPool(ctx, "example", &desktopvirtualization.HostPoolArgs{
			Location:               example.Location,
			ResourceGroupName:      example.Name,
			Name:                   pulumi.String("pooleddepthfirst"),
			FriendlyName:           pulumi.String("pooleddepthfirst"),
			ValidateEnvironment:    pulumi.Bool(true),
			StartVmOnConnect:       pulumi.Bool(true),
			CustomRdpProperties:    pulumi.String("audiocapturemode:i:1;audiomode:i:0;"),
			Description:            pulumi.String("Acceptance Test: A pooled host pool - pooleddepthfirst"),
			Type:                   pulumi.String("Pooled"),
			MaximumSessionsAllowed: pulumi.Int(50),
			LoadBalancerType:       pulumi.String("DepthFirst"),
			ScheduledAgentUpdates: &desktopvirtualization.HostPoolScheduledAgentUpdatesArgs{
				Enabled: pulumi.Bool(true),
				Schedules: desktopvirtualization.HostPoolScheduledAgentUpdatesScheduleArray{
					&desktopvirtualization.HostPoolScheduledAgentUpdatesScheduleArgs{
						DayOfWeek: pulumi.String("Saturday"),
						HourOfDay: pulumi.Int(2),
					},
				},
			},
		})
		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 = "example-resources",
        Location = "West Europe",
    });

    var exampleHostPool = new Azure.DesktopVirtualization.HostPool("example", new()
    {
        Location = example.Location,
        ResourceGroupName = example.Name,
        Name = "pooleddepthfirst",
        FriendlyName = "pooleddepthfirst",
        ValidateEnvironment = true,
        StartVmOnConnect = true,
        CustomRdpProperties = "audiocapturemode:i:1;audiomode:i:0;",
        Description = "Acceptance Test: A pooled host pool - pooleddepthfirst",
        Type = "Pooled",
        MaximumSessionsAllowed = 50,
        LoadBalancerType = "DepthFirst",
        ScheduledAgentUpdates = new Azure.DesktopVirtualization.Inputs.HostPoolScheduledAgentUpdatesArgs
        {
            Enabled = true,
            Schedules = new[]
            {
                new Azure.DesktopVirtualization.Inputs.HostPoolScheduledAgentUpdatesScheduleArgs
                {
                    DayOfWeek = "Saturday",
                    HourOfDay = 2,
                },
            },
        },
    });

});
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.inputs.HostPoolScheduledAgentUpdatesArgs;
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("example-resources")
            .location("West Europe")
            .build());

        var exampleHostPool = new HostPool("exampleHostPool", HostPoolArgs.builder()
            .location(example.location())
            .resourceGroupName(example.name())
            .name("pooleddepthfirst")
            .friendlyName("pooleddepthfirst")
            .validateEnvironment(true)
            .startVmOnConnect(true)
            .customRdpProperties("audiocapturemode:i:1;audiomode:i:0;")
            .description("Acceptance Test: A pooled host pool - pooleddepthfirst")
            .type("Pooled")
            .maximumSessionsAllowed(50)
            .loadBalancerType("DepthFirst")
            .scheduledAgentUpdates(HostPoolScheduledAgentUpdatesArgs.builder()
                .enabled(true)
                .schedules(HostPoolScheduledAgentUpdatesScheduleArgs.builder()
                    .dayOfWeek("Saturday")
                    .hourOfDay(2)
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleHostPool:
    type: azure:desktopvirtualization:HostPool
    name: example
    properties:
      location: ${example.location}
      resourceGroupName: ${example.name}
      name: pooleddepthfirst
      friendlyName: pooleddepthfirst
      validateEnvironment: true
      startVmOnConnect: true
      customRdpProperties: audiocapturemode:i:1;audiomode:i:0;
      description: 'Acceptance Test: A pooled host pool - pooleddepthfirst'
      type: Pooled
      maximumSessionsAllowed: 50
      loadBalancerType: DepthFirst
      scheduledAgentUpdates:
        enabled: true
        schedules:
          - dayOfWeek: Saturday
            hourOfDay: 2
Copy

Create HostPool Resource

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

Constructor syntax

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

@overload
def HostPool(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             load_balancer_type: Optional[str] = None,
             type: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             preferred_app_group_type: Optional[str] = None,
             friendly_name: Optional[str] = None,
             maximum_sessions_allowed: Optional[int] = None,
             name: Optional[str] = None,
             personal_desktop_assignment_type: Optional[str] = None,
             custom_rdp_properties: Optional[str] = None,
             public_network_access: Optional[str] = None,
             location: Optional[str] = None,
             scheduled_agent_updates: Optional[HostPoolScheduledAgentUpdatesArgs] = None,
             start_vm_on_connect: Optional[bool] = None,
             tags: Optional[Mapping[str, str]] = None,
             description: Optional[str] = None,
             validate_environment: Optional[bool] = None,
             vm_template: Optional[str] = None)
func NewHostPool(ctx *Context, name string, args HostPoolArgs, opts ...ResourceOption) (*HostPool, error)
public HostPool(string name, HostPoolArgs args, CustomResourceOptions? opts = null)
public HostPool(String name, HostPoolArgs args)
public HostPool(String name, HostPoolArgs args, CustomResourceOptions options)

type: azure:desktopvirtualization:HostPool
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. HostPoolArgs
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. HostPoolArgs
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. HostPoolArgs
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. HostPoolArgs
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. HostPoolArgs
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 hostPoolResource = new Azure.DesktopVirtualization.HostPool("hostPoolResource", new()
{
    LoadBalancerType = "string",
    Type = "string",
    ResourceGroupName = "string",
    PreferredAppGroupType = "string",
    FriendlyName = "string",
    MaximumSessionsAllowed = 0,
    Name = "string",
    PersonalDesktopAssignmentType = "string",
    CustomRdpProperties = "string",
    PublicNetworkAccess = "string",
    Location = "string",
    ScheduledAgentUpdates = new Azure.DesktopVirtualization.Inputs.HostPoolScheduledAgentUpdatesArgs
    {
        Enabled = false,
        Schedules = new[]
        {
            new Azure.DesktopVirtualization.Inputs.HostPoolScheduledAgentUpdatesScheduleArgs
            {
                DayOfWeek = "string",
                HourOfDay = 0,
            },
        },
        Timezone = "string",
        UseSessionHostTimezone = false,
    },
    StartVmOnConnect = false,
    Tags = 
    {
        { "string", "string" },
    },
    Description = "string",
    ValidateEnvironment = false,
    VmTemplate = "string",
});
Copy
example, err := desktopvirtualization.NewHostPool(ctx, "hostPoolResource", &desktopvirtualization.HostPoolArgs{
	LoadBalancerType:              pulumi.String("string"),
	Type:                          pulumi.String("string"),
	ResourceGroupName:             pulumi.String("string"),
	PreferredAppGroupType:         pulumi.String("string"),
	FriendlyName:                  pulumi.String("string"),
	MaximumSessionsAllowed:        pulumi.Int(0),
	Name:                          pulumi.String("string"),
	PersonalDesktopAssignmentType: pulumi.String("string"),
	CustomRdpProperties:           pulumi.String("string"),
	PublicNetworkAccess:           pulumi.String("string"),
	Location:                      pulumi.String("string"),
	ScheduledAgentUpdates: &desktopvirtualization.HostPoolScheduledAgentUpdatesArgs{
		Enabled: pulumi.Bool(false),
		Schedules: desktopvirtualization.HostPoolScheduledAgentUpdatesScheduleArray{
			&desktopvirtualization.HostPoolScheduledAgentUpdatesScheduleArgs{
				DayOfWeek: pulumi.String("string"),
				HourOfDay: pulumi.Int(0),
			},
		},
		Timezone:               pulumi.String("string"),
		UseSessionHostTimezone: pulumi.Bool(false),
	},
	StartVmOnConnect: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description:         pulumi.String("string"),
	ValidateEnvironment: pulumi.Bool(false),
	VmTemplate:          pulumi.String("string"),
})
Copy
var hostPoolResource = new HostPool("hostPoolResource", HostPoolArgs.builder()
    .loadBalancerType("string")
    .type("string")
    .resourceGroupName("string")
    .preferredAppGroupType("string")
    .friendlyName("string")
    .maximumSessionsAllowed(0)
    .name("string")
    .personalDesktopAssignmentType("string")
    .customRdpProperties("string")
    .publicNetworkAccess("string")
    .location("string")
    .scheduledAgentUpdates(HostPoolScheduledAgentUpdatesArgs.builder()
        .enabled(false)
        .schedules(HostPoolScheduledAgentUpdatesScheduleArgs.builder()
            .dayOfWeek("string")
            .hourOfDay(0)
            .build())
        .timezone("string")
        .useSessionHostTimezone(false)
        .build())
    .startVmOnConnect(false)
    .tags(Map.of("string", "string"))
    .description("string")
    .validateEnvironment(false)
    .vmTemplate("string")
    .build());
Copy
host_pool_resource = azure.desktopvirtualization.HostPool("hostPoolResource",
    load_balancer_type="string",
    type="string",
    resource_group_name="string",
    preferred_app_group_type="string",
    friendly_name="string",
    maximum_sessions_allowed=0,
    name="string",
    personal_desktop_assignment_type="string",
    custom_rdp_properties="string",
    public_network_access="string",
    location="string",
    scheduled_agent_updates={
        "enabled": False,
        "schedules": [{
            "day_of_week": "string",
            "hour_of_day": 0,
        }],
        "timezone": "string",
        "use_session_host_timezone": False,
    },
    start_vm_on_connect=False,
    tags={
        "string": "string",
    },
    description="string",
    validate_environment=False,
    vm_template="string")
Copy
const hostPoolResource = new azure.desktopvirtualization.HostPool("hostPoolResource", {
    loadBalancerType: "string",
    type: "string",
    resourceGroupName: "string",
    preferredAppGroupType: "string",
    friendlyName: "string",
    maximumSessionsAllowed: 0,
    name: "string",
    personalDesktopAssignmentType: "string",
    customRdpProperties: "string",
    publicNetworkAccess: "string",
    location: "string",
    scheduledAgentUpdates: {
        enabled: false,
        schedules: [{
            dayOfWeek: "string",
            hourOfDay: 0,
        }],
        timezone: "string",
        useSessionHostTimezone: false,
    },
    startVmOnConnect: false,
    tags: {
        string: "string",
    },
    description: "string",
    validateEnvironment: false,
    vmTemplate: "string",
});
Copy
type: azure:desktopvirtualization:HostPool
properties:
    customRdpProperties: string
    description: string
    friendlyName: string
    loadBalancerType: string
    location: string
    maximumSessionsAllowed: 0
    name: string
    personalDesktopAssignmentType: string
    preferredAppGroupType: string
    publicNetworkAccess: string
    resourceGroupName: string
    scheduledAgentUpdates:
        enabled: false
        schedules:
            - dayOfWeek: string
              hourOfDay: 0
        timezone: string
        useSessionHostTimezone: false
    startVmOnConnect: false
    tags:
        string: string
    type: string
    validateEnvironment: false
    vmTemplate: string
Copy

HostPool 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 HostPool resource accepts the following input properties:

LoadBalancerType This property is required. string
BreadthFirst load balancing distributes new user sessions across all available session hosts in the host pool. Possible values are BreadthFirst, DepthFirst and Persistent. DepthFirst load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold. Persistent should be used if the host pool type is Personal
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 Host Pool. Changing this forces a new resource to be created.
Type
This property is required.
Changes to this property will trigger replacement.
string
The type of the Virtual Desktop Host Pool. Valid options are Personal or Pooled. Changing the type forces a new resource to be created.
CustomRdpProperties string
A valid custom RDP properties string for the Virtual Desktop Host Pool, available properties can be found in this article.
Description string
A description for the Virtual Desktop Host Pool.
FriendlyName string
A friendly name for the Virtual Desktop Host Pool.
Location Changes to this property will trigger replacement. string
The location/region where the Virtual Desktop Host Pool is located. Changing this forces a new resource to be created.
MaximumSessionsAllowed int
A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host. Should only be set if the type of your Virtual Desktop Host Pool is Pooled.
Name Changes to this property will trigger replacement. string
The name of the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
PersonalDesktopAssignmentType Changes to this property will trigger replacement. string

Automatic assignment – The service will select an available host and assign it to an user. Possible values are Automatic and Direct. Direct Assignment – Admin selects a specific host to assign to an user. Changing this forces a new resource to be created.

NOTE: personal_desktop_assignment_type is required if the type of your Virtual Desktop Host Pool is Personal

PreferredAppGroupType string
Option to specify the preferred Application Group type for the Virtual Desktop Host Pool. Valid options are None, Desktop or RailApplications. Default is Desktop.
PublicNetworkAccess string
Whether public network access is allowed for the Virtual Desktop Host Pool. Possible values are Enabled, Disabled, EnabledForClientsOnly and EnabledForSessionHostsOnly. Defaults to Enabled.
ScheduledAgentUpdates HostPoolScheduledAgentUpdates
A scheduled_agent_updates block as defined below. This enables control of when Agent Updates will be applied to Session Hosts.
StartVmOnConnect bool
Enables or disables the Start VM on Connection Feature. Defaults to false.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
ValidateEnvironment bool
Allows you to test service changes before they are deployed to production. Defaults to false.
VmTemplate string
A VM template for session hosts configuration within hostpool. This is a JSON string.
LoadBalancerType This property is required. string
BreadthFirst load balancing distributes new user sessions across all available session hosts in the host pool. Possible values are BreadthFirst, DepthFirst and Persistent. DepthFirst load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold. Persistent should be used if the host pool type is Personal
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 Host Pool. Changing this forces a new resource to be created.
Type
This property is required.
Changes to this property will trigger replacement.
string
The type of the Virtual Desktop Host Pool. Valid options are Personal or Pooled. Changing the type forces a new resource to be created.
CustomRdpProperties string
A valid custom RDP properties string for the Virtual Desktop Host Pool, available properties can be found in this article.
Description string
A description for the Virtual Desktop Host Pool.
FriendlyName string
A friendly name for the Virtual Desktop Host Pool.
Location Changes to this property will trigger replacement. string
The location/region where the Virtual Desktop Host Pool is located. Changing this forces a new resource to be created.
MaximumSessionsAllowed int
A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host. Should only be set if the type of your Virtual Desktop Host Pool is Pooled.
Name Changes to this property will trigger replacement. string
The name of the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
PersonalDesktopAssignmentType Changes to this property will trigger replacement. string

Automatic assignment – The service will select an available host and assign it to an user. Possible values are Automatic and Direct. Direct Assignment – Admin selects a specific host to assign to an user. Changing this forces a new resource to be created.

NOTE: personal_desktop_assignment_type is required if the type of your Virtual Desktop Host Pool is Personal

PreferredAppGroupType string
Option to specify the preferred Application Group type for the Virtual Desktop Host Pool. Valid options are None, Desktop or RailApplications. Default is Desktop.
PublicNetworkAccess string
Whether public network access is allowed for the Virtual Desktop Host Pool. Possible values are Enabled, Disabled, EnabledForClientsOnly and EnabledForSessionHostsOnly. Defaults to Enabled.
ScheduledAgentUpdates HostPoolScheduledAgentUpdatesArgs
A scheduled_agent_updates block as defined below. This enables control of when Agent Updates will be applied to Session Hosts.
StartVmOnConnect bool
Enables or disables the Start VM on Connection Feature. Defaults to false.
Tags map[string]string
A mapping of tags to assign to the resource.
ValidateEnvironment bool
Allows you to test service changes before they are deployed to production. Defaults to false.
VmTemplate string
A VM template for session hosts configuration within hostpool. This is a JSON string.
loadBalancerType This property is required. String
BreadthFirst load balancing distributes new user sessions across all available session hosts in the host pool. Possible values are BreadthFirst, DepthFirst and Persistent. DepthFirst load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold. Persistent should be used if the host pool type is Personal
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 Host Pool. Changing this forces a new resource to be created.
type
This property is required.
Changes to this property will trigger replacement.
String
The type of the Virtual Desktop Host Pool. Valid options are Personal or Pooled. Changing the type forces a new resource to be created.
customRdpProperties String
A valid custom RDP properties string for the Virtual Desktop Host Pool, available properties can be found in this article.
description String
A description for the Virtual Desktop Host Pool.
friendlyName String
A friendly name for the Virtual Desktop Host Pool.
location Changes to this property will trigger replacement. String
The location/region where the Virtual Desktop Host Pool is located. Changing this forces a new resource to be created.
maximumSessionsAllowed Integer
A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host. Should only be set if the type of your Virtual Desktop Host Pool is Pooled.
name Changes to this property will trigger replacement. String
The name of the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
personalDesktopAssignmentType Changes to this property will trigger replacement. String

Automatic assignment – The service will select an available host and assign it to an user. Possible values are Automatic and Direct. Direct Assignment – Admin selects a specific host to assign to an user. Changing this forces a new resource to be created.

NOTE: personal_desktop_assignment_type is required if the type of your Virtual Desktop Host Pool is Personal

preferredAppGroupType String
Option to specify the preferred Application Group type for the Virtual Desktop Host Pool. Valid options are None, Desktop or RailApplications. Default is Desktop.
publicNetworkAccess String
Whether public network access is allowed for the Virtual Desktop Host Pool. Possible values are Enabled, Disabled, EnabledForClientsOnly and EnabledForSessionHostsOnly. Defaults to Enabled.
scheduledAgentUpdates HostPoolScheduledAgentUpdates
A scheduled_agent_updates block as defined below. This enables control of when Agent Updates will be applied to Session Hosts.
startVmOnConnect Boolean
Enables or disables the Start VM on Connection Feature. Defaults to false.
tags Map<String,String>
A mapping of tags to assign to the resource.
validateEnvironment Boolean
Allows you to test service changes before they are deployed to production. Defaults to false.
vmTemplate String
A VM template for session hosts configuration within hostpool. This is a JSON string.
loadBalancerType This property is required. string
BreadthFirst load balancing distributes new user sessions across all available session hosts in the host pool. Possible values are BreadthFirst, DepthFirst and Persistent. DepthFirst load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold. Persistent should be used if the host pool type is Personal
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 Host Pool. Changing this forces a new resource to be created.
type
This property is required.
Changes to this property will trigger replacement.
string
The type of the Virtual Desktop Host Pool. Valid options are Personal or Pooled. Changing the type forces a new resource to be created.
customRdpProperties string
A valid custom RDP properties string for the Virtual Desktop Host Pool, available properties can be found in this article.
description string
A description for the Virtual Desktop Host Pool.
friendlyName string
A friendly name for the Virtual Desktop Host Pool.
location Changes to this property will trigger replacement. string
The location/region where the Virtual Desktop Host Pool is located. Changing this forces a new resource to be created.
maximumSessionsAllowed number
A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host. Should only be set if the type of your Virtual Desktop Host Pool is Pooled.
name Changes to this property will trigger replacement. string
The name of the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
personalDesktopAssignmentType Changes to this property will trigger replacement. string

Automatic assignment – The service will select an available host and assign it to an user. Possible values are Automatic and Direct. Direct Assignment – Admin selects a specific host to assign to an user. Changing this forces a new resource to be created.

NOTE: personal_desktop_assignment_type is required if the type of your Virtual Desktop Host Pool is Personal

preferredAppGroupType string
Option to specify the preferred Application Group type for the Virtual Desktop Host Pool. Valid options are None, Desktop or RailApplications. Default is Desktop.
publicNetworkAccess string
Whether public network access is allowed for the Virtual Desktop Host Pool. Possible values are Enabled, Disabled, EnabledForClientsOnly and EnabledForSessionHostsOnly. Defaults to Enabled.
scheduledAgentUpdates HostPoolScheduledAgentUpdates
A scheduled_agent_updates block as defined below. This enables control of when Agent Updates will be applied to Session Hosts.
startVmOnConnect boolean
Enables or disables the Start VM on Connection Feature. Defaults to false.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
validateEnvironment boolean
Allows you to test service changes before they are deployed to production. Defaults to false.
vmTemplate string
A VM template for session hosts configuration within hostpool. This is a JSON string.
load_balancer_type This property is required. str
BreadthFirst load balancing distributes new user sessions across all available session hosts in the host pool. Possible values are BreadthFirst, DepthFirst and Persistent. DepthFirst load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold. Persistent should be used if the host pool type is Personal
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 Host Pool. Changing this forces a new resource to be created.
type
This property is required.
Changes to this property will trigger replacement.
str
The type of the Virtual Desktop Host Pool. Valid options are Personal or Pooled. Changing the type forces a new resource to be created.
custom_rdp_properties str
A valid custom RDP properties string for the Virtual Desktop Host Pool, available properties can be found in this article.
description str
A description for the Virtual Desktop Host Pool.
friendly_name str
A friendly name for the Virtual Desktop Host Pool.
location Changes to this property will trigger replacement. str
The location/region where the Virtual Desktop Host Pool is located. Changing this forces a new resource to be created.
maximum_sessions_allowed int
A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host. Should only be set if the type of your Virtual Desktop Host Pool is Pooled.
name Changes to this property will trigger replacement. str
The name of the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
personal_desktop_assignment_type Changes to this property will trigger replacement. str

Automatic assignment – The service will select an available host and assign it to an user. Possible values are Automatic and Direct. Direct Assignment – Admin selects a specific host to assign to an user. Changing this forces a new resource to be created.

NOTE: personal_desktop_assignment_type is required if the type of your Virtual Desktop Host Pool is Personal

preferred_app_group_type str
Option to specify the preferred Application Group type for the Virtual Desktop Host Pool. Valid options are None, Desktop or RailApplications. Default is Desktop.
public_network_access str
Whether public network access is allowed for the Virtual Desktop Host Pool. Possible values are Enabled, Disabled, EnabledForClientsOnly and EnabledForSessionHostsOnly. Defaults to Enabled.
scheduled_agent_updates HostPoolScheduledAgentUpdatesArgs
A scheduled_agent_updates block as defined below. This enables control of when Agent Updates will be applied to Session Hosts.
start_vm_on_connect bool
Enables or disables the Start VM on Connection Feature. Defaults to false.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
validate_environment bool
Allows you to test service changes before they are deployed to production. Defaults to false.
vm_template str
A VM template for session hosts configuration within hostpool. This is a JSON string.
loadBalancerType This property is required. String
BreadthFirst load balancing distributes new user sessions across all available session hosts in the host pool. Possible values are BreadthFirst, DepthFirst and Persistent. DepthFirst load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold. Persistent should be used if the host pool type is Personal
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 Host Pool. Changing this forces a new resource to be created.
type
This property is required.
Changes to this property will trigger replacement.
String
The type of the Virtual Desktop Host Pool. Valid options are Personal or Pooled. Changing the type forces a new resource to be created.
customRdpProperties String
A valid custom RDP properties string for the Virtual Desktop Host Pool, available properties can be found in this article.
description String
A description for the Virtual Desktop Host Pool.
friendlyName String
A friendly name for the Virtual Desktop Host Pool.
location Changes to this property will trigger replacement. String
The location/region where the Virtual Desktop Host Pool is located. Changing this forces a new resource to be created.
maximumSessionsAllowed Number
A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host. Should only be set if the type of your Virtual Desktop Host Pool is Pooled.
name Changes to this property will trigger replacement. String
The name of the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
personalDesktopAssignmentType Changes to this property will trigger replacement. String

Automatic assignment – The service will select an available host and assign it to an user. Possible values are Automatic and Direct. Direct Assignment – Admin selects a specific host to assign to an user. Changing this forces a new resource to be created.

NOTE: personal_desktop_assignment_type is required if the type of your Virtual Desktop Host Pool is Personal

preferredAppGroupType String
Option to specify the preferred Application Group type for the Virtual Desktop Host Pool. Valid options are None, Desktop or RailApplications. Default is Desktop.
publicNetworkAccess String
Whether public network access is allowed for the Virtual Desktop Host Pool. Possible values are Enabled, Disabled, EnabledForClientsOnly and EnabledForSessionHostsOnly. Defaults to Enabled.
scheduledAgentUpdates Property Map
A scheduled_agent_updates block as defined below. This enables control of when Agent Updates will be applied to Session Hosts.
startVmOnConnect Boolean
Enables or disables the Start VM on Connection Feature. Defaults to false.
tags Map<String>
A mapping of tags to assign to the resource.
validateEnvironment Boolean
Allows you to test service changes before they are deployed to production. Defaults to false.
vmTemplate String
A VM template for session hosts configuration within hostpool. This is a JSON string.

Outputs

All input properties are implicitly available as output properties. Additionally, the HostPool 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 HostPool Resource

Get an existing HostPool 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?: HostPoolState, opts?: CustomResourceOptions): HostPool
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_rdp_properties: Optional[str] = None,
        description: Optional[str] = None,
        friendly_name: Optional[str] = None,
        load_balancer_type: Optional[str] = None,
        location: Optional[str] = None,
        maximum_sessions_allowed: Optional[int] = None,
        name: Optional[str] = None,
        personal_desktop_assignment_type: Optional[str] = None,
        preferred_app_group_type: Optional[str] = None,
        public_network_access: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        scheduled_agent_updates: Optional[HostPoolScheduledAgentUpdatesArgs] = None,
        start_vm_on_connect: Optional[bool] = None,
        tags: Optional[Mapping[str, str]] = None,
        type: Optional[str] = None,
        validate_environment: Optional[bool] = None,
        vm_template: Optional[str] = None) -> HostPool
func GetHostPool(ctx *Context, name string, id IDInput, state *HostPoolState, opts ...ResourceOption) (*HostPool, error)
public static HostPool Get(string name, Input<string> id, HostPoolState? state, CustomResourceOptions? opts = null)
public static HostPool get(String name, Output<String> id, HostPoolState state, CustomResourceOptions options)
resources:  _:    type: azure:desktopvirtualization:HostPool    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:
CustomRdpProperties string
A valid custom RDP properties string for the Virtual Desktop Host Pool, available properties can be found in this article.
Description string
A description for the Virtual Desktop Host Pool.
FriendlyName string
A friendly name for the Virtual Desktop Host Pool.
LoadBalancerType string
BreadthFirst load balancing distributes new user sessions across all available session hosts in the host pool. Possible values are BreadthFirst, DepthFirst and Persistent. DepthFirst load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold. Persistent should be used if the host pool type is Personal
Location Changes to this property will trigger replacement. string
The location/region where the Virtual Desktop Host Pool is located. Changing this forces a new resource to be created.
MaximumSessionsAllowed int
A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host. Should only be set if the type of your Virtual Desktop Host Pool is Pooled.
Name Changes to this property will trigger replacement. string
The name of the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
PersonalDesktopAssignmentType Changes to this property will trigger replacement. string

Automatic assignment – The service will select an available host and assign it to an user. Possible values are Automatic and Direct. Direct Assignment – Admin selects a specific host to assign to an user. Changing this forces a new resource to be created.

NOTE: personal_desktop_assignment_type is required if the type of your Virtual Desktop Host Pool is Personal

PreferredAppGroupType string
Option to specify the preferred Application Group type for the Virtual Desktop Host Pool. Valid options are None, Desktop or RailApplications. Default is Desktop.
PublicNetworkAccess string
Whether public network access is allowed for the Virtual Desktop Host Pool. Possible values are Enabled, Disabled, EnabledForClientsOnly and EnabledForSessionHostsOnly. Defaults to Enabled.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
ScheduledAgentUpdates HostPoolScheduledAgentUpdates
A scheduled_agent_updates block as defined below. This enables control of when Agent Updates will be applied to Session Hosts.
StartVmOnConnect bool
Enables or disables the Start VM on Connection Feature. Defaults to false.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
Type Changes to this property will trigger replacement. string
The type of the Virtual Desktop Host Pool. Valid options are Personal or Pooled. Changing the type forces a new resource to be created.
ValidateEnvironment bool
Allows you to test service changes before they are deployed to production. Defaults to false.
VmTemplate string
A VM template for session hosts configuration within hostpool. This is a JSON string.
CustomRdpProperties string
A valid custom RDP properties string for the Virtual Desktop Host Pool, available properties can be found in this article.
Description string
A description for the Virtual Desktop Host Pool.
FriendlyName string
A friendly name for the Virtual Desktop Host Pool.
LoadBalancerType string
BreadthFirst load balancing distributes new user sessions across all available session hosts in the host pool. Possible values are BreadthFirst, DepthFirst and Persistent. DepthFirst load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold. Persistent should be used if the host pool type is Personal
Location Changes to this property will trigger replacement. string
The location/region where the Virtual Desktop Host Pool is located. Changing this forces a new resource to be created.
MaximumSessionsAllowed int
A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host. Should only be set if the type of your Virtual Desktop Host Pool is Pooled.
Name Changes to this property will trigger replacement. string
The name of the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
PersonalDesktopAssignmentType Changes to this property will trigger replacement. string

Automatic assignment – The service will select an available host and assign it to an user. Possible values are Automatic and Direct. Direct Assignment – Admin selects a specific host to assign to an user. Changing this forces a new resource to be created.

NOTE: personal_desktop_assignment_type is required if the type of your Virtual Desktop Host Pool is Personal

PreferredAppGroupType string
Option to specify the preferred Application Group type for the Virtual Desktop Host Pool. Valid options are None, Desktop or RailApplications. Default is Desktop.
PublicNetworkAccess string
Whether public network access is allowed for the Virtual Desktop Host Pool. Possible values are Enabled, Disabled, EnabledForClientsOnly and EnabledForSessionHostsOnly. Defaults to Enabled.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
ScheduledAgentUpdates HostPoolScheduledAgentUpdatesArgs
A scheduled_agent_updates block as defined below. This enables control of when Agent Updates will be applied to Session Hosts.
StartVmOnConnect bool
Enables or disables the Start VM on Connection Feature. Defaults to false.
Tags map[string]string
A mapping of tags to assign to the resource.
Type Changes to this property will trigger replacement. string
The type of the Virtual Desktop Host Pool. Valid options are Personal or Pooled. Changing the type forces a new resource to be created.
ValidateEnvironment bool
Allows you to test service changes before they are deployed to production. Defaults to false.
VmTemplate string
A VM template for session hosts configuration within hostpool. This is a JSON string.
customRdpProperties String
A valid custom RDP properties string for the Virtual Desktop Host Pool, available properties can be found in this article.
description String
A description for the Virtual Desktop Host Pool.
friendlyName String
A friendly name for the Virtual Desktop Host Pool.
loadBalancerType String
BreadthFirst load balancing distributes new user sessions across all available session hosts in the host pool. Possible values are BreadthFirst, DepthFirst and Persistent. DepthFirst load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold. Persistent should be used if the host pool type is Personal
location Changes to this property will trigger replacement. String
The location/region where the Virtual Desktop Host Pool is located. Changing this forces a new resource to be created.
maximumSessionsAllowed Integer
A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host. Should only be set if the type of your Virtual Desktop Host Pool is Pooled.
name Changes to this property will trigger replacement. String
The name of the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
personalDesktopAssignmentType Changes to this property will trigger replacement. String

Automatic assignment – The service will select an available host and assign it to an user. Possible values are Automatic and Direct. Direct Assignment – Admin selects a specific host to assign to an user. Changing this forces a new resource to be created.

NOTE: personal_desktop_assignment_type is required if the type of your Virtual Desktop Host Pool is Personal

preferredAppGroupType String
Option to specify the preferred Application Group type for the Virtual Desktop Host Pool. Valid options are None, Desktop or RailApplications. Default is Desktop.
publicNetworkAccess String
Whether public network access is allowed for the Virtual Desktop Host Pool. Possible values are Enabled, Disabled, EnabledForClientsOnly and EnabledForSessionHostsOnly. Defaults to Enabled.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
scheduledAgentUpdates HostPoolScheduledAgentUpdates
A scheduled_agent_updates block as defined below. This enables control of when Agent Updates will be applied to Session Hosts.
startVmOnConnect Boolean
Enables or disables the Start VM on Connection Feature. Defaults to false.
tags Map<String,String>
A mapping of tags to assign to the resource.
type Changes to this property will trigger replacement. String
The type of the Virtual Desktop Host Pool. Valid options are Personal or Pooled. Changing the type forces a new resource to be created.
validateEnvironment Boolean
Allows you to test service changes before they are deployed to production. Defaults to false.
vmTemplate String
A VM template for session hosts configuration within hostpool. This is a JSON string.
customRdpProperties string
A valid custom RDP properties string for the Virtual Desktop Host Pool, available properties can be found in this article.
description string
A description for the Virtual Desktop Host Pool.
friendlyName string
A friendly name for the Virtual Desktop Host Pool.
loadBalancerType string
BreadthFirst load balancing distributes new user sessions across all available session hosts in the host pool. Possible values are BreadthFirst, DepthFirst and Persistent. DepthFirst load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold. Persistent should be used if the host pool type is Personal
location Changes to this property will trigger replacement. string
The location/region where the Virtual Desktop Host Pool is located. Changing this forces a new resource to be created.
maximumSessionsAllowed number
A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host. Should only be set if the type of your Virtual Desktop Host Pool is Pooled.
name Changes to this property will trigger replacement. string
The name of the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
personalDesktopAssignmentType Changes to this property will trigger replacement. string

Automatic assignment – The service will select an available host and assign it to an user. Possible values are Automatic and Direct. Direct Assignment – Admin selects a specific host to assign to an user. Changing this forces a new resource to be created.

NOTE: personal_desktop_assignment_type is required if the type of your Virtual Desktop Host Pool is Personal

preferredAppGroupType string
Option to specify the preferred Application Group type for the Virtual Desktop Host Pool. Valid options are None, Desktop or RailApplications. Default is Desktop.
publicNetworkAccess string
Whether public network access is allowed for the Virtual Desktop Host Pool. Possible values are Enabled, Disabled, EnabledForClientsOnly and EnabledForSessionHostsOnly. Defaults to Enabled.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
scheduledAgentUpdates HostPoolScheduledAgentUpdates
A scheduled_agent_updates block as defined below. This enables control of when Agent Updates will be applied to Session Hosts.
startVmOnConnect boolean
Enables or disables the Start VM on Connection Feature. Defaults to false.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
type Changes to this property will trigger replacement. string
The type of the Virtual Desktop Host Pool. Valid options are Personal or Pooled. Changing the type forces a new resource to be created.
validateEnvironment boolean
Allows you to test service changes before they are deployed to production. Defaults to false.
vmTemplate string
A VM template for session hosts configuration within hostpool. This is a JSON string.
custom_rdp_properties str
A valid custom RDP properties string for the Virtual Desktop Host Pool, available properties can be found in this article.
description str
A description for the Virtual Desktop Host Pool.
friendly_name str
A friendly name for the Virtual Desktop Host Pool.
load_balancer_type str
BreadthFirst load balancing distributes new user sessions across all available session hosts in the host pool. Possible values are BreadthFirst, DepthFirst and Persistent. DepthFirst load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold. Persistent should be used if the host pool type is Personal
location Changes to this property will trigger replacement. str
The location/region where the Virtual Desktop Host Pool is located. Changing this forces a new resource to be created.
maximum_sessions_allowed int
A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host. Should only be set if the type of your Virtual Desktop Host Pool is Pooled.
name Changes to this property will trigger replacement. str
The name of the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
personal_desktop_assignment_type Changes to this property will trigger replacement. str

Automatic assignment – The service will select an available host and assign it to an user. Possible values are Automatic and Direct. Direct Assignment – Admin selects a specific host to assign to an user. Changing this forces a new resource to be created.

NOTE: personal_desktop_assignment_type is required if the type of your Virtual Desktop Host Pool is Personal

preferred_app_group_type str
Option to specify the preferred Application Group type for the Virtual Desktop Host Pool. Valid options are None, Desktop or RailApplications. Default is Desktop.
public_network_access str
Whether public network access is allowed for the Virtual Desktop Host Pool. Possible values are Enabled, Disabled, EnabledForClientsOnly and EnabledForSessionHostsOnly. Defaults to Enabled.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group in which to create the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
scheduled_agent_updates HostPoolScheduledAgentUpdatesArgs
A scheduled_agent_updates block as defined below. This enables control of when Agent Updates will be applied to Session Hosts.
start_vm_on_connect bool
Enables or disables the Start VM on Connection Feature. Defaults to false.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
type Changes to this property will trigger replacement. str
The type of the Virtual Desktop Host Pool. Valid options are Personal or Pooled. Changing the type forces a new resource to be created.
validate_environment bool
Allows you to test service changes before they are deployed to production. Defaults to false.
vm_template str
A VM template for session hosts configuration within hostpool. This is a JSON string.
customRdpProperties String
A valid custom RDP properties string for the Virtual Desktop Host Pool, available properties can be found in this article.
description String
A description for the Virtual Desktop Host Pool.
friendlyName String
A friendly name for the Virtual Desktop Host Pool.
loadBalancerType String
BreadthFirst load balancing distributes new user sessions across all available session hosts in the host pool. Possible values are BreadthFirst, DepthFirst and Persistent. DepthFirst load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold. Persistent should be used if the host pool type is Personal
location Changes to this property will trigger replacement. String
The location/region where the Virtual Desktop Host Pool is located. Changing this forces a new resource to be created.
maximumSessionsAllowed Number
A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host. Should only be set if the type of your Virtual Desktop Host Pool is Pooled.
name Changes to this property will trigger replacement. String
The name of the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
personalDesktopAssignmentType Changes to this property will trigger replacement. String

Automatic assignment – The service will select an available host and assign it to an user. Possible values are Automatic and Direct. Direct Assignment – Admin selects a specific host to assign to an user. Changing this forces a new resource to be created.

NOTE: personal_desktop_assignment_type is required if the type of your Virtual Desktop Host Pool is Personal

preferredAppGroupType String
Option to specify the preferred Application Group type for the Virtual Desktop Host Pool. Valid options are None, Desktop or RailApplications. Default is Desktop.
publicNetworkAccess String
Whether public network access is allowed for the Virtual Desktop Host Pool. Possible values are Enabled, Disabled, EnabledForClientsOnly and EnabledForSessionHostsOnly. Defaults to Enabled.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
scheduledAgentUpdates Property Map
A scheduled_agent_updates block as defined below. This enables control of when Agent Updates will be applied to Session Hosts.
startVmOnConnect Boolean
Enables or disables the Start VM on Connection Feature. Defaults to false.
tags Map<String>
A mapping of tags to assign to the resource.
type Changes to this property will trigger replacement. String
The type of the Virtual Desktop Host Pool. Valid options are Personal or Pooled. Changing the type forces a new resource to be created.
validateEnvironment Boolean
Allows you to test service changes before they are deployed to production. Defaults to false.
vmTemplate String
A VM template for session hosts configuration within hostpool. This is a JSON string.

Supporting Types

HostPoolScheduledAgentUpdates
, HostPoolScheduledAgentUpdatesArgs

Enabled bool

Enables or disables scheduled updates of the AVD agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) on session hosts. If this is enabled then up to two schedule blocks must be defined. Default is false.

NOTE: if enabled is set to true then at least one and a maximum of two schedule blocks must be provided.

Schedules List<HostPoolScheduledAgentUpdatesSchedule>
A schedule block as defined below. A maximum of two blocks can be added.
Timezone string
Specifies the time zone in which the agent update schedule will apply, the possible values are defined here. If use_session_host_timezone is enabled then it will override this setting. Default is UTC
UseSessionHostTimezone bool
Specifies whether scheduled agent updates should be applied based on the timezone of the affected session host. If configured then this setting overrides timezone. Default is false.
Enabled bool

Enables or disables scheduled updates of the AVD agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) on session hosts. If this is enabled then up to two schedule blocks must be defined. Default is false.

NOTE: if enabled is set to true then at least one and a maximum of two schedule blocks must be provided.

Schedules []HostPoolScheduledAgentUpdatesSchedule
A schedule block as defined below. A maximum of two blocks can be added.
Timezone string
Specifies the time zone in which the agent update schedule will apply, the possible values are defined here. If use_session_host_timezone is enabled then it will override this setting. Default is UTC
UseSessionHostTimezone bool
Specifies whether scheduled agent updates should be applied based on the timezone of the affected session host. If configured then this setting overrides timezone. Default is false.
enabled Boolean

Enables or disables scheduled updates of the AVD agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) on session hosts. If this is enabled then up to two schedule blocks must be defined. Default is false.

NOTE: if enabled is set to true then at least one and a maximum of two schedule blocks must be provided.

schedules List<HostPoolScheduledAgentUpdatesSchedule>
A schedule block as defined below. A maximum of two blocks can be added.
timezone String
Specifies the time zone in which the agent update schedule will apply, the possible values are defined here. If use_session_host_timezone is enabled then it will override this setting. Default is UTC
useSessionHostTimezone Boolean
Specifies whether scheduled agent updates should be applied based on the timezone of the affected session host. If configured then this setting overrides timezone. Default is false.
enabled boolean

Enables or disables scheduled updates of the AVD agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) on session hosts. If this is enabled then up to two schedule blocks must be defined. Default is false.

NOTE: if enabled is set to true then at least one and a maximum of two schedule blocks must be provided.

schedules HostPoolScheduledAgentUpdatesSchedule[]
A schedule block as defined below. A maximum of two blocks can be added.
timezone string
Specifies the time zone in which the agent update schedule will apply, the possible values are defined here. If use_session_host_timezone is enabled then it will override this setting. Default is UTC
useSessionHostTimezone boolean
Specifies whether scheduled agent updates should be applied based on the timezone of the affected session host. If configured then this setting overrides timezone. Default is false.
enabled bool

Enables or disables scheduled updates of the AVD agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) on session hosts. If this is enabled then up to two schedule blocks must be defined. Default is false.

NOTE: if enabled is set to true then at least one and a maximum of two schedule blocks must be provided.

schedules Sequence[HostPoolScheduledAgentUpdatesSchedule]
A schedule block as defined below. A maximum of two blocks can be added.
timezone str
Specifies the time zone in which the agent update schedule will apply, the possible values are defined here. If use_session_host_timezone is enabled then it will override this setting. Default is UTC
use_session_host_timezone bool
Specifies whether scheduled agent updates should be applied based on the timezone of the affected session host. If configured then this setting overrides timezone. Default is false.
enabled Boolean

Enables or disables scheduled updates of the AVD agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) on session hosts. If this is enabled then up to two schedule blocks must be defined. Default is false.

NOTE: if enabled is set to true then at least one and a maximum of two schedule blocks must be provided.

schedules List<Property Map>
A schedule block as defined below. A maximum of two blocks can be added.
timezone String
Specifies the time zone in which the agent update schedule will apply, the possible values are defined here. If use_session_host_timezone is enabled then it will override this setting. Default is UTC
useSessionHostTimezone Boolean
Specifies whether scheduled agent updates should be applied based on the timezone of the affected session host. If configured then this setting overrides timezone. Default is false.

HostPoolScheduledAgentUpdatesSchedule
, HostPoolScheduledAgentUpdatesScheduleArgs

DayOfWeek This property is required. string
The day of the week on which agent updates should be performed. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday
HourOfDay This property is required. int
The hour of day the update window should start. The update is a 2 hour period following the hour provided. The value should be provided as a number between 0 and 23, with 0 being midnight and 23 being 11pm. A leading zero should not be used.
DayOfWeek This property is required. string
The day of the week on which agent updates should be performed. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday
HourOfDay This property is required. int
The hour of day the update window should start. The update is a 2 hour period following the hour provided. The value should be provided as a number between 0 and 23, with 0 being midnight and 23 being 11pm. A leading zero should not be used.
dayOfWeek This property is required. String
The day of the week on which agent updates should be performed. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday
hourOfDay This property is required. Integer
The hour of day the update window should start. The update is a 2 hour period following the hour provided. The value should be provided as a number between 0 and 23, with 0 being midnight and 23 being 11pm. A leading zero should not be used.
dayOfWeek This property is required. string
The day of the week on which agent updates should be performed. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday
hourOfDay This property is required. number
The hour of day the update window should start. The update is a 2 hour period following the hour provided. The value should be provided as a number between 0 and 23, with 0 being midnight and 23 being 11pm. A leading zero should not be used.
day_of_week This property is required. str
The day of the week on which agent updates should be performed. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday
hour_of_day This property is required. int
The hour of day the update window should start. The update is a 2 hour period following the hour provided. The value should be provided as a number between 0 and 23, with 0 being midnight and 23 being 11pm. A leading zero should not be used.
dayOfWeek This property is required. String
The day of the week on which agent updates should be performed. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday
hourOfDay This property is required. Number
The hour of day the update window should start. The update is a 2 hour period following the hour provided. The value should be provided as a number between 0 and 23, with 0 being midnight and 23 being 11pm. A leading zero should not be used.

Import

Virtual Desktop Host Pools can be imported using the resource id, e.g.

text

$ pulumi import azure:desktopvirtualization/hostPool:HostPool example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup1/providers/Microsoft.DesktopVirtualization/hostPools/myhostpool
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