Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2025-03-01-preview
- 2024-11-01-preview
- 2024-08-08-preview
- 2024-04-08-preview
- 2024-04-03
- 2024-03-06-preview
- 2024-01-16-preview
- 2023-11-01-preview
- 2023-10-04-preview
- 2023-09-05
- 2022-10-14-preview
- 2022-09-09
- 2022-04-01-preview
- 2022-02-10-preview
- 2021-09-03-preview
- 2021-07-12
- 2021-04-01-preview
- 2021-03-09-preview
- 2021-02-01-preview
- 2021-01-14-preview
- 2020-11-10-preview
- 2020-11-02-preview
- 2020-10-19-preview
- 2020-09-21-preview
- 2019-12-10-preview
- 2019-09-24-preview
- 2019-01-23-preview
Bicep resource definition
The hostPools resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DesktopVirtualization/hostPools resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview' = {
location: 'string'
name: 'string'
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'
ssoSecretType: 'string'
startVMOnConnect: bool
validationEnvironment: bool
vmTemplate: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.DesktopVirtualization/hostPools
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 (required) |
| properties | Detailed properties for HostPool | HostPoolProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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' (required) |
| loadBalancerType | The type of the load balancer. | 'BreadthFirst' 'DepthFirst' 'Persistent' (required) |
| 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' (required) |
| registrationInfo | The registration info of HostPool. | 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 |
| ssoSecretType | The type of single sign on Secret Type. | 'Certificate' 'CertificateInKeyVault' 'SharedKey' 'SharedKeyInKeyVault' |
| startVMOnConnect | The flag to turn on/off StartVMOnConnect feature. | bool |
| 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 |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Azure Virtual Desktop (AVD) Host Pool | AVM Resource Module for Azure Virtual Desktop (AVD) Host Pool |
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Creates AVD with Microsoft Entra ID Join | This template allows you to create Azure Virtual Desktop resources such as host pool, application group, workspace, a test session host and its extensions with Microsoft Entra ID join |
ARM template resource definition
The hostPools resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DesktopVirtualization/hostPools resource, add the following JSON to your template.
{
"type": "Microsoft.DesktopVirtualization/hostPools",
"apiVersion": "2020-11-10-preview",
"name": "string",
"location": "string",
"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",
"ssoSecretType": "string",
"startVMOnConnect": "bool",
"validationEnvironment": "bool",
"vmTemplate": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.DesktopVirtualization/hostPools
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-11-10-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 (required) |
| properties | Detailed properties for HostPool | HostPoolProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.DesktopVirtualization/hostPools' |
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' (required) |
| loadBalancerType | The type of the load balancer. | 'BreadthFirst' 'DepthFirst' 'Persistent' (required) |
| 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' (required) |
| registrationInfo | The registration info of HostPool. | 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 |
| ssoSecretType | The type of single sign on Secret Type. | 'Certificate' 'CertificateInKeyVault' 'SharedKey' 'SharedKeyInKeyVault' |
| startVMOnConnect | The flag to turn on/off StartVMOnConnect feature. | bool |
| 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 |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Creates AVD with Microsoft Entra ID Join |
This template allows you to create Azure Virtual Desktop resources such as host pool, application group, workspace, a test session host and its extensions with Microsoft Entra ID join |
Terraform (AzAPI provider) resource definition
The hostPools resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DesktopVirtualization/hostPools resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
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"
ssoSecretType = "string"
startVMOnConnect = bool
validationEnvironment = bool
vmTemplate = "string"
}
}
}
Property Values
Microsoft.DesktopVirtualization/hostPools
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 (required) |
| properties | Detailed properties for HostPool | HostPoolProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview" |
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' (required) |
| loadBalancerType | The type of the load balancer. | 'BreadthFirst' 'DepthFirst' 'Persistent' (required) |
| 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' (required) |
| registrationInfo | The registration info of HostPool. | 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 |
| ssoSecretType | The type of single sign on Secret Type. | 'Certificate' 'CertificateInKeyVault' 'SharedKey' 'SharedKeyInKeyVault' |
| startVMOnConnect | The flag to turn on/off StartVMOnConnect feature. | bool |
| 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 |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Azure Virtual Desktop (AVD) Host Pool | AVM Resource Module for Azure Virtual Desktop (AVD) Host Pool |