Azure Virtual Desktop Host Pool [Microsoft.DesktopVirtualization/hostPools]

⚠️THIS MODULE IS CURRENTLY ORPHANED.⚠️

• Only security and bug fixes are being handled by the AVM core team at present.
• If interested in becoming the module owner of this orphaned module (must be Microsoft FTE), please look for the related "orphaned module" GitHub issue here!

This module deploys an Azure Virtual Desktop Host Pool

Navigation

• Resource Types
• Usage examples
• Parameters
• Outputs
• Cross-referenced modules
• Data Collection

Resource Types

Usage examples

The following section provides usage examples for the module, which were used to validate and deploy the module successfully. For a full reference, please review the module's test folder in its repository.

Note: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.

Note: To reference the module, please use the following syntax ./packages/avd-host-pool/main.bicep.

• Using only defaults
• Using large parameter set
• WAF-aligned

Example 1: Using only defaults

This instance deploys the module with the minimum set of required parameters.

module hostPool './packages/avd-host-pool/main.bicep' = {
  name: 'hostPoolDeployment'
  params: {
    name: 'dvhpmin002'
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "name": {
      "value": "dvhpmin002"
    }
  }
}

using './packages/avd-host-pool/main.bicep'

param name = 'dvhpmin002'

Example 2: Using large parameter set

This instance deploys the module with most of its features enabled.

module hostPool './packages/avd-host-pool/main.bicep' = {
  name: 'hostPoolDeployment'
  params: {
    // Required parameters
    name: 'dvhpmax001'
    // Non-required parameters
    agentUpdate: {
      maintenanceWindows: [
        {
          dayOfWeek: 'Friday'
          hour: 7
        }
        {
          dayOfWeek: 'Saturday'
          hour: 8
        }
      ]
      maintenanceWindowTimeZone: 'Alaskan Standard Time'
      type: 'Scheduled'
      useSessionHostLocalTime: false
    }
    customRdpProperty: 'audiocapturemode:i:1;audiomode:i:0;drivestoredirect:s:;redirectclipboard:i:1;redirectcomports:i:1;redirectprinters:i:1;redirectsmartcards:i:1;screen mode id:i:2;'
    description: 'My first AVD Host Pool'
    diagnosticSettings: [
      {
        eventHubAuthorizationRuleResourceId: '<eventHubAuthorizationRuleResourceId>'
        eventHubName: '<eventHubName>'
        logCategoriesAndGroups: [
          {
            categoryGroup: 'allLogs'
          }
        ]
        name: 'customSetting'
        storageAccountResourceId: '<storageAccountResourceId>'
        workspaceResourceId: '<workspaceResourceId>'
      }
    ]
    directUDP: 'Enabled'
    enableTelemetry: true
    friendlyName: 'AVDv2'
    hostPoolType: 'Pooled'
    loadBalancerType: 'BreadthFirst'
    location: '<location>'
    lock: {
      kind: 'CanNotDelete'
      name: 'myCustomLockName'
    }
    managedPrivateUDP: 'Enabled'
    managementType: 'Automated'
    maxSessionLimit: 99999
    personalDesktopAssignmentType: 'Automatic'
    privateEndpoints: [
      {
        privateDnsZoneGroup: {
          privateDnsZoneGroupConfigs: [
            {
              privateDnsZoneResourceId: '<privateDnsZoneResourceId>'
            }
          ]
        }
        subnetResourceId: '<subnetResourceId>'
      }
      {
        privateDnsZoneGroup: {
          privateDnsZoneGroupConfigs: [
            {
              privateDnsZoneResourceId: '<privateDnsZoneResourceId>'
            }
          ]
        }
        subnetResourceId: '<subnetResourceId>'
      }
    ]
    publicNetworkAccess: 'Disabled'
    publicUDP: 'Enabled'
    relayUDP: 'Enabled'
    roleAssignments: [
      {
        name: '52c43567-917f-4c56-8c9b-6cadeef37b51'
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'Owner'
      }
      {
        name: '<name>'
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'b24988ac-6180-42a0-ab88-20f7382dd24c'
      }
      {
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
      }
    ]
    tags: {
      Environment: 'Non-Prod'
      'hidden-title': 'This is visible in the resource name'
      Role: 'DeploymentValidation'
    }
    vmTemplate: {
      customImageId: '<customImageId>'
      domain: 'domainname.onmicrosoft.com'
      galleryImageOffer: 'office-365'
      galleryImagePublisher: 'microsoftwindowsdesktop'
      galleryImageSKU: '20h1-evd-o365pp'
      imageType: 'Gallery'
      imageUri: '<imageUri>'
      namePrefix: 'avdv2'
      osDiskType: 'StandardSSD_LRS'
      useManagedDisks: true
      vmSize: {
        cores: 2
        id: 'Standard_D2s_v3'
        ram: 8
      }
    }
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "name": {
      "value": "dvhpmax001"
    },
    // Non-required parameters
    "agentUpdate": {
      "value": {
        "maintenanceWindows": [
          {
            "dayOfWeek": "Friday",
            "hour": 7
          },
          {
            "dayOfWeek": "Saturday",
            "hour": 8
          }
        ],
        "maintenanceWindowTimeZone": "Alaskan Standard Time",
        "type": "Scheduled",
        "useSessionHostLocalTime": false
      }
    },
    "customRdpProperty": {
      "value": "audiocapturemode:i:1;audiomode:i:0;drivestoredirect:s:;redirectclipboard:i:1;redirectcomports:i:1;redirectprinters:i:1;redirectsmartcards:i:1;screen mode id:i:2;"
    },
    "description": {
      "value": "My first AVD Host Pool"
    },
    "diagnosticSettings": {
      "value": [
        {
          "eventHubAuthorizationRuleResourceId": "<eventHubAuthorizationRuleResourceId>",
          "eventHubName": "<eventHubName>",
          "logCategoriesAndGroups": [
            {
              "categoryGroup": "allLogs"
            }
          ],
          "name": "customSetting",
          "storageAccountResourceId": "<storageAccountResourceId>",
          "workspaceResourceId": "<workspaceResourceId>"
        }
      ]
    },
    "directUDP": {
      "value": "Enabled"
    },
    "enableTelemetry": {
      "value": true
    },
    "friendlyName": {
      "value": "AVDv2"
    },
    "hostPoolType": {
      "value": "Pooled"
    },
    "loadBalancerType": {
      "value": "BreadthFirst"
    },
    "location": {
      "value": "<location>"
    },
    "lock": {
      "value": {
        "kind": "CanNotDelete",
        "name": "myCustomLockName"
      }
    },
    "managedPrivateUDP": {
      "value": "Enabled"
    },
    "managementType": {
      "value": "Automated"
    },
    "maxSessionLimit": {
      "value": 99999
    },
    "personalDesktopAssignmentType": {
      "value": "Automatic"
    },
    "privateEndpoints": {
      "value": [
        {
          "privateDnsZoneGroup": {
            "privateDnsZoneGroupConfigs": [
              {
                "privateDnsZoneResourceId": "<privateDnsZoneResourceId>"
              }
            ]
          },
          "subnetResourceId": "<subnetResourceId>"
        },
        {
          "privateDnsZoneGroup": {
            "privateDnsZoneGroupConfigs": [
              {
                "privateDnsZoneResourceId": "<privateDnsZoneResourceId>"
              }
            ]
          },
          "subnetResourceId": "<subnetResourceId>"
        }
      ]
    },
    "publicNetworkAccess": {
      "value": "Disabled"
    },
    "publicUDP": {
      "value": "Enabled"
    },
    "relayUDP": {
      "value": "Enabled"
    },
    "roleAssignments": {
      "value": [
        {
          "name": "52c43567-917f-4c56-8c9b-6cadeef37b51",
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "Owner"
        },
        {
          "name": "<name>",
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "b24988ac-6180-42a0-ab88-20f7382dd24c"
        },
        {
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "<roleDefinitionIdOrName>"
        }
      ]
    },
    "tags": {
      "value": {
        "Environment": "Non-Prod",
        "hidden-title": "This is visible in the resource name",
        "Role": "DeploymentValidation"
      }
    },
    "vmTemplate": {
      "value": {
        "customImageId": "<customImageId>",
        "domain": "domainname.onmicrosoft.com",
        "galleryImageOffer": "office-365",
        "galleryImagePublisher": "microsoftwindowsdesktop",
        "galleryImageSKU": "20h1-evd-o365pp",
        "imageType": "Gallery",
        "imageUri": "<imageUri>",
        "namePrefix": "avdv2",
        "osDiskType": "StandardSSD_LRS",
        "useManagedDisks": true,
        "vmSize": {
          "cores": 2,
          "id": "Standard_D2s_v3",
          "ram": 8
        }
      }
    }
  }
}

using './packages/avd-host-pool/main.bicep'

// Required parameters
param name = 'dvhpmax001'
// Non-required parameters
param agentUpdate = {
  maintenanceWindows: [
    {
      dayOfWeek: 'Friday'
      hour: 7
    }
    {
      dayOfWeek: 'Saturday'
      hour: 8
    }
  ]
  maintenanceWindowTimeZone: 'Alaskan Standard Time'
  type: 'Scheduled'
  useSessionHostLocalTime: false
}
param customRdpProperty = 'audiocapturemode:i:1;audiomode:i:0;drivestoredirect:s:;redirectclipboard:i:1;redirectcomports:i:1;redirectprinters:i:1;redirectsmartcards:i:1;screen mode id:i:2;'
param description = 'My first AVD Host Pool'
param diagnosticSettings = [
  {
    eventHubAuthorizationRuleResourceId: '<eventHubAuthorizationRuleResourceId>'
    eventHubName: '<eventHubName>'
    logCategoriesAndGroups: [
      {
        categoryGroup: 'allLogs'
      }
    ]
    name: 'customSetting'
    storageAccountResourceId: '<storageAccountResourceId>'
    workspaceResourceId: '<workspaceResourceId>'
  }
]
param directUDP = 'Enabled'
param enableTelemetry = true
param friendlyName = 'AVDv2'
param hostPoolType = 'Pooled'
param loadBalancerType = 'BreadthFirst'
param location = '<location>'
param lock = {
  kind: 'CanNotDelete'
  name: 'myCustomLockName'
}
param managedPrivateUDP = 'Enabled'
param managementType = 'Automated'
param maxSessionLimit = 99999
param personalDesktopAssignmentType = 'Automatic'
param privateEndpoints = [
  {
    privateDnsZoneGroup: {
      privateDnsZoneGroupConfigs: [
        {
          privateDnsZoneResourceId: '<privateDnsZoneResourceId>'
        }
      ]
    }
    subnetResourceId: '<subnetResourceId>'
  }
  {
    privateDnsZoneGroup: {
      privateDnsZoneGroupConfigs: [
        {
          privateDnsZoneResourceId: '<privateDnsZoneResourceId>'
        }
      ]
    }
    subnetResourceId: '<subnetResourceId>'
  }
]
param publicNetworkAccess = 'Disabled'
param publicUDP = 'Enabled'
param relayUDP = 'Enabled'
param roleAssignments = [
  {
    name: '52c43567-917f-4c56-8c9b-6cadeef37b51'
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: 'Owner'
  }
  {
    name: '<name>'
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: 'b24988ac-6180-42a0-ab88-20f7382dd24c'
  }
  {
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
  }
]
param tags = {
  Environment: 'Non-Prod'
  'hidden-title': 'This is visible in the resource name'
  Role: 'DeploymentValidation'
}
param vmTemplate = {
  customImageId: '<customImageId>'
  domain: 'domainname.onmicrosoft.com'
  galleryImageOffer: 'office-365'
  galleryImagePublisher: 'microsoftwindowsdesktop'
  galleryImageSKU: '20h1-evd-o365pp'
  imageType: 'Gallery'
  imageUri: '<imageUri>'
  namePrefix: 'avdv2'
  osDiskType: 'StandardSSD_LRS'
  useManagedDisks: true
  vmSize: {
    cores: 2
    id: 'Standard_D2s_v3'
    ram: 8
  }
}

Example 3: WAF-aligned

This instance deploys the module in alignment with the best-practices of the Azure Well-Architected Framework.

module hostPool './packages/avd-host-pool/main.bicep' = {
  name: 'hostPoolDeployment'
  params: {
    // Required parameters
    name: 'dvhpwaf002'
    // Non-required parameters
    diagnosticSettings: [
      {
        eventHubAuthorizationRuleResourceId: '<eventHubAuthorizationRuleResourceId>'
        eventHubName: '<eventHubName>'
        storageAccountResourceId: '<storageAccountResourceId>'
        workspaceResourceId: '<workspaceResourceId>'
      }
    ]
    tags: {
      Environment: 'Non-Prod'
      'hidden-title': 'This is visible in the resource name'
      Role: 'DeploymentValidation'
    }
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "name": {
      "value": "dvhpwaf002"
    },
    // Non-required parameters
    "diagnosticSettings": {
      "value": [
        {
          "eventHubAuthorizationRuleResourceId": "<eventHubAuthorizationRuleResourceId>",
          "eventHubName": "<eventHubName>",
          "storageAccountResourceId": "<storageAccountResourceId>",
          "workspaceResourceId": "<workspaceResourceId>"
        }
      ]
    },
    "tags": {
      "value": {
        "Environment": "Non-Prod",
        "hidden-title": "This is visible in the resource name",
        "Role": "DeploymentValidation"
      }
    }
  }
}

using './packages/avd-host-pool/main.bicep'

// Required parameters
param name = 'dvhpwaf002'
// Non-required parameters
param diagnosticSettings = [
  {
    eventHubAuthorizationRuleResourceId: '<eventHubAuthorizationRuleResourceId>'
    eventHubName: '<eventHubName>'
    storageAccountResourceId: '<storageAccountResourceId>'
    workspaceResourceId: '<workspaceResourceId>'
  }
]
param tags = {
  Environment: 'Non-Prod'
  'hidden-title': 'This is visible in the resource name'
  Role: 'DeploymentValidation'
}

Parameters

Required parameters

Optional parameters

Generated parameters

Parameter: name

Name of the scaling plan.

• Required: Yes
• Type: string

Parameter: agentUpdate

The session host configuration for updating agent, monitoring agent, and stack component.

• Required: No
• Type: object
• Default:

  {
      maintenanceWindows: [
        {
          dayOfWeek: 'Sunday'
          hour: 12
        }
      ]
      type: 'Scheduled'
      useSessionHostLocalTime: true
  }
  

Parameter: customRdpProperty

Host Pool RDP properties.

• Required: No
• Type: string
• Default: 'audiocapturemode:i:1;audiomode:i:0;drivestoredirect:s:;redirectclipboard:i:1;redirectcomports:i:1;redirectprinters:i:1;redirectsmartcards:i:1;screen mode id:i:2;'

Parameter: description

Description of the scaling plan.

• Required: No
• Type: string

Parameter: diagnosticSettings

The diagnostic settings of the service.

• Required: No
• Type: array

Optional parameters

Parameter: diagnosticSettings.eventHubAuthorizationRuleResourceId

Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to.

• Required: No
• Type: string

Parameter: diagnosticSettings.eventHubName

Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub.

• Required: No
• Type: string

Parameter: diagnosticSettings.logAnalyticsDestinationType

A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type.

