1. Packages
  2. Azure Native
  3. API Docs
  4. desktopvirtualization
  5. HostPool
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.desktopvirtualization.HostPool

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Represents a HostPool definition.

Uses Azure REST API version 2024-04-03. In version 2.x of the Azure Native provider, it used API version 2022-09-09.

Other available API versions: 2022-09-09, 2022-10-14-preview, 2023-09-05, 2023-10-04-preview, 2023-11-01-preview, 2024-01-16-preview, 2024-03-06-preview, 2024-04-08-preview, 2024-08-08-preview, 2024-11-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native desktopvirtualization [ApiVersion]. See the version guide for details.

Example Usage

HostPool_Create

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var hostPool = new AzureNative.DesktopVirtualization.HostPool("hostPool", new()
    {
        AgentUpdate = new AzureNative.DesktopVirtualization.Inputs.AgentUpdatePropertiesArgs
        {
            MaintenanceWindowTimeZone = "Alaskan Standard Time",
            MaintenanceWindows = new[]
            {
                new AzureNative.DesktopVirtualization.Inputs.MaintenanceWindowPropertiesArgs
                {
                    DayOfWeek = AzureNative.DesktopVirtualization.DayOfWeek.Friday,
                    Hour = 7,
                },
                new AzureNative.DesktopVirtualization.Inputs.MaintenanceWindowPropertiesArgs
                {
                    DayOfWeek = AzureNative.DesktopVirtualization.DayOfWeek.Saturday,
                    Hour = 8,
                },
            },
            Type = AzureNative.DesktopVirtualization.SessionHostComponentUpdateType.Scheduled,
            UseSessionHostLocalTime = false,
        },
        Description = "des1",
        FriendlyName = "friendly",
        HostPoolName = "hostPool1",
        HostPoolType = AzureNative.DesktopVirtualization.HostPoolType.Pooled,
        LoadBalancerType = AzureNative.DesktopVirtualization.LoadBalancerType.BreadthFirst,
        Location = "centralus",
        MaxSessionLimit = 999999,
        PersonalDesktopAssignmentType = AzureNative.DesktopVirtualization.PersonalDesktopAssignmentType.Automatic,
        PreferredAppGroupType = AzureNative.DesktopVirtualization.PreferredAppGroupType.Desktop,
        RegistrationInfo = new AzureNative.DesktopVirtualization.Inputs.RegistrationInfoArgs
        {
            ExpirationTime = "2020-10-01T14:01:54.9571247Z",
            RegistrationTokenOperation = AzureNative.DesktopVirtualization.RegistrationTokenOperation.Update,
        },
        ResourceGroupName = "resourceGroup1",
        SsoClientId = "client",
        SsoClientSecretKeyVaultPath = "https://keyvault/secret",
        SsoSecretType = AzureNative.DesktopVirtualization.SSOSecretType.SharedKey,
        SsoadfsAuthority = "https://adfs",
        StartVMOnConnect = false,
        Tags = 
        {
            { "tag1", "value1" },
            { "tag2", "value2" },
        },
        VmTemplate = "{json:json}",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := desktopvirtualization.NewHostPool(ctx, "hostPool", &desktopvirtualization.HostPoolArgs{
			AgentUpdate: &desktopvirtualization.AgentUpdatePropertiesArgs{
				MaintenanceWindowTimeZone: pulumi.String("Alaskan Standard Time"),
				MaintenanceWindows: desktopvirtualization.MaintenanceWindowPropertiesArray{
					&desktopvirtualization.MaintenanceWindowPropertiesArgs{
						DayOfWeek: desktopvirtualization.DayOfWeekFriday,
						Hour:      pulumi.Int(7),
					},
					&desktopvirtualization.MaintenanceWindowPropertiesArgs{
						DayOfWeek: desktopvirtualization.DayOfWeekSaturday,
						Hour:      pulumi.Int(8),
					},
				},
				Type:                    pulumi.String(desktopvirtualization.SessionHostComponentUpdateTypeScheduled),
				UseSessionHostLocalTime: pulumi.Bool(false),
			},
			Description:                   pulumi.String("des1"),
			FriendlyName:                  pulumi.String("friendly"),
			HostPoolName:                  pulumi.String("hostPool1"),
			HostPoolType:                  pulumi.String(desktopvirtualization.HostPoolTypePooled),
			LoadBalancerType:              pulumi.String(desktopvirtualization.LoadBalancerTypeBreadthFirst),
			Location:                      pulumi.String("centralus"),
			MaxSessionLimit:               pulumi.Int(999999),
			PersonalDesktopAssignmentType: pulumi.String(desktopvirtualization.PersonalDesktopAssignmentTypeAutomatic),
			PreferredAppGroupType:         pulumi.String(desktopvirtualization.PreferredAppGroupTypeDesktop),
			RegistrationInfo: &desktopvirtualization.RegistrationInfoArgs{
				ExpirationTime:             pulumi.String("2020-10-01T14:01:54.9571247Z"),
				RegistrationTokenOperation: pulumi.String(desktopvirtualization.RegistrationTokenOperationUpdate),
			},
			ResourceGroupName:           pulumi.String("resourceGroup1"),
			SsoClientId:                 pulumi.String("client"),
			SsoClientSecretKeyVaultPath: pulumi.String("https://keyvault/secret"),
			SsoSecretType:               pulumi.String(desktopvirtualization.SSOSecretTypeSharedKey),
			SsoadfsAuthority:            pulumi.String("https://adfs"),
			StartVMOnConnect:            pulumi.Bool(false),
			Tags: pulumi.StringMap{
				"tag1": pulumi.String("value1"),
				"tag2": pulumi.String("value2"),
			},
			VmTemplate: pulumi.String("{json:json}"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.desktopvirtualization.HostPool;
import com.pulumi.azurenative.desktopvirtualization.HostPoolArgs;
import com.pulumi.azurenative.desktopvirtualization.inputs.AgentUpdatePropertiesArgs;
import com.pulumi.azurenative.desktopvirtualization.inputs.RegistrationInfoArgs;
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 hostPool = new HostPool("hostPool", HostPoolArgs.builder()
            .agentUpdate(AgentUpdatePropertiesArgs.builder()
                .maintenanceWindowTimeZone("Alaskan Standard Time")
                .maintenanceWindows(                
                    MaintenanceWindowPropertiesArgs.builder()
                        .dayOfWeek("Friday")
                        .hour(7)
                        .build(),
                    MaintenanceWindowPropertiesArgs.builder()
                        .dayOfWeek("Saturday")
                        .hour(8)
                        .build())
                .type("Scheduled")
                .useSessionHostLocalTime(false)
                .build())
            .description("des1")
            .friendlyName("friendly")
            .hostPoolName("hostPool1")
            .hostPoolType("Pooled")
            .loadBalancerType("BreadthFirst")
            .location("centralus")
            .maxSessionLimit(999999)
            .personalDesktopAssignmentType("Automatic")
            .preferredAppGroupType("Desktop")
            .registrationInfo(RegistrationInfoArgs.builder()
                .expirationTime("2020-10-01T14:01:54.9571247Z")
                .registrationTokenOperation("Update")
                .build())
            .resourceGroupName("resourceGroup1")
            .ssoClientId("client")
            .ssoClientSecretKeyVaultPath("https://keyvault/secret")
            .ssoSecretType("SharedKey")
            .ssoadfsAuthority("https://adfs")
            .startVMOnConnect(false)
            .tags(Map.ofEntries(
                Map.entry("tag1", "value1"),
                Map.entry("tag2", "value2")
            ))
            .vmTemplate("{json:json}")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const hostPool = new azure_native.desktopvirtualization.HostPool("hostPool", {
    agentUpdate: {
        maintenanceWindowTimeZone: "Alaskan Standard Time",
        maintenanceWindows: [
            {
                dayOfWeek: azure_native.desktopvirtualization.DayOfWeek.Friday,
                hour: 7,
            },
            {
                dayOfWeek: azure_native.desktopvirtualization.DayOfWeek.Saturday,
                hour: 8,
            },
        ],
        type: azure_native.desktopvirtualization.SessionHostComponentUpdateType.Scheduled,
        useSessionHostLocalTime: false,
    },
    description: "des1",
    friendlyName: "friendly",
    hostPoolName: "hostPool1",
    hostPoolType: azure_native.desktopvirtualization.HostPoolType.Pooled,
    loadBalancerType: azure_native.desktopvirtualization.LoadBalancerType.BreadthFirst,
    location: "centralus",
    maxSessionLimit: 999999,
    personalDesktopAssignmentType: azure_native.desktopvirtualization.PersonalDesktopAssignmentType.Automatic,
    preferredAppGroupType: azure_native.desktopvirtualization.PreferredAppGroupType.Desktop,
    registrationInfo: {
        expirationTime: "2020-10-01T14:01:54.9571247Z",
        registrationTokenOperation: azure_native.desktopvirtualization.RegistrationTokenOperation.Update,
    },
    resourceGroupName: "resourceGroup1",
    ssoClientId: "client",
    ssoClientSecretKeyVaultPath: "https://keyvault/secret",
    ssoSecretType: azure_native.desktopvirtualization.SSOSecretType.SharedKey,
    ssoadfsAuthority: "https://adfs",
    startVMOnConnect: false,
    tags: {
        tag1: "value1",
        tag2: "value2",
    },
    vmTemplate: "{json:json}",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

host_pool = azure_native.desktopvirtualization.HostPool("hostPool",
    agent_update={
        "maintenance_window_time_zone": "Alaskan Standard Time",
        "maintenance_windows": [
            {
                "day_of_week": azure_native.desktopvirtualization.DayOfWeek.FRIDAY,
                "hour": 7,
            },
            {
                "day_of_week": azure_native.desktopvirtualization.DayOfWeek.SATURDAY,
                "hour": 8,
            },
        ],
        "type": azure_native.desktopvirtualization.SessionHostComponentUpdateType.SCHEDULED,
        "use_session_host_local_time": False,
    },
    description="des1",
    friendly_name="friendly",
    host_pool_name="hostPool1",
    host_pool_type=azure_native.desktopvirtualization.HostPoolType.POOLED,
    load_balancer_type=azure_native.desktopvirtualization.LoadBalancerType.BREADTH_FIRST,
    location="centralus",
    max_session_limit=999999,
    personal_desktop_assignment_type=azure_native.desktopvirtualization.PersonalDesktopAssignmentType.AUTOMATIC,
    preferred_app_group_type=azure_native.desktopvirtualization.PreferredAppGroupType.DESKTOP,
    registration_info={
        "expiration_time": "2020-10-01T14:01:54.9571247Z",
        "registration_token_operation": azure_native.desktopvirtualization.RegistrationTokenOperation.UPDATE,
    },
    resource_group_name="resourceGroup1",
    sso_client_id="client",
    sso_client_secret_key_vault_path="https://keyvault/secret",
    sso_secret_type=azure_native.desktopvirtualization.SSOSecretType.SHARED_KEY,
    ssoadfs_authority="https://adfs",
    start_vm_on_connect=False,
    tags={
        "tag1": "value1",
        "tag2": "value2",
    },
    vm_template="{json:json}")
Copy
resources:
  hostPool:
    type: azure-native:desktopvirtualization:HostPool
    properties:
      agentUpdate:
        maintenanceWindowTimeZone: Alaskan Standard Time
        maintenanceWindows:
          - dayOfWeek: Friday
            hour: 7
          - dayOfWeek: Saturday
            hour: 8
        type: Scheduled
        useSessionHostLocalTime: false
      description: des1
      friendlyName: friendly
      hostPoolName: hostPool1
      hostPoolType: Pooled
      loadBalancerType: BreadthFirst
      location: centralus
      maxSessionLimit: 999999
      personalDesktopAssignmentType: Automatic
      preferredAppGroupType: Desktop
      registrationInfo:
        expirationTime: 2020-10-01T14:01:54.9571247Z
        registrationTokenOperation: Update
      resourceGroupName: resourceGroup1
      ssoClientId: client
      ssoClientSecretKeyVaultPath: https://keyvault/secret
      ssoSecretType: SharedKey
      ssoadfsAuthority: https://adfs
      startVMOnConnect: false
      tags:
        tag1: value1
        tag2: value2
      vmTemplate: '{json:json}'
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,
             host_pool_type: Optional[Union[str, HostPoolType]] = None,
             resource_group_name: Optional[str] = None,
             preferred_app_group_type: Optional[Union[str, PreferredAppGroupType]] = None,
             load_balancer_type: Optional[Union[str, LoadBalancerType]] = None,
             kind: Optional[str] = None,
             public_network_access: Optional[Union[str, HostpoolPublicNetworkAccess]] = None,
             identity: Optional[ResourceModelWithAllowedPropertySetIdentityArgs] = None,
             agent_update: Optional[AgentUpdatePropertiesArgs] = None,
             friendly_name: Optional[str] = None,
             location: Optional[str] = None,
             managed_by: Optional[str] = None,
             max_session_limit: Optional[int] = None,
             personal_desktop_assignment_type: Optional[Union[str, PersonalDesktopAssignmentType]] = None,
             plan: Optional[ResourceModelWithAllowedPropertySetPlanArgs] = None,
             description: Optional[str] = None,
             host_pool_name: Optional[str] = None,
             registration_info: Optional[RegistrationInfoArgs] = None,
             custom_rdp_property: Optional[str] = None,
             ring: Optional[int] = None,
             sku: Optional[ResourceModelWithAllowedPropertySetSkuArgs] = None,
             sso_client_id: Optional[str] = None,
             sso_client_secret_key_vault_path: Optional[str] = None,
             sso_secret_type: Optional[Union[str, SSOSecretType]] = None,
             ssoadfs_authority: Optional[str] = None,
             start_vm_on_connect: Optional[bool] = None,
             tags: Optional[Mapping[str, str]] = None,
             validation_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-native: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 AzureNative.DesktopVirtualization.HostPool("hostPoolResource", new()
{
    HostPoolType = "string",
    ResourceGroupName = "string",
    PreferredAppGroupType = "string",
    LoadBalancerType = "string",
    Kind = "string",
    PublicNetworkAccess = "string",
    Identity = new AzureNative.DesktopVirtualization.Inputs.ResourceModelWithAllowedPropertySetIdentityArgs
    {
        Type = AzureNative.DesktopVirtualization.ResourceIdentityType.SystemAssigned,
    },
    AgentUpdate = new AzureNative.DesktopVirtualization.Inputs.AgentUpdatePropertiesArgs
    {
        MaintenanceWindowTimeZone = "string",
        MaintenanceWindows = new[]
        {
            new AzureNative.DesktopVirtualization.Inputs.MaintenanceWindowPropertiesArgs
            {
                DayOfWeek = AzureNative.DesktopVirtualization.DayOfWeek.Monday,
                Hour = 0,
            },
        },
        Type = "string",
        UseSessionHostLocalTime = false,
    },
    FriendlyName = "string",
    Location = "string",
    ManagedBy = "string",
    MaxSessionLimit = 0,
    PersonalDesktopAssignmentType = "string",
    Plan = new AzureNative.DesktopVirtualization.Inputs.ResourceModelWithAllowedPropertySetPlanArgs
    {
        Name = "string",
        Product = "string",
        Publisher = "string",
        PromotionCode = "string",
        Version = "string",
    },
    Description = "string",
    HostPoolName = "string",
    RegistrationInfo = new AzureNative.DesktopVirtualization.Inputs.RegistrationInfoArgs
    {
        ExpirationTime = "string",
        RegistrationTokenOperation = "string",
        Token = "string",
    },
    CustomRdpProperty = "string",
    Ring = 0,
    Sku = new AzureNative.DesktopVirtualization.Inputs.ResourceModelWithAllowedPropertySetSkuArgs
    {
        Name = "string",
        Capacity = 0,
        Family = "string",
        Size = "string",
        Tier = AzureNative.DesktopVirtualization.SkuTier.Free,
    },
    SsoClientId = "string",
    SsoClientSecretKeyVaultPath = "string",
    SsoSecretType = "string",
    SsoadfsAuthority = "string",
    StartVMOnConnect = false,
    Tags = 
    {
        { "string", "string" },
    },
    ValidationEnvironment = false,
    VmTemplate = "string",
});
Copy
example, err := desktopvirtualization.NewHostPool(ctx, "hostPoolResource", &desktopvirtualization.HostPoolArgs{
	HostPoolType:          pulumi.String("string"),
	ResourceGroupName:     pulumi.String("string"),
	PreferredAppGroupType: pulumi.String("string"),
	LoadBalancerType:      pulumi.String("string"),
	Kind:                  pulumi.String("string"),
	PublicNetworkAccess:   pulumi.String("string"),
	Identity: &desktopvirtualization.ResourceModelWithAllowedPropertySetIdentityArgs{
		Type: desktopvirtualization.ResourceIdentityTypeSystemAssigned,
	},
	AgentUpdate: &desktopvirtualization.AgentUpdatePropertiesArgs{
		MaintenanceWindowTimeZone: pulumi.String("string"),
		MaintenanceWindows: desktopvirtualization.MaintenanceWindowPropertiesArray{
			&desktopvirtualization.MaintenanceWindowPropertiesArgs{
				DayOfWeek: desktopvirtualization.DayOfWeekMonday,
				Hour:      pulumi.Int(0),
			},
		},
		Type:                    pulumi.String("string"),
		UseSessionHostLocalTime: pulumi.Bool(false),
	},
	FriendlyName:                  pulumi.String("string"),
	Location:                      pulumi.String("string"),
	ManagedBy:                     pulumi.String("string"),
	MaxSessionLimit:               pulumi.Int(0),
	PersonalDesktopAssignmentType: pulumi.String("string"),
	Plan: &desktopvirtualization.ResourceModelWithAllowedPropertySetPlanArgs{
		Name:          pulumi.String("string"),
		Product:       pulumi.String("string"),
		Publisher:     pulumi.String("string"),
		PromotionCode: pulumi.String("string"),
		Version:       pulumi.String("string"),
	},
	Description:  pulumi.String("string"),
	HostPoolName: pulumi.String("string"),
	RegistrationInfo: &desktopvirtualization.RegistrationInfoArgs{
		ExpirationTime:             pulumi.String("string"),
		RegistrationTokenOperation: pulumi.String("string"),
		Token:                      pulumi.String("string"),
	},
	CustomRdpProperty: pulumi.String("string"),
	Ring:              pulumi.Int(0),
	Sku: &desktopvirtualization.ResourceModelWithAllowedPropertySetSkuArgs{
		Name:     pulumi.String("string"),
		Capacity: pulumi.Int(0),
		Family:   pulumi.String("string"),
		Size:     pulumi.String("string"),
		Tier:     desktopvirtualization.SkuTierFree,
	},
	SsoClientId:                 pulumi.String("string"),
	SsoClientSecretKeyVaultPath: pulumi.String("string"),
	SsoSecretType:               pulumi.String("string"),
	SsoadfsAuthority:            pulumi.String("string"),
	StartVMOnConnect:            pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ValidationEnvironment: pulumi.Bool(false),
	VmTemplate:            pulumi.String("string"),
})
Copy
var hostPoolResource = new HostPool("hostPoolResource", HostPoolArgs.builder()
    .hostPoolType("string")
    .resourceGroupName("string")
    .preferredAppGroupType("string")
    .loadBalancerType("string")
    .kind("string")
    .publicNetworkAccess("string")
    .identity(ResourceModelWithAllowedPropertySetIdentityArgs.builder()
        .type("SystemAssigned")
        .build())
    .agentUpdate(AgentUpdatePropertiesArgs.builder()
        .maintenanceWindowTimeZone("string")
        .maintenanceWindows(MaintenanceWindowPropertiesArgs.builder()
            .dayOfWeek("Monday")
            .hour(0)
            .build())
        .type("string")
        .useSessionHostLocalTime(false)
        .build())
    .friendlyName("string")
    .location("string")
    .managedBy("string")
    .maxSessionLimit(0)
    .personalDesktopAssignmentType("string")
    .plan(ResourceModelWithAllowedPropertySetPlanArgs.builder()
        .name("string")
        .product("string")
        .publisher("string")
        .promotionCode("string")
        .version("string")
        .build())
    .description("string")
    .hostPoolName("string")
    .registrationInfo(RegistrationInfoArgs.builder()
        .expirationTime("string")
        .registrationTokenOperation("string")
        .token("string")
        .build())
    .customRdpProperty("string")
    .ring(0)
    .sku(ResourceModelWithAllowedPropertySetSkuArgs.builder()
        .name("string")
        .capacity(0)
        .family("string")
        .size("string")
        .tier("Free")
        .build())
    .ssoClientId("string")
    .ssoClientSecretKeyVaultPath("string")
    .ssoSecretType("string")
    .ssoadfsAuthority("string")
    .startVMOnConnect(false)
    .tags(Map.of("string", "string"))
    .validationEnvironment(false)
    .vmTemplate("string")
    .build());
Copy
host_pool_resource = azure_native.desktopvirtualization.HostPool("hostPoolResource",
    host_pool_type="string",
    resource_group_name="string",
    preferred_app_group_type="string",
    load_balancer_type="string",
    kind="string",
    public_network_access="string",
    identity={
        "type": azure_native.desktopvirtualization.ResourceIdentityType.SYSTEM_ASSIGNED,
    },
    agent_update={
        "maintenance_window_time_zone": "string",
        "maintenance_windows": [{
            "day_of_week": azure_native.desktopvirtualization.DayOfWeek.MONDAY,
            "hour": 0,
        }],
        "type": "string",
        "use_session_host_local_time": False,
    },
    friendly_name="string",
    location="string",
    managed_by="string",
    max_session_limit=0,
    personal_desktop_assignment_type="string",
    plan={
        "name": "string",
        "product": "string",
        "publisher": "string",
        "promotion_code": "string",
        "version": "string",
    },
    description="string",
    host_pool_name="string",
    registration_info={
        "expiration_time": "string",
        "registration_token_operation": "string",
        "token": "string",
    },
    custom_rdp_property="string",
    ring=0,
    sku={
        "name": "string",
        "capacity": 0,
        "family": "string",
        "size": "string",
        "tier": azure_native.desktopvirtualization.SkuTier.FREE,
    },
    sso_client_id="string",
    sso_client_secret_key_vault_path="string",
    sso_secret_type="string",
    ssoadfs_authority="string",
    start_vm_on_connect=False,
    tags={
        "string": "string",
    },
    validation_environment=False,
    vm_template="string")
Copy
const hostPoolResource = new azure_native.desktopvirtualization.HostPool("hostPoolResource", {
    hostPoolType: "string",
    resourceGroupName: "string",
    preferredAppGroupType: "string",
    loadBalancerType: "string",
    kind: "string",
    publicNetworkAccess: "string",
    identity: {
        type: azure_native.desktopvirtualization.ResourceIdentityType.SystemAssigned,
    },
    agentUpdate: {
        maintenanceWindowTimeZone: "string",
        maintenanceWindows: [{
            dayOfWeek: azure_native.desktopvirtualization.DayOfWeek.Monday,
            hour: 0,
        }],
        type: "string",
        useSessionHostLocalTime: false,
    },
    friendlyName: "string",
    location: "string",
    managedBy: "string",
    maxSessionLimit: 0,
    personalDesktopAssignmentType: "string",
    plan: {
        name: "string",
        product: "string",
        publisher: "string",
        promotionCode: "string",
        version: "string",
    },
    description: "string",
    hostPoolName: "string",
    registrationInfo: {
        expirationTime: "string",
        registrationTokenOperation: "string",
        token: "string",
    },
    customRdpProperty: "string",
    ring: 0,
    sku: {
        name: "string",
        capacity: 0,
        family: "string",
        size: "string",
        tier: azure_native.desktopvirtualization.SkuTier.Free,
    },
    ssoClientId: "string",
    ssoClientSecretKeyVaultPath: "string",
    ssoSecretType: "string",
    ssoadfsAuthority: "string",
    startVMOnConnect: false,
    tags: {
        string: "string",
    },
    validationEnvironment: false,
    vmTemplate: "string",
});
Copy
type: azure-native:desktopvirtualization:HostPool
properties:
    agentUpdate:
        maintenanceWindowTimeZone: string
        maintenanceWindows:
            - dayOfWeek: Monday
              hour: 0
        type: string
        useSessionHostLocalTime: false
    customRdpProperty: string
    description: string
    friendlyName: string
    hostPoolName: string
    hostPoolType: string
    identity:
        type: SystemAssigned
    kind: string
    loadBalancerType: string
    location: string
    managedBy: string
    maxSessionLimit: 0
    personalDesktopAssignmentType: string
    plan:
        name: string
        product: string
        promotionCode: string
        publisher: string
        version: string
    preferredAppGroupType: string
    publicNetworkAccess: string
    registrationInfo:
        expirationTime: string
        registrationTokenOperation: string
        token: string
    resourceGroupName: string
    ring: 0
    sku:
        capacity: 0
        family: string
        name: string
        size: string
        tier: Free
    ssoClientId: string
    ssoClientSecretKeyVaultPath: string
    ssoSecretType: string
    ssoadfsAuthority: string
    startVMOnConnect: false
    tags:
        string: string
    validationEnvironment: 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:

HostPoolType This property is required. string | Pulumi.AzureNative.DesktopVirtualization.HostPoolType
HostPool type for desktop.
LoadBalancerType This property is required. string | Pulumi.AzureNative.DesktopVirtualization.LoadBalancerType
The type of the load balancer.
PreferredAppGroupType This property is required. string | Pulumi.AzureNative.DesktopVirtualization.PreferredAppGroupType
The type of preferred application group type, default to Desktop Application Group
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AgentUpdate Pulumi.AzureNative.DesktopVirtualization.Inputs.AgentUpdateProperties
The session host configuration for updating agent, monitoring agent, and stack component.
CustomRdpProperty string
Custom rdp property of HostPool.
Description string
Description of HostPool.
FriendlyName string
Friendly name of HostPool.
HostPoolName Changes to this property will trigger replacement. string
The name of the host pool within the specified resource group
Identity Pulumi.AzureNative.DesktopVirtualization.Inputs.ResourceModelWithAllowedPropertySetIdentity
Kind Changes to this property will trigger replacement. string
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
ManagedBy string
The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
MaxSessionLimit int
The max session limit of HostPool.
PersonalDesktopAssignmentType string | Pulumi.AzureNative.DesktopVirtualization.PersonalDesktopAssignmentType
PersonalDesktopAssignment type for HostPool.
Plan Pulumi.AzureNative.DesktopVirtualization.Inputs.ResourceModelWithAllowedPropertySetPlan
PublicNetworkAccess string | Pulumi.AzureNative.DesktopVirtualization.HostpoolPublicNetworkAccess
Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints
RegistrationInfo Pulumi.AzureNative.DesktopVirtualization.Inputs.RegistrationInfo
The registration info of HostPool.
Ring int
The ring number of HostPool.
Sku Pulumi.AzureNative.DesktopVirtualization.Inputs.ResourceModelWithAllowedPropertySetSku
SsoClientId string
ClientId for the registered Relying Party used to issue WVD SSO certificates.
SsoClientSecretKeyVaultPath string
Path to Azure KeyVault storing the secret used for communication to ADFS.
SsoSecretType string | Pulumi.AzureNative.DesktopVirtualization.SSOSecretType
The type of single sign on Secret Type.
SsoadfsAuthority string
URL to customer ADFS server for signing WVD SSO certificates.
StartVMOnConnect bool
The flag to turn on/off StartVMOnConnect feature.
Tags Dictionary<string, string>
Resource tags.
ValidationEnvironment bool
Is validation environment.
VmTemplate string
VM template for sessionhosts configuration within hostpool.
HostPoolType This property is required. string | HostPoolType
HostPool type for desktop.
LoadBalancerType This property is required. string | LoadBalancerType
The type of the load balancer.
PreferredAppGroupType This property is required. string | PreferredAppGroupType
The type of preferred application group type, default to Desktop Application Group
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AgentUpdate AgentUpdatePropertiesArgs
The session host configuration for updating agent, monitoring agent, and stack component.
CustomRdpProperty string
Custom rdp property of HostPool.
Description string
Description of HostPool.
FriendlyName string
Friendly name of HostPool.
HostPoolName Changes to this property will trigger replacement. string
The name of the host pool within the specified resource group
Identity ResourceModelWithAllowedPropertySetIdentityArgs
Kind Changes to this property will trigger replacement. string
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
ManagedBy string
The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
MaxSessionLimit int
The max session limit of HostPool.
PersonalDesktopAssignmentType string | PersonalDesktopAssignmentType
PersonalDesktopAssignment type for HostPool.
Plan ResourceModelWithAllowedPropertySetPlanArgs
PublicNetworkAccess string | HostpoolPublicNetworkAccess
Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints
RegistrationInfo RegistrationInfoArgs
The registration info of HostPool.
Ring int
The ring number of HostPool.
Sku ResourceModelWithAllowedPropertySetSkuArgs
SsoClientId string
ClientId for the registered Relying Party used to issue WVD SSO certificates.
SsoClientSecretKeyVaultPath string
Path to Azure KeyVault storing the secret used for communication to ADFS.
SsoSecretType string | SSOSecretType
The type of single sign on Secret Type.
SsoadfsAuthority string
URL to customer ADFS server for signing WVD SSO certificates.
StartVMOnConnect bool
The flag to turn on/off StartVMOnConnect feature.
Tags map[string]string
Resource tags.
ValidationEnvironment bool
Is validation environment.
VmTemplate string
VM template for sessionhosts configuration within hostpool.
hostPoolType This property is required. String | HostPoolType
HostPool type for desktop.
loadBalancerType This property is required. String | LoadBalancerType
The type of the load balancer.
preferredAppGroupType This property is required. String | PreferredAppGroupType
The type of preferred application group type, default to Desktop Application Group
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
agentUpdate AgentUpdateProperties
The session host configuration for updating agent, monitoring agent, and stack component.
customRdpProperty String
Custom rdp property of HostPool.
description String
Description of HostPool.
friendlyName String
Friendly name of HostPool.
hostPoolName Changes to this property will trigger replacement. String
The name of the host pool within the specified resource group
identity ResourceModelWithAllowedPropertySetIdentity
kind Changes to this property will trigger replacement. String
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
managedBy String
The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
maxSessionLimit Integer
The max session limit of HostPool.
personalDesktopAssignmentType String | PersonalDesktopAssignmentType
PersonalDesktopAssignment type for HostPool.
plan ResourceModelWithAllowedPropertySetPlan
publicNetworkAccess String | HostpoolPublicNetworkAccess
Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints
registrationInfo RegistrationInfo
The registration info of HostPool.
ring Integer
The ring number of HostPool.
sku ResourceModelWithAllowedPropertySetSku
ssoClientId String
ClientId for the registered Relying Party used to issue WVD SSO certificates.
ssoClientSecretKeyVaultPath String
Path to Azure KeyVault storing the secret used for communication to ADFS.
ssoSecretType String | SSOSecretType
The type of single sign on Secret Type.
ssoadfsAuthority String
URL to customer ADFS server for signing WVD SSO certificates.
startVMOnConnect Boolean
The flag to turn on/off StartVMOnConnect feature.
tags Map<String,String>
Resource tags.
validationEnvironment Boolean
Is validation environment.
vmTemplate String
VM template for sessionhosts configuration within hostpool.
hostPoolType This property is required. string | HostPoolType
HostPool type for desktop.
loadBalancerType This property is required. string | LoadBalancerType
The type of the load balancer.
preferredAppGroupType This property is required. string | PreferredAppGroupType
The type of preferred application group type, default to Desktop Application Group
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
agentUpdate AgentUpdateProperties
The session host configuration for updating agent, monitoring agent, and stack component.
customRdpProperty string
Custom rdp property of HostPool.
description string
Description of HostPool.
friendlyName string
Friendly name of HostPool.
hostPoolName Changes to this property will trigger replacement. string
The name of the host pool within the specified resource group
identity ResourceModelWithAllowedPropertySetIdentity
kind Changes to this property will trigger replacement. string
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
managedBy string
The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
maxSessionLimit number
The max session limit of HostPool.
personalDesktopAssignmentType string | PersonalDesktopAssignmentType
PersonalDesktopAssignment type for HostPool.
plan ResourceModelWithAllowedPropertySetPlan
publicNetworkAccess string | HostpoolPublicNetworkAccess
Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints
registrationInfo RegistrationInfo
The registration info of HostPool.
ring number
The ring number of HostPool.
sku ResourceModelWithAllowedPropertySetSku
ssoClientId string
ClientId for the registered Relying Party used to issue WVD SSO certificates.
ssoClientSecretKeyVaultPath string
Path to Azure KeyVault storing the secret used for communication to ADFS.
ssoSecretType string | SSOSecretType
The type of single sign on Secret Type.
ssoadfsAuthority string
URL to customer ADFS server for signing WVD SSO certificates.
startVMOnConnect boolean
The flag to turn on/off StartVMOnConnect feature.
tags {[key: string]: string}
Resource tags.
validationEnvironment boolean
Is validation environment.
vmTemplate string
VM template for sessionhosts configuration within hostpool.
host_pool_type This property is required. str | HostPoolType
HostPool type for desktop.
load_balancer_type This property is required. str | LoadBalancerType
The type of the load balancer.
preferred_app_group_type This property is required. str | PreferredAppGroupType
The type of preferred application group type, default to Desktop Application Group
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
agent_update AgentUpdatePropertiesArgs
The session host configuration for updating agent, monitoring agent, and stack component.
custom_rdp_property str
Custom rdp property of HostPool.
description str
Description of HostPool.
friendly_name str
Friendly name of HostPool.
host_pool_name Changes to this property will trigger replacement. str
The name of the host pool within the specified resource group
identity ResourceModelWithAllowedPropertySetIdentityArgs
kind Changes to this property will trigger replacement. str
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
managed_by str
The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
max_session_limit int
The max session limit of HostPool.
personal_desktop_assignment_type str | PersonalDesktopAssignmentType
PersonalDesktopAssignment type for HostPool.
plan ResourceModelWithAllowedPropertySetPlanArgs
public_network_access str | HostpoolPublicNetworkAccess
Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints
registration_info RegistrationInfoArgs
The registration info of HostPool.
ring int
The ring number of HostPool.
sku ResourceModelWithAllowedPropertySetSkuArgs
sso_client_id str
ClientId for the registered Relying Party used to issue WVD SSO certificates.
sso_client_secret_key_vault_path str
Path to Azure KeyVault storing the secret used for communication to ADFS.
sso_secret_type str | SSOSecretType
The type of single sign on Secret Type.
ssoadfs_authority str
URL to customer ADFS server for signing WVD SSO certificates.
start_vm_on_connect bool
The flag to turn on/off StartVMOnConnect feature.
tags Mapping[str, str]
Resource tags.
validation_environment bool
Is validation environment.
vm_template str
VM template for sessionhosts configuration within hostpool.
hostPoolType This property is required. String | "Personal" | "Pooled" | "BYODesktop"
HostPool type for desktop.
loadBalancerType This property is required. String | "BreadthFirst" | "DepthFirst" | "Persistent"
The type of the load balancer.
preferredAppGroupType This property is required. String | "None" | "Desktop" | "RailApplications"
The type of preferred application group type, default to Desktop Application Group
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
agentUpdate Property Map
The session host configuration for updating agent, monitoring agent, and stack component.
customRdpProperty String
Custom rdp property of HostPool.
description String
Description of HostPool.
friendlyName String
Friendly name of HostPool.
hostPoolName Changes to this property will trigger replacement. String
The name of the host pool within the specified resource group
identity Property Map
kind Changes to this property will trigger replacement. String
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
managedBy String
The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
maxSessionLimit Number
The max session limit of HostPool.
personalDesktopAssignmentType String | "Automatic" | "Direct"
PersonalDesktopAssignment type for HostPool.
plan Property Map
publicNetworkAccess String | "Enabled" | "Disabled" | "EnabledForSessionHostsOnly" | "EnabledForClientsOnly"
Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints
registrationInfo Property Map
The registration info of HostPool.
ring Number
The ring number of HostPool.
sku Property Map
ssoClientId String
ClientId for the registered Relying Party used to issue WVD SSO certificates.
ssoClientSecretKeyVaultPath String
Path to Azure KeyVault storing the secret used for communication to ADFS.
ssoSecretType String | "SharedKey" | "Certificate" | "SharedKeyInKeyVault" | "CertificateInKeyVault"
The type of single sign on Secret Type.
ssoadfsAuthority String
URL to customer ADFS server for signing WVD SSO certificates.
startVMOnConnect Boolean
The flag to turn on/off StartVMOnConnect feature.
tags Map<String>
Resource tags.
validationEnvironment Boolean
Is validation environment.
vmTemplate String
VM template for sessionhosts configuration within hostpool.

Outputs

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

AppAttachPackageReferences List<string>
List of App Attach Package links.
ApplicationGroupReferences List<string>
List of applicationGroup links.
AzureApiVersion string
The Azure API version of the resource.
CloudPcResource bool
Is cloud pc resource.
Etag string
The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ObjectId string
ObjectId of HostPool. (internal use)
PrivateEndpointConnections List<Pulumi.AzureNative.DesktopVirtualization.Outputs.PrivateEndpointConnectionResponse>
List of private endpoint connection associated with the specified resource
SystemData Pulumi.AzureNative.DesktopVirtualization.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AppAttachPackageReferences []string
List of App Attach Package links.
ApplicationGroupReferences []string
List of applicationGroup links.
AzureApiVersion string
The Azure API version of the resource.
CloudPcResource bool
Is cloud pc resource.
Etag string
The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ObjectId string
ObjectId of HostPool. (internal use)
PrivateEndpointConnections []PrivateEndpointConnectionResponse
List of private endpoint connection associated with the specified resource
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
appAttachPackageReferences List<String>
List of App Attach Package links.
applicationGroupReferences List<String>
List of applicationGroup links.
azureApiVersion String
The Azure API version of the resource.
cloudPcResource Boolean
Is cloud pc resource.
etag String
The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
objectId String
ObjectId of HostPool. (internal use)
privateEndpointConnections List<PrivateEndpointConnectionResponse>
List of private endpoint connection associated with the specified resource
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
appAttachPackageReferences string[]
List of App Attach Package links.
applicationGroupReferences string[]
List of applicationGroup links.
azureApiVersion string
The Azure API version of the resource.
cloudPcResource boolean
Is cloud pc resource.
etag string
The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
objectId string
ObjectId of HostPool. (internal use)
privateEndpointConnections PrivateEndpointConnectionResponse[]
List of private endpoint connection associated with the specified resource
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
app_attach_package_references Sequence[str]
List of App Attach Package links.
application_group_references Sequence[str]
List of applicationGroup links.
azure_api_version str
The Azure API version of the resource.
cloud_pc_resource bool
Is cloud pc resource.
etag str
The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
object_id str
ObjectId of HostPool. (internal use)
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
List of private endpoint connection associated with the specified resource
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
appAttachPackageReferences List<String>
List of App Attach Package links.
applicationGroupReferences List<String>
List of applicationGroup links.
azureApiVersion String
The Azure API version of the resource.
cloudPcResource Boolean
Is cloud pc resource.
etag String
The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
objectId String
ObjectId of HostPool. (internal use)
privateEndpointConnections List<Property Map>
List of private endpoint connection associated with the specified resource
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

AgentUpdateProperties
, AgentUpdatePropertiesArgs

MaintenanceWindowTimeZone string
Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true.
MaintenanceWindows List<Pulumi.AzureNative.DesktopVirtualization.Inputs.MaintenanceWindowProperties>
List of maintenance windows. Maintenance windows are 2 hours long.
Type string | Pulumi.AzureNative.DesktopVirtualization.SessionHostComponentUpdateType
The type of maintenance for session host components.
UseSessionHostLocalTime bool
Whether to use localTime of the virtual machine.
MaintenanceWindowTimeZone string
Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true.
MaintenanceWindows []MaintenanceWindowProperties
List of maintenance windows. Maintenance windows are 2 hours long.
Type string | SessionHostComponentUpdateType
The type of maintenance for session host components.
UseSessionHostLocalTime bool
Whether to use localTime of the virtual machine.
maintenanceWindowTimeZone String
Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true.
maintenanceWindows List<MaintenanceWindowProperties>
List of maintenance windows. Maintenance windows are 2 hours long.
type String | SessionHostComponentUpdateType
The type of maintenance for session host components.
useSessionHostLocalTime Boolean
Whether to use localTime of the virtual machine.
maintenanceWindowTimeZone string
Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true.
maintenanceWindows MaintenanceWindowProperties[]
List of maintenance windows. Maintenance windows are 2 hours long.
type string | SessionHostComponentUpdateType
The type of maintenance for session host components.
useSessionHostLocalTime boolean
Whether to use localTime of the virtual machine.
maintenance_window_time_zone str
Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true.
maintenance_windows Sequence[MaintenanceWindowProperties]
List of maintenance windows. Maintenance windows are 2 hours long.
type str | SessionHostComponentUpdateType
The type of maintenance for session host components.
use_session_host_local_time bool
Whether to use localTime of the virtual machine.
maintenanceWindowTimeZone String
Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true.
maintenanceWindows List<Property Map>
List of maintenance windows. Maintenance windows are 2 hours long.
type String | "Default" | "Scheduled"
The type of maintenance for session host components.
useSessionHostLocalTime Boolean
Whether to use localTime of the virtual machine.

AgentUpdatePropertiesResponse
, AgentUpdatePropertiesResponseArgs

MaintenanceWindowTimeZone string
Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true.
MaintenanceWindows List<Pulumi.AzureNative.DesktopVirtualization.Inputs.MaintenanceWindowPropertiesResponse>
List of maintenance windows. Maintenance windows are 2 hours long.
Type string
The type of maintenance for session host components.
UseSessionHostLocalTime bool
Whether to use localTime of the virtual machine.
MaintenanceWindowTimeZone string
Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true.
MaintenanceWindows []MaintenanceWindowPropertiesResponse
List of maintenance windows. Maintenance windows are 2 hours long.
Type string
The type of maintenance for session host components.
UseSessionHostLocalTime bool
Whether to use localTime of the virtual machine.
maintenanceWindowTimeZone String
Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true.
maintenanceWindows List<MaintenanceWindowPropertiesResponse>
List of maintenance windows. Maintenance windows are 2 hours long.
type String
The type of maintenance for session host components.
useSessionHostLocalTime Boolean
Whether to use localTime of the virtual machine.
maintenanceWindowTimeZone string
Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true.
maintenanceWindows MaintenanceWindowPropertiesResponse[]
List of maintenance windows. Maintenance windows are 2 hours long.
type string
The type of maintenance for session host components.
useSessionHostLocalTime boolean
Whether to use localTime of the virtual machine.
maintenance_window_time_zone str
Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true.
maintenance_windows Sequence[MaintenanceWindowPropertiesResponse]
List of maintenance windows. Maintenance windows are 2 hours long.
type str
The type of maintenance for session host components.
use_session_host_local_time bool
Whether to use localTime of the virtual machine.
maintenanceWindowTimeZone String
Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true.
maintenanceWindows List<Property Map>
List of maintenance windows. Maintenance windows are 2 hours long.
type String
The type of maintenance for session host components.
useSessionHostLocalTime Boolean
Whether to use localTime of the virtual machine.

DayOfWeek
, DayOfWeekArgs

Monday
Monday
Tuesday
Tuesday
Wednesday
Wednesday
Thursday
Thursday
Friday
Friday
Saturday
Saturday
Sunday
Sunday
DayOfWeekMonday
Monday
DayOfWeekTuesday
Tuesday
DayOfWeekWednesday
Wednesday
DayOfWeekThursday
Thursday
DayOfWeekFriday
Friday
DayOfWeekSaturday
Saturday
DayOfWeekSunday
Sunday
Monday
Monday
Tuesday
Tuesday
Wednesday
Wednesday
Thursday
Thursday
Friday
Friday
Saturday
Saturday
Sunday
Sunday
Monday
Monday
Tuesday
Tuesday
Wednesday
Wednesday
Thursday
Thursday
Friday
Friday
Saturday
Saturday
Sunday
Sunday
MONDAY
Monday
TUESDAY
Tuesday
WEDNESDAY
Wednesday
THURSDAY
Thursday
FRIDAY
Friday
SATURDAY
Saturday
SUNDAY
Sunday
"Monday"
Monday
"Tuesday"
Tuesday
"Wednesday"
Wednesday
"Thursday"
Thursday
"Friday"
Friday
"Saturday"
Saturday
"Sunday"
Sunday

HostPoolType
, HostPoolTypeArgs

Personal
PersonalUsers will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost.
Pooled
PooledUsers get a new (random) SessionHost every time it connects to the HostPool.
BYODesktop
BYODesktopUsers assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct.
HostPoolTypePersonal
PersonalUsers will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost.
HostPoolTypePooled
PooledUsers get a new (random) SessionHost every time it connects to the HostPool.
HostPoolTypeBYODesktop
BYODesktopUsers assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct.
Personal
PersonalUsers will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost.
Pooled
PooledUsers get a new (random) SessionHost every time it connects to the HostPool.
BYODesktop
BYODesktopUsers assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct.
Personal
PersonalUsers will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost.
Pooled
PooledUsers get a new (random) SessionHost every time it connects to the HostPool.
BYODesktop
BYODesktopUsers assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct.
PERSONAL
PersonalUsers will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost.
POOLED
PooledUsers get a new (random) SessionHost every time it connects to the HostPool.
BYO_DESKTOP
BYODesktopUsers assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct.
"Personal"
PersonalUsers will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost.
"Pooled"
PooledUsers get a new (random) SessionHost every time it connects to the HostPool.
"BYODesktop"
BYODesktopUsers assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct.

HostpoolPublicNetworkAccess
, HostpoolPublicNetworkAccessArgs

Enabled
Enabled
Disabled
Disabled
EnabledForSessionHostsOnly
EnabledForSessionHostsOnly
EnabledForClientsOnly
EnabledForClientsOnly
HostpoolPublicNetworkAccessEnabled
Enabled
HostpoolPublicNetworkAccessDisabled
Disabled
HostpoolPublicNetworkAccessEnabledForSessionHostsOnly
EnabledForSessionHostsOnly
HostpoolPublicNetworkAccessEnabledForClientsOnly
EnabledForClientsOnly
Enabled
Enabled
Disabled
Disabled
EnabledForSessionHostsOnly
EnabledForSessionHostsOnly
EnabledForClientsOnly
EnabledForClientsOnly
Enabled
Enabled
Disabled
Disabled
EnabledForSessionHostsOnly
EnabledForSessionHostsOnly
EnabledForClientsOnly
EnabledForClientsOnly
ENABLED
Enabled
DISABLED
Disabled
ENABLED_FOR_SESSION_HOSTS_ONLY
EnabledForSessionHostsOnly
ENABLED_FOR_CLIENTS_ONLY
EnabledForClientsOnly
"Enabled"
Enabled
"Disabled"
Disabled
"EnabledForSessionHostsOnly"
EnabledForSessionHostsOnly
"EnabledForClientsOnly"
EnabledForClientsOnly

LoadBalancerType
, LoadBalancerTypeArgs

BreadthFirst
BreadthFirst
DepthFirst
DepthFirst
Persistent
Persistent
LoadBalancerTypeBreadthFirst
BreadthFirst
LoadBalancerTypeDepthFirst
DepthFirst
LoadBalancerTypePersistent
Persistent
BreadthFirst
BreadthFirst
DepthFirst
DepthFirst
Persistent
Persistent
BreadthFirst
BreadthFirst
DepthFirst
DepthFirst
Persistent
Persistent
BREADTH_FIRST
BreadthFirst
DEPTH_FIRST
DepthFirst
PERSISTENT
Persistent
"BreadthFirst"
BreadthFirst
"DepthFirst"
DepthFirst
"Persistent"
Persistent

MaintenanceWindowProperties
, MaintenanceWindowPropertiesArgs

DayOfWeek Pulumi.AzureNative.DesktopVirtualization.DayOfWeek
Day of the week.
Hour int
The update start hour of the day. (0 - 23)
DayOfWeek DayOfWeek
Day of the week.
Hour int
The update start hour of the day. (0 - 23)
dayOfWeek DayOfWeek
Day of the week.
hour Integer
The update start hour of the day. (0 - 23)
dayOfWeek DayOfWeek
Day of the week.
hour number
The update start hour of the day. (0 - 23)
day_of_week DayOfWeek
Day of the week.
hour int
The update start hour of the day. (0 - 23)
dayOfWeek "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday"
Day of the week.
hour Number
The update start hour of the day. (0 - 23)

MaintenanceWindowPropertiesResponse
, MaintenanceWindowPropertiesResponseArgs

DayOfWeek string
Day of the week.
Hour int
The update start hour of the day. (0 - 23)
DayOfWeek string
Day of the week.
Hour int
The update start hour of the day. (0 - 23)
dayOfWeek String
Day of the week.
hour Integer
The update start hour of the day. (0 - 23)
dayOfWeek string
Day of the week.
hour number
The update start hour of the day. (0 - 23)
day_of_week str
Day of the week.
hour int
The update start hour of the day. (0 - 23)
dayOfWeek String
Day of the week.
hour Number
The update start hour of the day. (0 - 23)

PersonalDesktopAssignmentType
, PersonalDesktopAssignmentTypeArgs

Automatic
Automatic
Direct
Direct
PersonalDesktopAssignmentTypeAutomatic
Automatic
PersonalDesktopAssignmentTypeDirect
Direct
Automatic
Automatic
Direct
Direct
Automatic
Automatic
Direct
Direct
AUTOMATIC
Automatic
DIRECT
Direct
"Automatic"
Automatic
"Direct"
Direct

PreferredAppGroupType
, PreferredAppGroupTypeArgs

None
None
Desktop
Desktop
RailApplications
RailApplications
PreferredAppGroupTypeNone
None
PreferredAppGroupTypeDesktop
Desktop
PreferredAppGroupTypeRailApplications
RailApplications
None
None
Desktop
Desktop
RailApplications
RailApplications
None
None
Desktop
Desktop
RailApplications
RailApplications
NONE
None
DESKTOP
Desktop
RAIL_APPLICATIONS
RailApplications
"None"
None
"Desktop"
Desktop
"RailApplications"
RailApplications

PrivateEndpointConnectionResponse
, PrivateEndpointConnectionResponseArgs

GroupIds This property is required. List<string>
The group ids for the private endpoint resource.
Id This property is required. string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name This property is required. string
The name of the resource
PrivateLinkServiceConnectionState This property is required. Pulumi.AzureNative.DesktopVirtualization.Inputs.PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
ProvisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
SystemData This property is required. Pulumi.AzureNative.DesktopVirtualization.Inputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint Pulumi.AzureNative.DesktopVirtualization.Inputs.PrivateEndpointResponse
The private endpoint resource.
GroupIds This property is required. []string
The group ids for the private endpoint resource.
Id This property is required. string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name This property is required. string
The name of the resource
PrivateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
ProvisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
SystemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint PrivateEndpointResponse
The private endpoint resource.
groupIds This property is required. List<String>
The group ids for the private endpoint resource.
id This property is required. String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name This property is required. String
The name of the resource
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. String
The provisioning state of the private endpoint connection resource.
systemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse
The private endpoint resource.
groupIds This property is required. string[]
The group ids for the private endpoint resource.
id This property is required. string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name This property is required. string
The name of the resource
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
systemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse
The private endpoint resource.
group_ids This property is required. Sequence[str]
The group ids for the private endpoint resource.
id This property is required. str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name This property is required. str
The name of the resource
private_link_service_connection_state This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioning_state This property is required. str
The provisioning state of the private endpoint connection resource.
system_data This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
private_endpoint PrivateEndpointResponse
The private endpoint resource.
groupIds This property is required. List<String>
The group ids for the private endpoint resource.
id This property is required. String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name This property is required. String
The name of the resource
privateLinkServiceConnectionState This property is required. Property Map
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. String
The provisioning state of the private endpoint connection resource.
systemData This property is required. Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint Property Map
The private endpoint resource.

PrivateEndpointResponse
, PrivateEndpointResponseArgs

Id This property is required. string
The ARM identifier for private endpoint.
Id This property is required. string
The ARM identifier for private endpoint.
id This property is required. String
The ARM identifier for private endpoint.
id This property is required. string
The ARM identifier for private endpoint.
id This property is required. str
The ARM identifier for private endpoint.
id This property is required. String
The ARM identifier for private endpoint.

PrivateLinkServiceConnectionStateResponse
, PrivateLinkServiceConnectionStateResponseArgs

ActionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
Description string
The reason for approval/rejection of the connection.
Status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
ActionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
Description string
The reason for approval/rejection of the connection.
Status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired String
A message indicating if changes on the service provider require any updates on the consumer.
description String
The reason for approval/rejection of the connection.
status String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
description string
The reason for approval/rejection of the connection.
status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actions_required str
A message indicating if changes on the service provider require any updates on the consumer.
description str
The reason for approval/rejection of the connection.
status str
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired String
A message indicating if changes on the service provider require any updates on the consumer.
description String
The reason for approval/rejection of the connection.
status String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

RegistrationInfo
, RegistrationInfoArgs

ExpirationTime string
Expiration time of registration token.
RegistrationTokenOperation string | Pulumi.AzureNative.DesktopVirtualization.RegistrationTokenOperation
The type of resetting the token.
Token string
The registration token base64 encoded string.
ExpirationTime string
Expiration time of registration token.
RegistrationTokenOperation string | RegistrationTokenOperation
The type of resetting the token.
Token string
The registration token base64 encoded string.
expirationTime String
Expiration time of registration token.
registrationTokenOperation String | RegistrationTokenOperation
The type of resetting the token.
token String
The registration token base64 encoded string.
expirationTime string
Expiration time of registration token.
registrationTokenOperation string | RegistrationTokenOperation
The type of resetting the token.
token string
The registration token base64 encoded string.
expiration_time str
Expiration time of registration token.
registration_token_operation str | RegistrationTokenOperation
The type of resetting the token.
token str
The registration token base64 encoded string.
expirationTime String
Expiration time of registration token.
registrationTokenOperation String | "Delete" | "None" | "Update"
The type of resetting the token.
token String
The registration token base64 encoded string.

RegistrationInfoResponse
, RegistrationInfoResponseArgs

ExpirationTime string
Expiration time of registration token.
RegistrationTokenOperation string
The type of resetting the token.
Token string
The registration token base64 encoded string.
ExpirationTime string
Expiration time of registration token.
RegistrationTokenOperation string
The type of resetting the token.
Token string
The registration token base64 encoded string.
expirationTime String
Expiration time of registration token.
registrationTokenOperation String
The type of resetting the token.
token String
The registration token base64 encoded string.
expirationTime string
Expiration time of registration token.
registrationTokenOperation string
The type of resetting the token.
token string
The registration token base64 encoded string.
expiration_time str
Expiration time of registration token.
registration_token_operation str
The type of resetting the token.
token str
The registration token base64 encoded string.
expirationTime String
Expiration time of registration token.
registrationTokenOperation String
The type of resetting the token.
token String
The registration token base64 encoded string.

RegistrationTokenOperation
, RegistrationTokenOperationArgs

Delete
Delete
None
None
Update
Update
RegistrationTokenOperationDelete
Delete
RegistrationTokenOperationNone
None
RegistrationTokenOperationUpdate
Update
Delete
Delete
None
None
Update
Update
Delete
Delete
None
None
Update
Update
DELETE
Delete
NONE
None
UPDATE
Update
"Delete"
Delete
"None"
None
"Update"
Update

ResourceIdentityType
, ResourceIdentityTypeArgs

SystemAssigned
SystemAssigned
ResourceIdentityTypeSystemAssigned
SystemAssigned
SystemAssigned
SystemAssigned
SystemAssigned
SystemAssigned
SYSTEM_ASSIGNED
SystemAssigned
"SystemAssigned"
SystemAssigned

ResourceModelWithAllowedPropertySetIdentity
, ResourceModelWithAllowedPropertySetIdentityArgs

Type ResourceIdentityType
The identity type.
type ResourceIdentityType
The identity type.
type ResourceIdentityType
The identity type.
type ResourceIdentityType
The identity type.
type "SystemAssigned"
The identity type.

ResourceModelWithAllowedPropertySetPlan
, ResourceModelWithAllowedPropertySetPlanArgs

Name This property is required. string
A user defined name of the 3rd Party Artifact that is being procured.
Product This property is required. string
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
Publisher This property is required. string
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
PromotionCode string
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
Version string
The version of the desired product/artifact.
Name This property is required. string
A user defined name of the 3rd Party Artifact that is being procured.
Product This property is required. string
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
Publisher This property is required. string
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
PromotionCode string
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
Version string
The version of the desired product/artifact.
name This property is required. String
A user defined name of the 3rd Party Artifact that is being procured.
product This property is required. String
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
publisher This property is required. String
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotionCode String
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version String
The version of the desired product/artifact.
name This property is required. string
A user defined name of the 3rd Party Artifact that is being procured.
product This property is required. string
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
publisher This property is required. string
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotionCode string
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version string
The version of the desired product/artifact.
name This property is required. str
A user defined name of the 3rd Party Artifact that is being procured.
product This property is required. str
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
publisher This property is required. str
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotion_code str
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version str
The version of the desired product/artifact.
name This property is required. String
A user defined name of the 3rd Party Artifact that is being procured.
product This property is required. String
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
publisher This property is required. String
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotionCode String
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version String
The version of the desired product/artifact.

ResourceModelWithAllowedPropertySetResponseIdentity
, ResourceModelWithAllowedPropertySetResponseIdentityArgs

PrincipalId This property is required. string
The principal ID of resource identity. The value must be an UUID.
TenantId This property is required. string
The tenant ID of resource. The value must be an UUID.
Type string
The identity type.
PrincipalId This property is required. string
The principal ID of resource identity. The value must be an UUID.
TenantId This property is required. string
The tenant ID of resource. The value must be an UUID.
Type string
The identity type.
principalId This property is required. String
The principal ID of resource identity. The value must be an UUID.
tenantId This property is required. String
The tenant ID of resource. The value must be an UUID.
type String
The identity type.
principalId This property is required. string
The principal ID of resource identity. The value must be an UUID.
tenantId This property is required. string
The tenant ID of resource. The value must be an UUID.
type string
The identity type.
principal_id This property is required. str
The principal ID of resource identity. The value must be an UUID.
tenant_id This property is required. str
The tenant ID of resource. The value must be an UUID.
type str
The identity type.
principalId This property is required. String
The principal ID of resource identity. The value must be an UUID.
tenantId This property is required. String
The tenant ID of resource. The value must be an UUID.
type String
The identity type.

ResourceModelWithAllowedPropertySetResponsePlan
, ResourceModelWithAllowedPropertySetResponsePlanArgs

Name This property is required. string
A user defined name of the 3rd Party Artifact that is being procured.
Product This property is required. string
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
Publisher This property is required. string
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
PromotionCode string
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
Version string
The version of the desired product/artifact.
Name This property is required. string
A user defined name of the 3rd Party Artifact that is being procured.
Product This property is required. string
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
Publisher This property is required. string
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
PromotionCode string
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
Version string
The version of the desired product/artifact.
name This property is required. String
A user defined name of the 3rd Party Artifact that is being procured.
product This property is required. String
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
publisher This property is required. String
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotionCode String
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version String
The version of the desired product/artifact.
name This property is required. string
A user defined name of the 3rd Party Artifact that is being procured.
product This property is required. string
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
publisher This property is required. string
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotionCode string
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version string
The version of the desired product/artifact.
name This property is required. str
A user defined name of the 3rd Party Artifact that is being procured.
product This property is required. str
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
publisher This property is required. str
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotion_code str
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version str
The version of the desired product/artifact.
name This property is required. String
A user defined name of the 3rd Party Artifact that is being procured.
product This property is required. String
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
publisher This property is required. String
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotionCode String
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version String
The version of the desired product/artifact.

ResourceModelWithAllowedPropertySetResponseSku
, ResourceModelWithAllowedPropertySetResponseSkuArgs

Name This property is required. string
The name of the SKU. E.g. P3. It is typically a letter+number code
Capacity int
If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
Family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
Tier string
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
Name This property is required. string
The name of the SKU. E.g. P3. It is typically a letter+number code
Capacity int
If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
Family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
Tier string
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
name This property is required. String
The name of the SKU. E.g. P3. It is typically a letter+number code
capacity Integer
If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family String
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier String
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
name This property is required. string
The name of the SKU. E.g. P3. It is typically a letter+number code
capacity number
If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size string
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier string
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
name This property is required. str
The name of the SKU. E.g. P3. It is typically a letter+number code
capacity int
If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family str
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size str
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier str
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
name This property is required. String
The name of the SKU. E.g. P3. It is typically a letter+number code
capacity Number
If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family String
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier String
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

ResourceModelWithAllowedPropertySetSku
, ResourceModelWithAllowedPropertySetSkuArgs

Name This property is required. string
The name of the SKU. E.g. P3. It is typically a letter+number code
Capacity int
If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
Family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
Tier Pulumi.AzureNative.DesktopVirtualization.SkuTier
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
Name This property is required. string
The name of the SKU. E.g. P3. It is typically a letter+number code
Capacity int
If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
Family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
Tier SkuTier
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
name This property is required. String
The name of the SKU. E.g. P3. It is typically a letter+number code
capacity Integer
If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family String
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier SkuTier
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
name This property is required. string
The name of the SKU. E.g. P3. It is typically a letter+number code
capacity number
If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size string
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier SkuTier
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
name This property is required. str
The name of the SKU. E.g. P3. It is typically a letter+number code
capacity int
If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family str
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size str
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier SkuTier
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
name This property is required. String
The name of the SKU. E.g. P3. It is typically a letter+number code
capacity Number
If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family String
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier "Free" | "Basic" | "Standard" | "Premium"
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SSOSecretType
, SSOSecretTypeArgs

SharedKey
SharedKey
Certificate
Certificate
SharedKeyInKeyVault
SharedKeyInKeyVault
CertificateInKeyVault
CertificateInKeyVault
SSOSecretTypeSharedKey
SharedKey
SSOSecretTypeCertificate
Certificate
SSOSecretTypeSharedKeyInKeyVault
SharedKeyInKeyVault
SSOSecretTypeCertificateInKeyVault
CertificateInKeyVault
SharedKey
SharedKey
Certificate
Certificate
SharedKeyInKeyVault
SharedKeyInKeyVault
CertificateInKeyVault
CertificateInKeyVault
SharedKey
SharedKey
Certificate
Certificate
SharedKeyInKeyVault
SharedKeyInKeyVault
CertificateInKeyVault
CertificateInKeyVault
SHARED_KEY
SharedKey
CERTIFICATE
Certificate
SHARED_KEY_IN_KEY_VAULT
SharedKeyInKeyVault
CERTIFICATE_IN_KEY_VAULT
CertificateInKeyVault
"SharedKey"
SharedKey
"Certificate"
Certificate
"SharedKeyInKeyVault"
SharedKeyInKeyVault
"CertificateInKeyVault"
CertificateInKeyVault

SessionHostComponentUpdateType
, SessionHostComponentUpdateTypeArgs

Default
DefaultAgent and other agent side components are delivery schedule is controlled by WVD Infra.
Scheduled
ScheduledTenantAdmin have opted in for Scheduled Component Update feature.
SessionHostComponentUpdateTypeDefault
DefaultAgent and other agent side components are delivery schedule is controlled by WVD Infra.
SessionHostComponentUpdateTypeScheduled
ScheduledTenantAdmin have opted in for Scheduled Component Update feature.
Default
DefaultAgent and other agent side components are delivery schedule is controlled by WVD Infra.
Scheduled
ScheduledTenantAdmin have opted in for Scheduled Component Update feature.
Default
DefaultAgent and other agent side components are delivery schedule is controlled by WVD Infra.
Scheduled
ScheduledTenantAdmin have opted in for Scheduled Component Update feature.
DEFAULT
DefaultAgent and other agent side components are delivery schedule is controlled by WVD Infra.
SCHEDULED
ScheduledTenantAdmin have opted in for Scheduled Component Update feature.
"Default"
DefaultAgent and other agent side components are delivery schedule is controlled by WVD Infra.
"Scheduled"
ScheduledTenantAdmin have opted in for Scheduled Component Update feature.

SkuTier
, SkuTierArgs

Free
Free
Basic
Basic
Standard
Standard
Premium
Premium
SkuTierFree
Free
SkuTierBasic
Basic
SkuTierStandard
Standard
SkuTierPremium
Premium
Free
Free
Basic
Basic
Standard
Standard
Premium
Premium
Free
Free
Basic
Basic
Standard
Standard
Premium
Premium
FREE
Free
BASIC
Basic
STANDARD
Standard
PREMIUM
Premium
"Free"
Free
"Basic"
Basic
"Standard"
Standard
"Premium"
Premium

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:desktopvirtualization:HostPool hostPool1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName} 
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi