Microsoft.DesktopVirtualization hostPools 2020-11-10-preview
- Latest
- 2023-11-01-preview
- 2023-10-04-preview
- 2023-09-05
- 2023-07-07-preview
- 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' = {
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'
ssoSecretType: 'string'
startVMOnConnect: bool
validationEnvironment: bool
vmTemplate: 'string'
}
}
Property values
hostPools
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: 3-64 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with letter or number. End with letter, number, or underscore. |
| location | The geo-location where the resource lives | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| properties | Detailed properties for 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' (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 |
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",
"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",
"ssoSecretType": "string",
"startVMOnConnect": "bool",
"validationEnvironment": "bool",
"vmTemplate": "string"
}
}
Property values
hostPools
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.DesktopVirtualization/hostPools' |
| apiVersion | The resource api version | '2020-11-10-preview' |
| name | The resource name | string (required) Character limit: 3-64 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with letter or number. End with letter, number, or underscore. |
| location | The geo-location where the resource lives | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| properties | Detailed properties for 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' (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 |
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"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
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
hostPools
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview" |
| name | The resource name | string (required) Character limit: 3-64 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with letter or number. End with letter, number, or underscore. |
| location | The geo-location where the resource lives | string (required) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. |
| properties | Detailed properties for 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" (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 |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for