• Required: No
• Type: string
• Allowed:

  [
    'AzureDiagnostics'
    'Dedicated'
  ]
  

Parameter: diagnosticSettings.logCategoriesAndGroups

The name of logs that will be streamed. "allLogs" includes all possible logs for the resource. Set to [] to disable log collection.

• Required: No
• Type: array

Optional parameters

Parameter: diagnosticSettings.logCategoriesAndGroups.category

Name of a Diagnostic Log category for a resource type this setting is applied to. Set the specific logs to collect here.

• Required: No
• Type: string

Parameter: diagnosticSettings.logCategoriesAndGroups.categoryGroup

Name of a Diagnostic Log category group for a resource type this setting is applied to. Set to allLogs to collect all logs.

• Required: No
• Type: string

Parameter: diagnosticSettings.logCategoriesAndGroups.enabled

Enable or disable the category explicitly. Default is true.

• Required: No
• Type: bool

Parameter: diagnosticSettings.marketplacePartnerResourceId

The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs.

• Required: No
• Type: string

Parameter: diagnosticSettings.name

The name of diagnostic setting.

• Required: No
• Type: string

Parameter: diagnosticSettings.storageAccountResourceId

Resource ID of the diagnostic storage account. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub.

• Required: No
• Type: string

Parameter: diagnosticSettings.workspaceResourceId

Resource ID of the diagnostic log analytics workspace. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub.

• Required: No
• Type: string

Parameter: directUDP

Where direct UDP connectivity is established between the client and the session host when using a private connection, such as a virtual private network (VPN).
- Default: AVD-wide settings are used to determine connection availability
- Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type
- Disabled: UDP will not attempt this connection type when making connections.

• Required: No
• Type: string
• Default: 'Default'

Parameter: enableTelemetry

Enable/Disable usage telemetry for module.

• Required: No
• Type: bool
• Default: True

Parameter: friendlyName

Friendly name of the scaling plan.

• Required: No
• Type: string

Parameter: hostPoolType

Set this parameter to Personal if you would like to enable Persistent Desktop experience. Defaults to Pooled.

• Required: No
• Type: string
• Default: 'Pooled'
• Allowed:

  [
    'Personal'
    'Pooled'
  ]
  

Parameter: loadBalancerType

Type of load balancer algorithm.

• Required: No
• Type: string
• Default: 'BreadthFirst'
• Allowed:

  [
    'BreadthFirst'
    'DepthFirst'
    'Persistent'
  ]
  

Parameter: location

Location of the scaling plan. Defaults to resource group location.

• Required: No
• Type: string
• Default: [resourceGroup().location]

Parameter: lock

The lock settings of the service.

• Required: No
• Type: object

Optional parameters

Parameter: lock.kind

Specify the type of lock.

• Required: No
• Type: string
• Allowed:

  [
    'CanNotDelete'
    'None'
    'ReadOnly'
  ]
  

Parameter: lock.name

Specify the name of lock.

• Required: No
• Type: string

Parameter: lock.notes

Specify the notes of the lock.

• Required: No
• Type: string

Parameter: managedPrivateUDP

Where direct UDP connectivity is established between the client and the session host when using a private connection, such as a virtual private network (VPN).
- Default: AVD-wide settings are used to determine connection availability
- Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type
- Disabled: UDP will not attempt this connection type when making connections.

• Required: No
• Type: string
• Default: 'Default'

Parameter: managementType

The type of management for this hostpool. Note: If set to Automated, no registrationToken is returned by the resource.

• Required: No
• Type: string
• Default: 'Standard'

Parameter: maxSessionLimit

Maximum number of sessions.

• Required: No
• Type: int
• Default: 99999

Parameter: personalDesktopAssignmentType

Set the type of assignment for a Personal Host Pool type.

• Required: No
• Type: string
• Default: ''
• Allowed:

  [
    ''
    'Automatic'
    'Direct'
  ]
  

Parameter: preferredAppGroupType

