-hostpool`. | `string` | `""` | no |
| [host\_pool\_type](#input\_host\_pool\_type) | The type of the host pool. Valid options are `Personal` or `Pooled` | `string` | n/a | yes |
| [host\_source\_image\_reference](#input\_host\_source\_image\_reference) | The reference to the operating system that will be used in the hosts. You can find this with [az cli](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/cli-ps-findimage) or [PowerShell](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/cli-ps-findimage). This should most likely be a variant of Windows 10/11 enterprise multi session-edition or Windows Server. | object({
publisher = string
offer = string
sku = string
version = string
}) | {
"offer": "windows-11",
"publisher": "microsoftwindowsdesktop",
"sku": "win11-21h2-avd",
"version": "latest"
} | no |
+| [license\_type](#input\_license\_type) | Specifies a type of on-premises license to be used with the session hosts. Sometimes referred to as Azure Hybrid Benefit. You must have a license with mutli-tenant hosting rights ([Windows Server](https://learn.microsoft.com/en-us/windows-server/get-started/azure-hybrid-benefit) or [Windows 10/11](https://learn.microsoft.com/en-us/azure/virtual-machines/windows/windows-desktop-multitenant-hosting-deployment)). Possible values are `None`, `Windows_Client` and `Windows_Server`. | `string` | `"None"` | no |
| [local\_admin\_password](#input\_local\_admin\_password) | The password of the local admin account on the hosts. Defaults to generating a random password per host. This will be saved in state. | `string` | `""` | no |
| [local\_admin\_username](#input\_local\_admin\_username) | The username of the local admin account on the hosts. | `string` | `"azureuser"` | no |
| [network\_interface\_name\_format](#input\_network\_interface\_name\_format) | The format of the NIC names. The string is var.system\_name. The number is the NIC number. See [format-function](https://www.terraform.io/language/functions/format). | `string` | `"%s-nic%02d"` | no |
| [number\_of\_hosts](#input\_number\_of\_hosts) | The number of hosts that will be deployed. | `number` | n/a | yes |
| [resource\_group\_name](#input\_resource\_group\_name) | The name of the resource group in which to deploy the AVD-resources. | `string` | n/a | yes |
+| [start\_vm\_on\_connect](#input\_start\_vm\_on\_connect) | Will enable automatic start of hosts on connection when required. Separate automation is required to stop and deallocate hosts. | `bool` | `false` | no |
| [subnet\_id](#input\_subnet\_id) | The ID of the subnet to where the hosts will be deployed. Must be in the same region as var.host\_location. | `string` | n/a | yes |
| [system\_name](#input\_system\_name) | The main name of the system. Will be used as a part of naming for multiple resources. | `string` | n/a | yes |
| [tags](#input\_tags) | Tags that will be applied to all deployed resources. | `map(string)` | `{}` | no |
@@ -208,7 +214,10 @@ No modules.
## :warning: Security note
>Be aware that the module sets role assignments on the resource group level. Meaning that *admins and users defined in the input variables will be given the same access to other VMs in the same resource group*.
-## Features
+## Feature: Start VM on connect
+>You can enable the [Start VM on Connect](https://learn.microsoft.com/en-us/azure/virtual-desktop/start-virtual-machine-connect)-feature by setting `var.start_vm_on_connect`. This will allocate deallocated VMs on user sign-in when required. It will not stop and/or deallocate running VMs. Separate automation can be set up for deallocation of unused hosts.
+
+## Roadmap
- [X] Azure AD authentication to hosts
- [ ] [Autoscale plans](https://github.com/decensas/terraform-azurerm-azure-virtual-desktop/issues/9)
- [ ] [Personal user profile roaming using fslogix](https://github.com/decensas/terraform-azurerm-azure-virtual-desktop/issues/8)
diff --git a/avd.tf b/avd.tf
index b18f291..ad8fa95 100644
--- a/avd.tf
+++ b/avd.tf
@@ -6,6 +6,7 @@ resource "azurerm_virtual_desktop_host_pool" "main" {
custom_rdp_properties = local.custom_rdp_properties != "" ? "${local.custom_rdp_properties};" : null
type = var.host_pool_type
load_balancer_type = local.host_pool_load_balancer_type
+ start_vm_on_connect = var.start_vm_on_connect
personal_desktop_assignment_type = var.host_pool_type == "Personal" ? "Automatic" : null
@@ -30,7 +31,7 @@ resource "azurerm_virtual_desktop_application_group" "main" {
lifecycle {
replace_triggered_by = [
- azurerm_virtual_desktop_host_pool.main
+ azurerm_virtual_desktop_host_pool.main.id
]
}
diff --git a/compute.tf b/compute.tf
index f3305ca..fbed6e6 100644
--- a/compute.tf
+++ b/compute.tf
@@ -23,6 +23,7 @@ resource "azurerm_windows_virtual_machine" "main" {
storage_account_type = "StandardSSD_LRS"
}
+ license_type = var.license_type
source_image_reference {
publisher = var.host_source_image_reference.publisher
offer = var.host_source_image_reference.offer
@@ -38,7 +39,7 @@ resource "azurerm_windows_virtual_machine" "main" {
lifecycle {
replace_triggered_by = [
- azurerm_virtual_desktop_host_pool.main
+ azurerm_virtual_desktop_host_pool.main.id
]
}
@@ -51,6 +52,7 @@ resource "azurerm_network_interface" "main" {
location = var.host_location
resource_group_name = var.resource_group_name
+ enable_accelerated_networking = var.enable_accelerated_networking
ip_configuration {
name = "default"
subnet_id = var.subnet_id
@@ -103,7 +105,9 @@ resource "azurerm_virtual_machine_extension" "hostpool_join" {
lifecycle {
ignore_changes = [settings]
replace_triggered_by = [
- azurerm_virtual_desktop_host_pool.main
+ azurerm_virtual_desktop_host_pool.main.id
]
}
+
+ tags = var.tags
}
diff --git a/examples/availability-set/main.tf b/examples/availability-set/main.tf
index 0644655..c1662f5 100644
--- a/examples/availability-set/main.tf
+++ b/examples/availability-set/main.tf
@@ -37,7 +37,7 @@ resource "azurerm_subnet_network_security_group_association" "main" {
module "avd" {
source = "decensas/azure-virtual-desktop/azurerm"
- version = "0.1.1"
+ version = "0.1.2"
system_name = "avd"
resource_group_name = azurerm_resource_group.main.name
diff --git a/examples/groups-assigned-shared/main.tf b/examples/groups-assigned-shared/main.tf
index cecea66..2867514 100644
--- a/examples/groups-assigned-shared/main.tf
+++ b/examples/groups-assigned-shared/main.tf
@@ -45,7 +45,7 @@ data "azuread_group" "admins" {
module "avd" {
source = "decensas/azure-virtual-desktop/azurerm"
- version = "0.1.1"
+ version = "0.1.2"
system_name = "avd"
resource_group_name = azurerm_resource_group.main.name
diff --git a/examples/user-assigned-personal/main.tf b/examples/user-assigned-personal/main.tf
index b5e8c40..4733d6f 100644
--- a/examples/user-assigned-personal/main.tf
+++ b/examples/user-assigned-personal/main.tf
@@ -37,16 +37,17 @@ resource "azurerm_subnet_network_security_group_association" "main" {
module "avd" {
source = "decensas/azure-virtual-desktop/azurerm"
- version = "0.1.1"
+ version = "0.1.2"
system_name = "avd"
resource_group_name = azurerm_resource_group.main.name
data_location = azurerm_resource_group.main.location
host_location = azurerm_resource_group.main.location
- vm_size = "Standard_D2s_v3"
- number_of_hosts = 3
- host_pool_type = "Personal"
+ vm_size = "Standard_D2s_v3"
+ number_of_hosts = 3
+ host_pool_type = "Personal"
+ start_vm_on_connect = true
avd_users_upns = ["user1@domain.com", "user2@domain.com"]
avd_admins_upns = ["admin@domain.com"]
diff --git a/examples/user-assigned-shared/main.tf b/examples/user-assigned-shared/main.tf
index d76466c..663e864 100644
--- a/examples/user-assigned-shared/main.tf
+++ b/examples/user-assigned-shared/main.tf
@@ -37,7 +37,7 @@ resource "azurerm_subnet_network_security_group_association" "main" {
module "avd" {
source = "decensas/azure-virtual-desktop/azurerm"
- version = "0.1.1"
+ version = "0.1.2"
system_name = "avd"
resource_group_name = azurerm_resource_group.main.name
diff --git a/rbac.tf b/rbac.tf
index ad5ef7c..66bd4a1 100644
--- a/rbac.tf
+++ b/rbac.tf
@@ -6,6 +6,14 @@ data "azuread_users" "admins" {
user_principal_names = var.avd_admins_upns
}
+# This is the service principal for the Microsoft-managed AVD application
+# It will vary depending on when your tenant first registered for AVD,
+# But its application ID will always be the one below, see:
+# https://learn.microsoft.com/en-us/azure/virtual-desktop/start-virtual-machine-connect?tabs=azure-portal
+data "azuread_service_principal" "avd" {
+ application_id = "9cdead84-a844-4324-93f2-b2e6bb768d07"
+}
+
resource "azurerm_role_assignment" "users" {
for_each = local.avd_users_object_ids
scope = local.resource_group_id
@@ -26,3 +34,10 @@ resource "azurerm_role_assignment" "appgroup" {
role_definition_name = "Desktop Virtualization User"
principal_id = each.value
}
+
+resource "azurerm_role_assignment" "start_on_connect" {
+ count = var.start_vm_on_connect == true ? 1 : 0
+ role_definition_name = "Desktop Virtualization Power On Contributor"
+ principal_id = data.azuread_service_principal.avd.object_id
+ scope = local.resource_group_id
+}
diff --git a/variables.tf b/variables.tf
index 71aecd3..3df9128 100644
--- a/variables.tf
+++ b/variables.tf
@@ -58,11 +58,27 @@ variable "local_admin_password" {
sensitive = true
}
+variable "license_type" {
+ type = string
+ description = "Specifies a type of on-premises license to be used with the session hosts. Sometimes referred to as Azure Hybrid Benefit. You must have a license with mutli-tenant hosting rights ([Windows Server](https://learn.microsoft.com/en-us/windows-server/get-started/azure-hybrid-benefit) or [Windows 10/11](https://learn.microsoft.com/en-us/azure/virtual-machines/windows/windows-desktop-multitenant-hosting-deployment)). Possible values are `None`, `Windows_Client` and `Windows_Server`."
+ default = "None"
+ validation {
+ condition = contains(["None", "Windows_Client", "Windows_Server"], var.license_type)
+ error_message = "The value of var.license type must be one of: None, Windows_Client, Windows_Server"
+ }
+}
+
variable "number_of_hosts" {
type = number
description = "The number of hosts that will be deployed."
}
+variable "start_vm_on_connect" {
+ type = bool
+ description = "Will enable automatic start of hosts on connection when required. Separate automation is required to stop and deallocate hosts."
+ default = false
+}
+
variable "host_pool_type" {
type = string
description = "The type of the host pool. Valid options are `Personal` or `Pooled`"
@@ -179,6 +195,12 @@ variable "availability_number_of_update_domains" {
}
}
+variable "enable_accelerated_networking" {
+ type = bool
+ description = "Should accelerated networking be enabled on the hosts? Only supported by [certain vm sizes](https://learn.microsoft.com/en-us/azure/virtual-network/accelerated-networking-overview#supported-vm-instances)."
+ default = false
+}
+
variable "tags" {
type = map(string)
description = "Tags that will be applied to all deployed resources."