Microsoft.DesktopVirtualization hostPools
- 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@2023-11-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
{customized property}: 'string'
{customized property}: 'string'
{customized property}: 'string'
{customized property}: 'string'
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
kind: 'string'
identity: {
type: 'SystemAssigned'
}
managedBy: 'string'
plan: {
name: 'string'
product: 'string'
promotionCode: 'string'
publisher: 'string'
version: 'string'
}
properties: {
agentUpdate: {
maintenanceWindows: [
{
dayOfWeek: 'string'
hour: int
}
]
maintenanceWindowTimeZone: 'string'
type: 'string'
useSessionHostLocalTime: bool
}
customRdpProperty: 'string'
description: 'string'
friendlyName: 'string'
hostPoolType: 'string'
loadBalancerType: 'string'
managementType: 'string'
maxSessionLimit: int
personalDesktopAssignmentType: 'string'
preferredAppGroupType: 'string'
publicNetworkAccess: '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 |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| sku | ResourceModelWithAllowedPropertySetSku | |
| kind | 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. | string Constraints: Pattern = ^[-\w\._,\(\)]+$ |
| identity | ResourceModelWithAllowedPropertySetIdentity | |
| managedBy | 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. | string |
| plan | ResourceModelWithAllowedPropertySetPlan | |
| properties | Detailed properties for HostPool | HostPoolProperties (required) |
ResourceModelWithAllowedPropertySetIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
ResourceModelWithAllowedPropertySetPlan
| Name | Description | Value |
|---|---|---|
| name | A user defined name of the 3rd Party Artifact that is being procured. | string (required) |
| product | 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. | string (required) |
| promotionCode | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. | string |
| publisher | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic | string (required) |
| version | The version of the desired product/artifact. | string |
HostPoolProperties
| Name | Description | Value |
|---|---|---|
| agentUpdate | The session host configuration for updating agent, monitoring agent, and stack component. | AgentUpdateProperties |
| customRdpProperty | Custom rdp property of HostPool. | string |
| description | Description of HostPool. | string |
| friendlyName | Friendly name of HostPool. | string |
| hostPoolType | HostPool type for desktop. | 'BYODesktop' 'Personal' 'Pooled' (required) |
| loadBalancerType | The type of the load balancer. | 'BreadthFirst' 'DepthFirst' 'Persistent' (required) |
| managementType | The type of management for this hostpool, Automated or Standard. The default value is Automated. | 'Automated' 'Standard' |
| 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) |
| publicNetworkAccess | Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints | 'Disabled' 'Enabled' 'EnabledForClientsOnly' 'EnabledForSessionHostsOnly' |
| 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 |
AgentUpdateProperties
| Name | Description | Value |
|---|---|---|
| maintenanceWindows | List of maintenance windows. Maintenance windows are 2 hours long. | MaintenanceWindowProperties[] |
| maintenanceWindowTimeZone | Time zone for maintenance as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid Must be set if useLocalTime is true. |
string |
| type | The type of maintenance for session host components. | 'Default' 'Scheduled' |
| useSessionHostLocalTime | Whether to use localTime of the virtual machine. | bool |
MaintenanceWindowProperties
| Name | Description | Value |
|---|---|---|
| dayOfWeek | Day of the week. | 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' |
| hour | The update start hour of the day. (0 - 23) | int |
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 |
ResourceModelWithAllowedPropertySetSku
| Name | Description | Value |
|---|---|---|
| capacity | 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. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | 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. | 'Basic' 'Free' 'Premium' 'Standard' |
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": "2023-11-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string",
"{customized property}": "string"
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"kind": "string",
"identity": {
"type": "SystemAssigned"
},
"managedBy": "string",
"plan": {
"name": "string",
"product": "string",
"promotionCode": "string",
"publisher": "string",
"version": "string"
},
"properties": {
"agentUpdate": {
"maintenanceWindows": [
{
"dayOfWeek": "string",
"hour": "int"
}
],
"maintenanceWindowTimeZone": "string",
"type": "string",
"useSessionHostLocalTime": "bool"
},
"customRdpProperty": "string",
"description": "string",
"friendlyName": "string",
"hostPoolType": "string",
"loadBalancerType": "string",
"managementType": "string",
"maxSessionLimit": "int",
"personalDesktopAssignmentType": "string",
"preferredAppGroupType": "string",
"publicNetworkAccess": "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 | '2023-11-01-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 |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| sku | ResourceModelWithAllowedPropertySetSku | |
| kind | 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. | string Constraints: Pattern = ^[-\w\._,\(\)]+$ |
| identity | ResourceModelWithAllowedPropertySetIdentity | |
| managedBy | 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. | string |
| plan | ResourceModelWithAllowedPropertySetPlan | |
| properties | Detailed properties for HostPool | HostPoolProperties (required) |
ResourceModelWithAllowedPropertySetIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
ResourceModelWithAllowedPropertySetPlan
| Name | Description | Value |
|---|---|---|
| name | A user defined name of the 3rd Party Artifact that is being procured. | string (required) |
| product | 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. | string (required) |
| promotionCode | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. | string |
| publisher | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic | string (required) |
| version | The version of the desired product/artifact. | string |
HostPoolProperties
| Name | Description | Value |
|---|---|---|
| agentUpdate | The session host configuration for updating agent, monitoring agent, and stack component. | AgentUpdateProperties |
| customRdpProperty | Custom rdp property of HostPool. | string |
| description | Description of HostPool. | string |
| friendlyName | Friendly name of HostPool. | string |
| hostPoolType | HostPool type for desktop. | 'BYODesktop' 'Personal' 'Pooled' (required) |
| loadBalancerType | The type of the load balancer. | 'BreadthFirst' 'DepthFirst' 'Persistent' (required) |
| managementType | The type of management for this hostpool, Automated or Standard. The default value is Automated. | 'Automated' 'Standard' |
| 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) |
| publicNetworkAccess | Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints | 'Disabled' 'Enabled' 'EnabledForClientsOnly' 'EnabledForSessionHostsOnly' |
| 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 |
AgentUpdateProperties
| Name | Description | Value |
|---|---|---|
| maintenanceWindows | List of maintenance windows. Maintenance windows are 2 hours long. | MaintenanceWindowProperties[] |
| maintenanceWindowTimeZone | Time zone for maintenance as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid Must be set if useLocalTime is true. |
string |
| type | The type of maintenance for session host components. | 'Default' 'Scheduled' |
| useSessionHostLocalTime | Whether to use localTime of the virtual machine. | bool |
MaintenanceWindowProperties
| Name | Description | Value |
|---|---|---|
| dayOfWeek | Day of the week. | 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' |
| hour | The update start hour of the day. (0 - 23) | int |
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 |
ResourceModelWithAllowedPropertySetSku
| Name | Description | Value |
|---|---|---|
| capacity | 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. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | 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. | 'Basic' 'Free' 'Premium' 'Standard' |
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@2023-11-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
{customized property} = "string"
{customized property} = "string"
{customized property} = "string"
{customized property} = "string"
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
agentUpdate = {
maintenanceWindows = [
{
dayOfWeek = "string"
hour = int
}
]
maintenanceWindowTimeZone = "string"
type = "string"
useSessionHostLocalTime = bool
}
customRdpProperty = "string"
description = "string"
friendlyName = "string"
hostPoolType = "string"
loadBalancerType = "string"
managementType = "string"
maxSessionLimit = int
personalDesktopAssignmentType = "string"
preferredAppGroupType = "string"
publicNetworkAccess = "string"
registrationInfo = {
expirationTime = "string"
registrationTokenOperation = "string"
token = "string"
}
ring = int
ssoadfsAuthority = "string"
ssoClientId = "string"
ssoClientSecretKeyVaultPath = "string"
ssoSecretType = "string"
startVMOnConnect = bool
validationEnvironment = bool
vmTemplate = "string"
}
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
kind = "string"
managedBy = "string"
plan = {
name = "string"
product = "string"
promotionCode = "string"
publisher = "string"
version = "string"
}
})
}
Property values
hostPools
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.DesktopVirtualization/hostPools@2023-11-01-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 |
| 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. |
| sku | ResourceModelWithAllowedPropertySetSku | |
| kind | 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. | string Constraints: Pattern = ^[-\w\._,\(\)]+$ |
| identity | ResourceModelWithAllowedPropertySetIdentity | |
| managedBy | 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. | string |
| plan | ResourceModelWithAllowedPropertySetPlan | |
| properties | Detailed properties for HostPool | HostPoolProperties (required) |
ResourceModelWithAllowedPropertySetIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | "SystemAssigned" |
ResourceModelWithAllowedPropertySetPlan
| Name | Description | Value |
|---|---|---|
| name | A user defined name of the 3rd Party Artifact that is being procured. | string (required) |
| product | 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. | string (required) |
| promotionCode | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. | string |
| publisher | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic | string (required) |
| version | The version of the desired product/artifact. | string |
HostPoolProperties
| Name | Description | Value |
|---|---|---|
| agentUpdate | The session host configuration for updating agent, monitoring agent, and stack component. | AgentUpdateProperties |
| customRdpProperty | Custom rdp property of HostPool. | string |
| description | Description of HostPool. | string |
| friendlyName | Friendly name of HostPool. | string |
| hostPoolType | HostPool type for desktop. | "BYODesktop" "Personal" "Pooled" (required) |
| loadBalancerType | The type of the load balancer. | "BreadthFirst" "DepthFirst" "Persistent" (required) |
| managementType | The type of management for this hostpool, Automated or Standard. The default value is Automated. | "Automated" "Standard" |
| 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) |
| publicNetworkAccess | Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints | "Disabled" "Enabled" "EnabledForClientsOnly" "EnabledForSessionHostsOnly" |
| 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 |
AgentUpdateProperties
| Name | Description | Value |
|---|---|---|
| maintenanceWindows | List of maintenance windows. Maintenance windows are 2 hours long. | MaintenanceWindowProperties[] |
| maintenanceWindowTimeZone | Time zone for maintenance as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid Must be set if useLocalTime is true. |
string |
| type | The type of maintenance for session host components. | "Default" "Scheduled" |
| useSessionHostLocalTime | Whether to use localTime of the virtual machine. | bool |
MaintenanceWindowProperties
| Name | Description | Value |
|---|---|---|
| dayOfWeek | Day of the week. | "Friday" "Monday" "Saturday" "Sunday" "Thursday" "Tuesday" "Wednesday" |
| hour | The update start hour of the day. (0 - 23) | int |
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 |
ResourceModelWithAllowedPropertySetSku
| Name | Description | Value |
|---|---|---|
| capacity | 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. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | 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. | "Basic" "Free" "Premium" "Standard" |
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