The type of preferred application group type, default to Desktop Application Group.

• Required: No
• Type: string
• Default: 'Desktop'
• Allowed:

  [
    'Desktop'
    'None'
    'RailApplications'
  ]
  

Parameter: privateEndpoints

Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible.

• Required: No
• Type: array

Required parameters

Optional parameters

Parameter: privateEndpoints.subnetResourceId

Resource ID of the subnet where the endpoint needs to be created.

• Required: Yes
• Type: string

Parameter: privateEndpoints.applicationSecurityGroupResourceIds

Application security groups in which the Private Endpoint IP configuration is included.

• Required: No
• Type: array

Parameter: privateEndpoints.customDnsConfigs

Custom DNS configurations.

• Required: No
• Type: array

Required parameters

Optional parameters

Parameter: privateEndpoints.customDnsConfigs.ipAddresses

A list of private IP addresses of the private endpoint.

• Required: Yes
• Type: array

Parameter: privateEndpoints.customDnsConfigs.fqdn

FQDN that resolves to private endpoint IP address.

• Required: No
• Type: string

Parameter: privateEndpoints.customNetworkInterfaceName

The custom name of the network interface attached to the Private Endpoint.

• Required: No
• Type: string

Parameter: privateEndpoints.enableTelemetry

Enable/Disable usage telemetry for module.

• Required: No
• Type: bool

Parameter: privateEndpoints.ipConfigurations

A list of IP configurations of the Private Endpoint. This will be used to map to the first-party Service endpoints.

• Required: No
• Type: array

Required parameters

Parameter: privateEndpoints.ipConfigurations.name

The name of the resource that is unique within a resource group.

• Required: Yes
• Type: string

Parameter: privateEndpoints.ipConfigurations.properties

Properties of private endpoint IP configurations.

• Required: Yes
• Type: object

Required parameters

Parameter: privateEndpoints.ipConfigurations.properties.groupId

The ID of a group obtained from the remote resource that this private endpoint should connect to.

• Required: Yes
• Type: string

Parameter: privateEndpoints.ipConfigurations.properties.memberName

The member name of a group obtained from the remote resource that this private endpoint should connect to.

• Required: Yes
• Type: string

Parameter: privateEndpoints.ipConfigurations.properties.privateIPAddress

A private IP address obtained from the private endpoint's subnet.

• Required: Yes
• Type: string

Parameter: privateEndpoints.isManualConnection

If Manual Private Link Connection is required.

• Required: No
• Type: bool

Parameter: privateEndpoints.location

The location to deploy the Private Endpoint to.

• Required: No
• Type: string

Parameter: privateEndpoints.lock

Specify the type of lock.

• Required: No
• Type: object

Optional parameters

Parameter: privateEndpoints.lock.kind

Specify the type of lock.

• Required: No
• Type: string
• Allowed:

  [
    'CanNotDelete'
    'None'
    'ReadOnly'
  ]
  

Parameter: privateEndpoints.lock.name

Specify the name of lock.

• Required: No
• Type: string

Parameter: privateEndpoints.lock.notes

Specify the notes of the lock.

• Required: No
• Type: string

Parameter: privateEndpoints.manualConnectionRequestMessage

A message passed to the owner of the remote resource with the manual connection request.

• Required: No
• Type: string

Parameter: privateEndpoints.name

The name of the Private Endpoint.

• Required: No
• Type: string

Parameter: privateEndpoints.privateDnsZoneGroup

The private DNS Zone Group to configure for the Private Endpoint.

• Required: No
• Type: object

Required parameters

Optional parameters

Parameter: privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs

The private DNS Zone Groups to associate the Private Endpoint. A DNS Zone Group can support up to 5 DNS zones.

• Required: Yes
• Type: array

Required parameters

Optional parameters

Parameter: privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.privateDnsZoneResourceId

The resource id of the private DNS zone.

• Required: Yes
• Type: string

Parameter: privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.name

