Microsoft.DesktopVirtualization hostPools 2020-10-19-preview

The hostPools resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.DesktopVirtualization/hostPools resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2020-10-19-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    customRdpProperty: 'string'
    description: 'string'
    friendlyName: 'string'
    hostPoolType: 'string'
    loadBalancerType: 'string'
    maxSessionLimit: int
    personalDesktopAssignmentType: 'string'
    preferredAppGroupType: 'string'
    registrationInfo: {
      expirationTime: 'string'
      registrationTokenOperation: 'string'
      token: 'string'
    }
    ring: int
    ssoadfsAuthority: 'string'
    ssoClientId: 'string'
    ssoClientSecretKeyVaultPath: 'string'
    ssoContext: 'string'
    ssoSecretType: 'string'
    validationEnvironment: bool
    vmTemplate: 'string'
  }
}

Property values

hostPools

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.DesktopVirtualization/hostPools'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2020-10-19-preview'
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Properties of HostPool. HostPoolProperties (required)

HostPoolProperties

Name Description Value
customRdpProperty Custom rdp property of HostPool. string
description Description of HostPool. string
friendlyName Friendly name of HostPool. string
hostPoolType HostPool type for desktop. 'Personal'
'Pooled'
loadBalancerType The type of the load balancer. 'BreadthFirst'
'DepthFirst'
'Persistent'
maxSessionLimit The max session limit of HostPool. int
personalDesktopAssignmentType PersonalDesktopAssignment type for HostPool. 'Automatic'
'Direct'
preferredAppGroupType The type of preferred application group type, default to Desktop Application Group 'Desktop'
'None'
'RailApplications'
registrationInfo Represents a RegistrationInfo definition. RegistrationInfo
ring The ring number of HostPool. int
ssoadfsAuthority URL to customer ADFS server for signing WVD SSO certificates. string
ssoClientId ClientId for the registered Relying Party used to issue WVD SSO certificates. string
ssoClientSecretKeyVaultPath Path to Azure KeyVault storing the secret used for communication to ADFS. string
ssoContext Path to keyvault containing ssoContext secret. string
ssoSecretType The type of single sign on Secret Type. 'Certificate'
'CertificateInKeyVault'
'SharedKey'
'SharedKeyInKeyVault'
validationEnvironment Is validation environment. bool
vmTemplate VM template for sessionhosts configuration within hostpool. string

RegistrationInfo

Name Description Value
expirationTime Expiration time of registration token. string
registrationTokenOperation The type of resetting the token. 'Delete'
'None'
'Update'
token The registration token base64 encoded string. string