Microsoft.DesktopVirtualization hostPools 2019-09-24-preview
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.
To create a Microsoft.DesktopVirtualization/hostPools resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2019-09-24-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
ssoContext: 'string'
validationEnvironment: bool
vmTemplate: 'string'
}
tags: {
{customized property}: 'string'
}
}
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' 'Shared' (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 |
ssoContext | Path to keyvault containing ssoContext secret. | string |
validationEnvironment | Is validation environment. | bool |
vmTemplate | VM template for sessionhosts configuration within hostpool. | string |
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 |
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 |
Name | Description | Value |
---|
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 |
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 |
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.
To create a Microsoft.DesktopVirtualization/hostPools resource, add the following JSON to your template.
{
"type": "Microsoft.DesktopVirtualization/hostPools",
"apiVersion": "2019-09-24-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",
"ssoContext": "string",
"validationEnvironment": "bool",
"vmTemplate": "string"
},
"tags": {
"{customized property}": "string"
}
}
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' 'Shared' (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 |
ssoContext | Path to keyvault containing ssoContext secret. | string |
validationEnvironment | Is validation environment. | bool |
vmTemplate | VM template for sessionhosts configuration within hostpool. | string |
Name | Description | Value |
---|---|---|
apiVersion | The api version | '2019-09-24-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' |
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 |
Name | Description | Value |
---|
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 |
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.
To create a Microsoft.DesktopVirtualization/hostPools resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DesktopVirtualization/hostPools@2019-09-24-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
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
ssoContext = "string"
validationEnvironment = bool
vmTemplate = "string"
}
})
}
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' 'Shared' (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 |
ssoContext | Path to keyvault containing ssoContext secret. | string |
validationEnvironment | Is validation environment. | bool |
vmTemplate | VM template for sessionhosts configuration within hostpool. | string |
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@2019-09-24-preview" |
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 |
Name | Description | Value |
---|
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 |