The name of the private DNS Zone Group config.

• Required: No
• Type: string

Parameter: privateEndpoints.privateDnsZoneGroup.name

The name of the Private DNS Zone Group.

• Required: No
• Type: string

Parameter: privateEndpoints.privateLinkServiceConnectionName

The name of the private link connection to create.

• Required: No
• Type: string

Parameter: privateEndpoints.resourceGroupResourceId

The resource ID of the Resource Group the Private Endpoint will be created in. If not specified, the Resource Group of the provided Virtual Network Subnet is used.

• Required: No
• Type: string

Parameter: privateEndpoints.roleAssignments

Array of role assignments to create.

• Required: No
• Type: array
• Roles configurable by name:
  • 'Contributor'
  • 'DNS Resolver Contributor'
  • 'DNS Zone Contributor'
  • 'Domain Services Contributor'
  • 'Domain Services Reader'
  • 'Network Contributor'
  • 'Owner'
  • 'Private DNS Zone Contributor'
  • 'Reader'
  • 'Role Based Access Control Administrator'

Required parameters

Optional parameters

Parameter: privateEndpoints.roleAssignments.principalId

The principal ID of the principal (user/group/identity) to assign the role to.

• Required: Yes
• Type: string

Parameter: privateEndpoints.roleAssignments.roleDefinitionIdOrName

The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.

• Required: Yes
• Type: string

Parameter: privateEndpoints.roleAssignments.condition

The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container".

• Required: No
• Type: string

Parameter: privateEndpoints.roleAssignments.conditionVersion

Version of the condition.

• Required: No
• Type: string
• Allowed:

  [
    '2.0'
  ]
  

Parameter: privateEndpoints.roleAssignments.delegatedManagedIdentityResourceId

The Resource Id of the delegated managed identity resource.

• Required: No
• Type: string

Parameter: privateEndpoints.roleAssignments.description

The description of the role assignment.

• Required: No
• Type: string

Parameter: privateEndpoints.roleAssignments.name

The name (as GUID) of the role assignment. If not provided, a GUID will be generated.

• Required: No
• Type: string

Parameter: privateEndpoints.roleAssignments.principalType

The principal type of the assigned principal ID.

• Required: No
• Type: string
• Allowed:

  [
    'Device'
    'ForeignGroup'
    'Group'
    'ServicePrincipal'
    'User'
  ]
  

Parameter: privateEndpoints.service

The subresource to deploy the Private Endpoint for. For example "vault" for a Key Vault Private Endpoint.

• Required: No
• Type: string

Parameter: privateEndpoints.tags

Tags to be applied on all resources/Resource Groups in this deployment.

• Required: No
• Type: object

Parameter: publicNetworkAccess

Set public network access.

• Required: No
• Type: string
• Default: 'Enabled'
• Allowed:

  [
    'Disabled'
    'Enabled'
    'EnabledForClientsOnly'
    'EnabledForSessionHostsOnly'
  ]
  

Parameter: publicUDP

Where direct UDP connectivity is established between the client and the session host via public network using Simple Traversal Underneath NAT (STUN) protocol.
- Default: AVD-wide settings are used to determine connection availability
- Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type
- Disabled: UDP will not attempt this connection type when making connections.

• Required: No
• Type: string
• Default: 'Default'

Parameter: relayUDP

Where indirect UDP connectivity is established between the client and the session host via public network using Traversal Using Relay NAT (TURN) protocol.
- Default: AVD-wide settings are used to determine connection availability
- Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type
- Disabled: UDP will not attempt this connection type when making connections.

• Required: No
• Type: string
• Default: 'Default'

Parameter: ring

The ring number of HostPool.

• Required: No
• Type: int

Parameter: roleAssignments

Array of role assignments to create.

