Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/azure/terraform-azurerm-avm-res-desktopvirtualization-hostpool
AVM for Desktop Virtualization Hostpools
https://github.com/azure/terraform-azurerm-avm-res-desktopvirtualization-hostpool
azure-virtual-desktop desktop-virtualization hostpool module terraform
Last synced: about 1 month ago
JSON representation
AVM for Desktop Virtualization Hostpools
- Host: GitHub
- URL: https://github.com/azure/terraform-azurerm-avm-res-desktopvirtualization-hostpool
- Owner: Azure
- License: mit
- Created: 2023-10-18T16:36:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-26T13:41:18.000Z (about 1 month ago)
- Last Synced: 2024-09-30T16:11:00.181Z (about 1 month ago)
- Topics: azure-virtual-desktop, desktop-virtualization, hostpool, module, terraform
- Language: HCL
- Homepage: https://registry.terraform.io/modules/Azure/avm-res-desktopvirtualization-hostpool/azurerm/latest
- Size: 112 KB
- Stars: 3
- Watchers: 7
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
# terraform-azurerm-avm-res-desktopvirtualization-hostpool
[](http://isitmaintained.com/project/Azure/terraform-azurerm-avm-res-desktopvirtualization-hostpool "Average time to resolve an issue")
[](http://isitmaintained.com/project/Azure/terraform-azurerm-avm-res-desktopvirtualization-hostpool "Percentage of issues still open")
Module to deploy Azure Virtual Desktop Host Pool and associated resources.
## Features
- Azure Virtual Desktop Host Pool
- RDP Properties
- Properties
- Scheduled agent updates
- Optional Private Endpoint
S
## Requirements
The following requirements are needed by this module:
- [terraform](#requirement\_terraform) (>= 1.6.6, < 2.0.0)
- [azurerm](#requirement\_azurerm) (>= 3.11.1, < 4.0.0)
- [modtm](#requirement\_modtm) (~> 0.3)
- [random](#requirement\_random) (~> 3.5)
## Resources
The following resources are used by this module:
- [azurerm_monitor_diagnostic_setting.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/monitor_diagnostic_setting) (resource)
- [azurerm_private_endpoint.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/private_endpoint) (resource)
- [azurerm_private_endpoint_application_security_group_association.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/private_endpoint_application_security_group_association) (resource)
- [azurerm_virtual_desktop_host_pool.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_desktop_host_pool) (resource)
- [azurerm_virtual_desktop_host_pool_registration_info.registrationinfo](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_desktop_host_pool_registration_info) (resource)
- [modtm_telemetry.telemetry](https://registry.terraform.io/providers/azure/modtm/latest/docs/resources/telemetry) (resource)
- [random_uuid.telemetry](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/uuid) (resource)
- [azurerm_client_config.telemetry](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config) (data source)
- [modtm_module_source.telemetry](https://registry.terraform.io/providers/azure/modtm/latest/docs/data-sources/module_source) (data source)
## Required Inputs
The following input variables are required:
### [resource\_group\_name](#input\_resource\_group\_name)
Description: The resource group where the resources will be deployed.
Type: `string`
### [virtual\_desktop\_host\_pool\_load\_balancer\_type](#input\_virtual\_desktop\_host\_pool\_load\_balancer\_type)
Description: (Required) `BreadthFirst` load balancing distributes new user sessions across all available session hosts in the host pool. Possible values are `BreadthFirst`, `DepthFirst` and `Persistent`. `DepthFirst` load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold. `Persistent` should be used if the host pool type is `Personal`
Type: `string`
### [virtual\_desktop\_host\_pool\_location](#input\_virtual\_desktop\_host\_pool\_location)
Description: (Required) The location/region where the Virtual Desktop Host Pool is located. Changing this forces a new resource to be created.
Type: `string`
### [virtual\_desktop\_host\_pool\_name](#input\_virtual\_desktop\_host\_pool\_name)
Description: (Required) The name of the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
Type: `string`
### [virtual\_desktop\_host\_pool\_resource\_group\_name](#input\_virtual\_desktop\_host\_pool\_resource\_group\_name)
Description: (Required) The name of the resource group in which to create the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
Type: `string`
### [virtual\_desktop\_host\_pool\_type](#input\_virtual\_desktop\_host\_pool\_type)
Description: (Required) The type of the Virtual Desktop Host Pool. Valid options are `Personal` or `Pooled`. Changing the type forces a new resource to be created.
Type: `string`
## Optional Inputs
The following input variables are optional (have default values):
### [diagnostic\_settings](#input\_diagnostic\_settings)
Description: A map of diagnostic settings to create on the resource. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
A map of diagnostic settings to create on the resource. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
- `name` - (Optional) The name of the diagnostic setting. One will be generated if not set, however this will not be unique if you want to create multiple diagnostic setting resources.
- `log_categories` - (Optional) A set of log categories to send to the log analytics workspace. Defaults to `[]`.
- `log_groups` - (Optional) A set of log groups to send to the log analytics workspace. Defaults to `["allLogs"]`.
- `metric_categories` - (Optional) A set of metric categories to send to the log analytics workspace. Defaults to `["AllMetrics"]`.
- `log_analytics_destination_type` - (Optional) The destination type for the diagnostic setting. Possible values are `Dedicated` and `AzureDiagnostics`. Defaults to `Dedicated`.
- `workspace_resource_id` - (Optional) The resource ID of the log analytics workspace to send logs and metrics to.
- `storage_account_resource_id` - (Optional) The resource ID of the storage account to send logs and metrics to.
- `event_hub_authorization_rule_resource_id` - (Optional) The resource ID of the event hub authorization rule to send logs and metrics to.
- `event_hub_name` - (Optional) The name of the event hub. If none is specified, the default event hub will be selected.
- `marketplace_partner_resource_id` - (Optional) The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic LogsLogs.
Type:
```hcl
map(object({
name = optional(string, null)
log_categories = optional(set(string), [])
log_groups = optional(set(string), ["allLogs"])
metric_categories = optional(set(string), ["AllMetrics"])
log_analytics_destination_type = optional(string, "Dedicated")
workspace_resource_id = optional(string, null)
storage_account_resource_id = optional(string, null)
event_hub_authorization_rule_resource_id = optional(string, null)
event_hub_name = optional(string, null)
marketplace_partner_resource_id = optional(string, null)
}))
```
Default: `{}`
### [enable\_telemetry](#input\_enable\_telemetry)
Description: This variable controls whether or not telemetry is enabled for the module.
For more information see https://aka.ms/avm/telemetry.
If it is set to false, then no telemetry will be collected.
Type: `bool`
Default: `true`
Description: Controls the Resource Lock configuration for this resource. The following properties can be specified:
- `kind` - (Required) The type of lock. Possible values are `\"CanNotDelete\"` and `\"ReadOnly\"`.
- `name` - (Optional) The name of the lock. If not specified, a name will be generated based on the `kind` value. Changing this forces the creation of a new resource.
Type:
```hcl
object({
kind = string
name = optional(string, null)
})
```
Default: `null`
### [private\_endpoints](#input\_private\_endpoints)
Description: A map of private endpoints to create on the resource. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
- `name` - (Optional) The name of the private endpoint. One will be generated if not set.
- `role_assignments` - (Optional) A map of role assignments to create on the private endpoint. Each role assignment should include a `role_definition_id_or_name` and a `principal_id`.
- `lock` - (Optional) The lock level to apply to the private endpoint. Default is `None`. Possible values are `None`, `CanNotDelete`, and `ReadOnly`.
- `tags` - (Optional) A mapping of tags to assign to the private endpoint. Each tag should be a string.
- `subnet_resource_id` - The resource ID of the subnet to deploy the private endpoint in.
- `private_dns_zone_group_name` - (Optional) The name of the private DNS zone group. One will be generated if not set.
- `private_dns_zone_resource_ids` - (Optional) A set of resource IDs of private DNS zones to associate with the private endpoint. If not set, no zone groups will be created and the private endpoint will not be associated with any private DNS zones. DNS records must be managed external to this module.
- `application_security_group_resource_ids` - (Optional) A map of resource IDs of application security groups to associate with the private endpoint. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
- `private_service_connection_name` - (Optional) The name of the private service connection. One will be generated if not set.
- `network_interface_name` - (Optional) The name of the network interface. One will be generated if not set.
- `location` - (Optional) The Azure location where the resources will be deployed. Defaults to the location of the resource group.
- `resource_group_name` - (Optional) The resource group where the resources will be deployed. Defaults to the resource group of the resource.
- `ip_configurations` - (Optional) A map of IP configurations to create on the private endpoint. If not specified the platform will create one. Each IP configuration should include a `name` and a `private_ip_address`.
Type:
```hcl
map(object({
name = optional(string, null)
role_assignments = optional(map(object({
role_definition_id_or_name = string
principal_id = string
description = optional(string, null)
skip_service_principal_aad_check = optional(bool, false)
condition = optional(string, null)
condition_version = optional(string, null)
delegated_managed_identity_resource_id = optional(string, null)
principal_type = optional(string, null)
})), {})
lock = optional(object({
name = optional(string, null)
kind = string
}), null)
tags = optional(map(string), null)
subnet_resource_id = string
private_dns_zone_group_name = optional(string, "default")
private_dns_zone_resource_ids = optional(set(string), [])
application_security_group_associations = optional(map(string), {})
private_service_connection_name = optional(string, null)
network_interface_name = optional(string, null)
location = optional(string, null)
resource_group_name = optional(string, null)
ip_configurations = optional(map(object({
name = string
private_ip_address = string
})), {})
}))
```
Default: `{}`
### [registration\_expiration\_period](#input\_registration\_expiration\_period)
Description: The expiration period for the registration token. Must be less than or equal to 30 days.
Type: `string`
Default: `"48h"`
### [role\_assignments](#input\_role\_assignments)
Description: A map of role assignments to create on the resource. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
- `role_definition_id_or_name` - The ID or name of the role definition to assign to the principal.
- `principal_id` - The ID of the principal to assign the role to.
- `description` - The description of the role assignment.
- `skip_service_principal_aad_check` - If set to true, skips the Azure Active Directory check for the service principal in the tenant. Defaults to false.
- `condition` - The condition which will be used to scope the role assignment.
- `condition_version` - The version of the condition syntax. Leave as `null` if you are not using a condition, if you are then valid values are '2.0'.
> Note: only set `skip_service_principal_aad_check` to true if you are assigning a role to a service principal.
Type:
```hcl
map(object({
role_definition_id_or_name = string
principal_id = string
description = optional(string, null)
skip_service_principal_aad_check = optional(bool, false)
condition = optional(string, null)
condition_version = optional(string, null)
delegated_managed_identity_resource_id = optional(string, null)
principal_type = optional(string, null)
}))
```
Default: `{}`
Description: (Optional) Tags of the resource.
Type: `map(string)`
Default: `null`
### [tracing\_tags\_enabled](#input\_tracing\_tags\_enabled)
Description: Whether enable tracing tags that generated by BridgeCrew Yor.
Type: `bool`
Default: `false`
### [tracing\_tags\_prefix](#input\_tracing\_tags\_prefix)
Description: Default prefix for generated tracing tags
Type: `string`
Default: `"avm_"`
### [virtual\_desktop\_host\_pool\_custom\_rdp\_properties](#input\_virtual\_desktop\_host\_pool\_custom\_rdp\_properties)
Description: (Optional) A valid custom RDP properties string for the Virtual Desktop Host Pool, available properties can be [found in this article](https://docs.microsoft.com/windows-server/remote/remote-desktop-services/clients/rdp-files).
Type: `string`
Default: `null`
### [virtual\_desktop\_host\_pool\_description](#input\_virtual\_desktop\_host\_pool\_description)
Description: (Optional) A description for the Virtual Desktop Host Pool.
Type: `string`
Default: `null`
### [virtual\_desktop\_host\_pool\_friendly\_name](#input\_virtual\_desktop\_host\_pool\_friendly\_name)
Description: (Optional) A friendly name for the Virtual Desktop Host Pool.
Type: `string`
Default: `null`
### [virtual\_desktop\_host\_pool\_maximum\_sessions\_allowed](#input\_virtual\_desktop\_host\_pool\_maximum\_sessions\_allowed)
Description: (Optional) A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host. Should only be set if the `type` of your Virtual Desktop Host Pool is `Pooled`.
Type: `number`
Default: `null`
### [virtual\_desktop\_host\_pool\_personal\_desktop\_assignment\_type](#input\_virtual\_desktop\_host\_pool\_personal\_desktop\_assignment\_type)
Description: (Optional) `Automatic` assignment
Type: `string`
Default: `null`
### [virtual\_desktop\_host\_pool\_preferred\_app\_group\_type](#input\_virtual\_desktop\_host\_pool\_preferred\_app\_group\_type)
Description: Preferred App Group type to display
Type: `string`
Default: `null`
### [virtual\_desktop\_host\_pool\_scheduled\_agent\_updates](#input\_virtual\_desktop\_host\_pool\_scheduled\_agent\_updates)
Description: - `enabled` - (Optional) Enables or disables scheduled updates of the AVD agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) on session hosts. If this is enabled then up to two `schedule` blocks must be defined. Default is `false`.
- `timezone` - (Optional) Specifies the time zone in which the agent update schedule will apply. If `use_session_host_timezone` is enabled then it will override this setting. Default is `UTC`
- `use_session_host_timezone` - (Optional) Specifies whether scheduled agent updates should be applied based on the timezone of the affected session host. If configured then this setting overrides `timezone`. Default is `false`.
---
`schedule` block supports the following:
- `day_of_week` - (Required) The day of the week on which agent updates should be performed. Possible values are `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, `Saturday`, and `Sunday`
- `hour_of_day` - (Required) The hour of day the update window should start. The update is a 2 hour period following the hour provided. The value should be provided as a number between 0 and 23, with 0 being midnight and 23 being 11pm. A leading zero should not be used.
Type:
```hcl
object({
enabled = optional(bool)
timezone = optional(string)
use_session_host_timezone = optional(bool)
schedule = optional(list(object({
day_of_week = string
hour_of_day = number
})))
})
```
Default: `null`
### [virtual\_desktop\_host\_pool\_start\_vm\_on\_connect](#input\_virtual\_desktop\_host\_pool\_start\_vm\_on\_connect)
Description: (Optional) Enables or disables the Start VM on Connection Feature. Defaults to `false`.
Type: `bool`
Default: `null`
### [virtual\_desktop\_host\_pool\_tags](#input\_virtual\_desktop\_host\_pool\_tags)
Description: (Optional) A mapping of tags to assign to the resource.
Type: `map(string)`
Default: `null`
### [virtual\_desktop\_host\_pool\_timeouts](#input\_virtual\_desktop\_host\_pool\_timeouts)
Description: - `create` - (Defaults to 60 minutes) Used when creating the Virtual Desktop Host Pool.
- `delete` - (Defaults to 60 minutes) Used when deleting the Virtual Desktop Host Pool.
- `read` - (Defaults to 5 minutes) Used when retrieving the Virtual Desktop Host Pool.
- `update` - (Defaults to 60 minutes) Used when updating the Virtual Desktop Host Pool.
Type:
```hcl
object({
create = optional(string)
delete = optional(string)
read = optional(string)
update = optional(string)
})
```
Default: `null`
### [virtual\_desktop\_host\_pool\_validate\_environment](#input\_virtual\_desktop\_host\_pool\_validate\_environment)
Description: (Optional) Allows you to test service changes before they are deployed to production. Defaults to `false`.
Type: `bool`
Default: `null`
### [virtual\_desktop\_host\_pool\_vm\_template](#input\_virtual\_desktop\_host\_pool\_vm\_template)
Description: (Optional) - A VM template for session hosts configuration within hostpool.
- `type` - (Required) The type of the VM template. Possible values are `Gallery` or `CustomImage`.
- `custom_image` - (Optional) A custom image to use for the session hosts. If set, the `type` must be `CustomImage`.
- `gallery_image_reference` - (Optional) An image reference to use for the session hosts. If set, the `type` must be `Gallery`.
- `offer` - (Required) The offer of the VM template.
- `publisher` - (Required) The publisher of the VM template.
- `sku` - (Required) The SKU of the VM template.
- `version` - (Required) The version of the VM template.
- `osDisktype` - (Required) The OS Disk type of the VM template. Possible values are `Standard_LRS` or `Premium_LRS`.
"
Type:
```hcl
object({
type = string
custom_image = optional(object({
resource_id = string
}))
gallery_image_reference = optional(object({
offer = string
publisher = string
sku = string
version = string
}))
osDisktype = string
})
```
Default: `null`
## Outputs
The following outputs are exported:
### [private\_endpoints](#output\_private\_endpoints)
Description: A map of private endpoints. The map key is the supplied input to var.private\_endpoints. The map value is the entire azurerm\_private\_endpoint resource.
### [registrationinfo\_token](#output\_registrationinfo\_token)
Description: The token for the host pool registration.
### [resource](#output\_resource)
Description: This output is the full output for the resource to allow flexibility to reference all possible values for the resource. Example usage: module..resource.id
### [resource\_id](#output\_resource\_id)
Description: This output is the full output for the resource to allow flexibility to reference all possible values for the resource. Example usage: module..resource.id
## Modules
No modules.
## 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 . 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.