• Required: No
• Type: array
• Roles configurable by name:
  • 'Owner'
  • 'Contributor'
  • 'Reader'
  • 'Role Based Access Control Administrator'
  • 'User Access Administrator'
  • 'Application Group Contributor'
  • 'Desktop Virtualization Application Group Contributor'
  • 'Desktop Virtualization Application Group Reader'
  • 'Desktop Virtualization Contributor'
  • 'Desktop Virtualization Host Pool Contributor'
  • 'Desktop Virtualization Host Pool Reader'
  • 'Desktop Virtualization Power On Off Contributor'
  • 'Desktop Virtualization Reader'
  • 'Desktop Virtualization Session Host Operator'
  • 'Desktop Virtualization User'
  • 'Desktop Virtualization User Session Operator'
  • 'Desktop Virtualization Virtual Machine Contributor'
  • 'Desktop Virtualization Workspace Contributor'
  • 'Desktop Virtualization Workspace Reader'
  • 'Managed Application Contributor Role'
  • 'Managed Application Operator Role'
  • 'Managed Applications Reader'

Required parameters

Optional parameters

Parameter: roleAssignments.principalId

The principal ID of the principal (user/group/identity) to assign the role to.

• Required: Yes
• Type: string

Parameter: roleAssignments.roleDefinitionIdOrName

The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.

• Required: Yes
• Type: string

Parameter: roleAssignments.condition

The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container".

• Required: No
• Type: string

Parameter: roleAssignments.conditionVersion

Version of the condition.

• Required: No
• Type: string
• Allowed:

  [
    '2.0'
  ]
  

Parameter: roleAssignments.delegatedManagedIdentityResourceId

The Resource Id of the delegated managed identity resource.

• Required: No
• Type: string

Parameter: roleAssignments.description

The description of the role assignment.

• Required: No
• Type: string

Parameter: roleAssignments.name

The name (as GUID) of the role assignment. If not provided, a GUID will be generated.

• Required: No
• Type: string

Parameter: roleAssignments.principalType

The principal type of the assigned principal ID.

• Required: No
• Type: string
• Allowed:

  [
    'Device'
    'ForeignGroup'
    'Group'
    'ServicePrincipal'
    'User'
  ]
  

Parameter: ssoadfsAuthority

URL to customer ADFS server for signing WVD SSO certificates.

• Required: No
• Type: string

Parameter: ssoClientId

ClientId for the registered Relying Party used to issue WVD SSO certificates.

• Required: No
• Type: string

Parameter: ssoClientSecretKeyVaultPath

Path to Azure KeyVault storing the secret used for communication to ADFS.

• Required: No
• Type: string

Parameter: ssoSecretType

The type of single sign on Secret Type.

• Required: No
• Type: string
• Allowed:

  [
    ''
    'Certificate'
    'CertificateInKeyVault'
    'SharedKey'
    'SharedKeyInKeyVault'
  ]
  

Parameter: startVMOnConnect

Enable Start VM on connect to allow users to start the virtual machine from a deallocated state. Important: Custom RBAC role required to power manage VMs.

• Required: No
• Type: bool
• Default: False

Parameter: tags

Tags of the resource.

• Required: No
• Type: object

Parameter: tokenValidityLength

Host Pool token validity length. Usage: 'PT8H' - valid for 8 hours; 'P5D' - valid for 5 days; 'P1Y' - valid for 1 year. When not provided, the token will be valid for 8 hours.

• Required: No
• Type: string
• Default: 'PT8H'

Parameter: validationEnvironment

Validation host pools allows you to test service changes before they are deployed to production. When set to true, the Host Pool will be deployed in a validation 'ring' (environment) that receives all the new features (might be less stable). Defaults to false that stands for the stable, production-ready environment.

• Required: No
• Type: bool
• Default: False

Parameter: vmTemplate

The necessary information for adding more VMs to this Host Pool.

• Required: No
• Type: object
• Default: {}

Parameter: baseTime

Do not provide a value! This date value is used to generate a registration token.

• Required: No
• Type: string
• Default: [utcNow('u')]

Outputs

Cross-referenced modules

This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.