terraform-azurerm-avm-ptn-avd-lza-managementplane

This is a repo for Terraform Azure Verified Module for Azure Virtual Desktop

Features

• Azure Virtual Desktop Host Pool
• Azure Virtual Desktop Application Group
• Azure Virtual Desktop Workspace
• Azure Virtual Desktop Scaling

Requirements

The following requirements are needed by this module:

• terraform (~> 1.7.0)

• azuread (>= 2.47.0, < 3.0.0)

• azurerm (>= 3.71.0, < 4.0.0)

• random (>= 3.6.0, <4.0.0)

Providers

The following providers are used by this module:

• azuread (>= 2.47.0, < 3.0.0)

• azurerm (>= 3.71.0, < 4.0.0)

• random (>= 3.6.0, <4.0.0)

Resources

The following resources are used by this module:

• azurerm_private_endpoint.this (resource)
• azurerm_private_endpoint_application_security_group_association.this (resource)
• azurerm_resource_group.this (resource)
• azurerm_resource_group_template_deployment.telemetry (resource)
• azurerm_role_assignment.new (resource)
• azurerm_virtual_desktop_host_pool_registration_info.registrationinfo (resource)
• azurerm_virtual_desktop_workspace_application_group_association.workappgrassoc (resource)
• random_id.telem (resource)
• random_integer.region_index (resource)
• random_uuid.example (resource)
• azuread_service_principal.spn (data source)
• azurerm_role_definition.power_role (data source)
• azurerm_subscription.primary (data source)

Required Inputs

The following input variables are required:

description

Description: (Optional) The description of the AVD Workspace.

Type: string

location

Description: (Required) The location/region where the Azure Virtual Desktop resources are located. Changing this forces a new resource to be created.

Type: string

resource_group_name

Description: The name of the resource group in which the AVD Private Endpoint should be created.

Type: string

user_group_name

Description: Microsoft Entra ID User Group for AVD users

Type: string

virtual_desktop_application_group_name

Description: (Required) The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.

Type: string

virtual_desktop_application_group_type

Description: (Required) Type of Virtual Desktop Application Group. Valid options are RemoteApp or Desktop application groups. Changing this forces a new resource to be created.

Type: string

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_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_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

virtual_desktop_scaling_plan_name

Description: (Required) The name which should be used for this Virtual Desktop Scaling Plan . Changing this forces a new Virtual Desktop Scaling Plan to be created.

Type: string

virtual_desktop_scaling_plan_schedule

Description: - days_of_week - (Required) A list of Days of the Week on which this schedule will be used. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday

• name - (Required) The name of the schedule.
• off_peak_load_balancing_algorithm - (Required) The load Balancing Algorithm to use during Off-Peak Hours. Possible values are DepthFirst and BreadthFirst.
• off_peak_start_time - (Required) The time at which Off-Peak scaling will begin. This is also the end-time for the Ramp-Down period. The time must be specified in "HH:MM" format.
• peak_load_balancing_algorithm - (Required) The load Balancing Algorithm to use during Peak Hours. Possible values are DepthFirst and BreadthFirst.
• peak_start_time - (Required) The time at which Peak scaling will begin. This is also the end-time for the Ramp-Up period. The time must be specified in "HH:MM" format.
• ramp_down_capacity_threshold_percent - (Required) This is the value in percentage of used host pool capacity that will be considered to evaluate whether to turn on/off virtual machines during the ramp-down and off-peak hours. For example, if capacity threshold is specified as 60% and your total host pool capacity is 100 sessions, autoscale will turn on additional session hosts once the host pool exceeds a load of 60 sessions.
• ramp_down_force_logoff_users - (Required) Whether users will be forced to log-off session hosts once the ramp_down_wait_time_minutes value has been exceeded during the Ramp-Down period. Possible
• ramp_down_load_balancing_algorithm - (Required) The load Balancing Algorithm to use during the Ramp-Down period. Possible values are DepthFirst and BreadthFirst.
• ramp_down_minimum_hosts_percent - (Required) The minimum percentage of session host virtual machines that you would like to get to for ramp-down and off-peak hours. For example, if Minimum percentage of hosts is specified as 10% and total number of session hosts in your host pool is 10, autoscale will ensure a minimum of 1 session host is available to take user connections.
• ramp_down_notification_message - (Required) The notification message to send to users during Ramp-Down period when they are required to log-off.
• ramp_down_start_time - (Required) The time at which Ramp-Down scaling will begin. This is also the end-time for the Ramp-Up period. The time must be specified in "HH:MM" format.
• ramp_down_stop_hosts_when - (Required) Controls Session Host shutdown behaviour during Ramp-Down period. Session Hosts can either be shutdown when all sessions on the Session Host have ended, or when there are no Active sessions left on the Session Host. Possible values are ZeroSessions and ZeroActiveSessions.
• ramp_down_wait_time_minutes - (Required) The number of minutes during Ramp-Down period that autoscale will wait after setting the session host VMs to drain mode, notifying any currently signed in users to save their work before forcing the users to logoff. Once all user sessions on the session host VM have been logged off, Autoscale will shut down the VM.
• ramp_up_capacity_threshold_percent - (Optional) This is the value of percentage of used host pool capacity that will be considered to evaluate whether to turn on/off virtual machines during the ramp-up and peak hours. For example, if capacity threshold is specified as 60% and your total host pool capacity is 100 sessions, autoscale will turn on additional session hosts once the host pool exceeds a load of 60 sessions.
• ramp_up_load_balancing_algorithm - (Required) The load Balancing Algorithm to use during the Ramp-Up period. Possible values are DepthFirst and BreadthFirst.
• ramp_up_minimum_hosts_percent - (Optional) Specifies the minimum percentage of session host virtual machines to start during ramp-up for peak hours. For example, if Minimum percentage of hosts is specified as 10% and total number of session hosts in your host pool is 10, autoscale will ensure a minimum of 1 session host is available to take user connections.
• ramp_up_start_time - (Required) The time at which Ramp-Up scaling will begin. This is also the end-time for the Ramp-Up period. The time must be specified in "HH:MM" format.

Type:

list(object({
    days_of_week                         = set(string)
    name                                 = string
    off_peak_load_balancing_algorithm    = string
    off_peak_start_time                  = string
    peak_load_balancing_algorithm        = string
    peak_start_time                      = string
    ramp_down_capacity_threshold_percent = number
    ramp_down_force_logoff_users         = bool
    ramp_down_load_balancing_algorithm   = string
    ramp_down_minimum_hosts_percent      = number
    ramp_down_notification_message       = string
    ramp_down_start_time                 = string
    ramp_down_stop_hosts_when            = string
    ramp_down_wait_time_minutes          = number
    ramp_up_capacity_threshold_percent   = optional(number)
    ramp_up_load_balancing_algorithm     = string
    ramp_up_minimum_hosts_percent        = optional(number)
    ramp_up_start_time                   = string
  }))

virtual_desktop_scaling_plan_time_zone

Description: (Required) Specifies the Time Zone which should be used by the Scaling Plan for time based events, the possible values are defined here.

Type: string

virtual_desktop_workspace_name

Description: (Required) The name of the Virtual Desktop Workspace. Changing this forces a new resource to be created.

Type: string

Optional Inputs

The following input variables are optional (have default values):

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.

• 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:

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

Description: This variable controls whether or not telemetry is enabled for the module.

For more information see https://aka.ms/avm/telemetryinfo.

If it is set to false, then no telemetry will be collected.

Type: bool

Default: true

lock

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:

object({
    kind = string
    name = optional(string, null)
  })

Default: null

managed_identities

Description: Controls the Managed Identity configuration on this resource. The following properties can be specified:

• system_assigned - (Optional) Specifies if the System Assigned Managed Identity should be enabled.
• user_assigned_resource_ids - (Optional) Specifies a list of User Assigned Managed Identity resource IDs to be assigned to this resource.

Type:

object({
    system_assigned            = optional(bool, false)
    user_assigned_resource_ids = optional(set(string), [])
  })

Default: {}

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:

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)
    })), {})
    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: {}

public_network_access_enabled

Description: Whether or not public network access is enabled for the AVD Workspace.

Type: bool

Default: true

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:

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)
  }))

Default: {}

schedules

Description: A map of schedules to create on AVD Scaling Plan. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.

• name - The name of the schedule.
• days_of_week - The days of the week to apply the schedule to.
• off_peak_start_time - The start time of the off peak period.
• off_peak_load_balancing_algorithm - The load balancing algorithm to use during the off peak period.
• ramp_down_capacity_threshold_percent - The capacity threshold percentage to use during the ramp down period.
• ramp_down_force_logoff_users - Whether to force log off users during the ramp down period.
• ramp_down_load_balancing_algorithm - The load balancing algorithm to use during the ramp down period.
• ramp_down_minimum_hosts_percent - The minimum hosts percentage to use during the ramp down period.
• ramp_down_notification_message - The notification message to use during the ramp down period.
• ramp_down_start_time - The start time of the ramp down period.
• ramp_down_stop_hosts_when - When to stop hosts during the ramp down period.
• ramp_down_wait_time_minutes - The wait time in minutes to use during the ramp down period.
• peak_start_time - The start time of the peak period.
• peak_load_balancing_algorithm - The load balancing algorithm to use during the peak period.
• ramp_up_capacity_threshold_percent - (Optional) The capacity threshold percentage to use during the ramp up period.
• ramp_up_load_balancing_algorithm - The load balancing algorithm to use during the ramp up period.
• ramp_up_minimum_hosts_percent - (Optional) The minimum hosts percentage to use during the ramp up period.
• ramp_up_start_time - The start time of the ramp up period.

Type:

map(object({
    name                                 = string
    days_of_week                         = set(string)
    off_peak_start_time                  = string
    off_peak_load_balancing_algorithm    = string
    ramp_down_capacity_threshold_percent = number
    ramp_down_force_logoff_users         = bool
    ramp_down_load_balancing_algorithm   = string
    ramp_down_minimum_hosts_percent      = number
    ramp_down_notification_message       = string
    ramp_down_start_time                 = string
    ramp_down_stop_hosts_when            = string
    ramp_down_wait_time_minutes          = number
    peak_start_time                      = string
    peak_load_balancing_algorithm        = string
    ramp_up_capacity_threshold_percent   = optional(number)
    ramp_up_load_balancing_algorithm     = string
    ramp_up_minimum_hosts_percent        = optional(number)
    ramp_up_start_time                   = string
  }))

Default:

{
  "schedule1": {
    "days_of_week": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "name": "Weekdays",
    "off_peak_load_balancing_algorithm": "DepthFirst",
    "off_peak_start_time": "22:00",
    "peak_load_balancing_algorithm": "BreadthFirst",
    "peak_start_time": "09:00",
    "ramp_down_capacity_threshold_percent": 5,
    "ramp_down_force_logoff_users": false,
    "ramp_down_load_balancing_algorithm": "DepthFirst",
    "ramp_down_minimum_hosts_percent": 10,
    "ramp_down_notification_message": "Please log off in the next 45 minutes...",
    "ramp_down_start_time": "19:00",
    "ramp_down_stop_hosts_when": "ZeroSessions",
    "ramp_down_wait_time_minutes": 45,
    "ramp_up_capacity_threshold_percent": 10,
    "ramp_up_load_balancing_algorithm": "BreadthFirst",
    "ramp_up_minimum_hosts_percent": 20,
    "ramp_up_start_time": "05:00"
  }
}

subresource_names

Description: The names of the subresources to assosciatied with the private endpoint. The target subresource must be one of: 'feed', or 'global'.

Type: list(string)

Default: []

tags

Description: (Optional) Tags of the resource.

Type: map(string)

Default: null

time_zone

Description: The time zone of the AVD Scaling Plan.

Type: string

Default: "Eastern Standard Time"

tracing_tags_enabled

Description: Whether enable tracing tags that generated by BridgeCrew Yor.

Type: bool

Default: false

tracing_tags_prefix

Description: Default prefix for generated tracing tags

Type: string

Default: "avm_"

virtual_desktop_application_group_default_desktop_display_name

Description: (Optional) Option to set the display name for the default sessionDesktop desktop when type is set to Desktop.

Type: string

Default: null

virtual_desktop_application_group_description

Description: (Optional) Option to set a description for the Virtual Desktop Application Group.

Type: string

Default: null

virtual_desktop_application_group_friendly_name

Description: (Optional) Option to set a friendly name for the Virtual Desktop Application Group.

Type: string

Default: null

virtual_desktop_application_group_tags

Description: (Optional) A mapping of tags to assign to the resource.

Type: map(string)

Default: null

virtual_desktop_application_group_timeouts

Description: - create - (Defaults to 60 minutes) Used when creating the Virtual Desktop Application Group.

• delete - (Defaults to 60 minutes) Used when deleting the Virtual Desktop Application Group.
• read - (Defaults to 5 minutes) Used when retrieving the Virtual Desktop Application Group.
• update - (Defaults to 60 minutes) Used when updating the Virtual Desktop Application Group.

Type:

object({
    create = optional(string)
    delete = optional(string)
    read   = optional(string)
    update = optional(string)
  })

Default: null

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.

Type: string

Default: "drivestoredirect:s:*;audiomode:i:0;videoplaybackmode:i:1;redirectclipboard:i:1;redirectprinters:i:1;devicestoredirect:s:*;redirectcomports:i:1;redirectsmartcards:i:1;usbdevicestoredirect:s:*;enablecredsspsupport:i:1;use multimon:i:0"

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

Description: (Optional) A friendly name for the Virtual Desktop Host Pool.

Type: string

Default: null

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

Description: (Optional) Automatic assignment

Type: string

Default: null

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

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:

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

Description: (Optional) Enables or disables the Start VM on Connection Feature. Defaults to false.

Type: bool

Default: null

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

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:

object({
    create = optional(string)
    delete = optional(string)
    read   = optional(string)
    update = optional(string)
  })

Default: null

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_scaling_plan_description

Description: (Optional) A description of the Scaling Plan.

Type: string

Default: null

virtual_desktop_scaling_plan_exclusion_tag

Description: (Optional) The name of the tag associated with the VMs you want to exclude from autoscaling.

Type: string

Default: null

virtual_desktop_scaling_plan_friendly_name

Description: (Optional) Friendly name of the Scaling Plan.

Type: string

Default: null

virtual_desktop_scaling_plan_host_pool

Description: - hostpool_id - (Required) The ID of the HostPool to assign the Scaling Plan to.

• scaling_plan_enabled - (Required) Specifies if the scaling plan is enabled or disabled for the HostPool.

Type:

list(object({
    hostpool_id          = string
    scaling_plan_enabled = bool
  }))

Default: null

virtual_desktop_scaling_plan_tags

Description: (Optional) A mapping of tags which should be assigned to the Virtual Desktop Scaling Plan .

Type: map(string)

Default: null

virtual_desktop_scaling_plan_timeouts

Description: - create - (Defaults to 1 hour) Used when creating the Virtual Desktop Scaling Plan.

• delete - (Defaults to 1 hour) Used when deleting the Virtual Desktop Scaling Plan.
• read - (Defaults to 5 minutes) Used when retrieving the Virtual Desktop Scaling Plan.
• update - (Defaults to 1 hour) Used when updating the Virtual Desktop Scaling Plan.

Type:

object({
    create = optional(string)
    delete = optional(string)
    read   = optional(string)
    update = optional(string)
  })

Default: null

virtual_desktop_workspace_description

Description: (Optional) A description for the Virtual Desktop Workspace.

Type: string

Default: null

virtual_desktop_workspace_friendly_name

Description: (Optional) A friendly name for the Virtual Desktop Workspace.

Type: string

Default: null

virtual_desktop_workspace_public_network_access_enabled

Description: (Optional) Whether public network access is allowed for this Virtual Desktop Workspace. Defaults to true.

Type: bool

Default: null

virtual_desktop_workspace_tags

Description: (Optional) A mapping of tags to assign to the resource.

Type: map(string)

Default: null

virtual_desktop_workspace_timeouts

Description: - create - (Defaults to 60 minutes) Used when creating the Virtual Desktop Workspace.

• delete - (Defaults to 60 minutes) Used when deleting the Virtual Desktop Workspace.
• read - (Defaults to 5 minutes) Used when retrieving the Virtual Desktop Workspace.
• update - (Defaults to 60 minutes) Used when updating the Virtual Desktop Workspace.

Type:

object({
    create = optional(string)
    delete = optional(string)
    read   = optional(string)
    update = optional(string)
  })

Default: null

Outputs

The following outputs are exported:

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.

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

Modules

The following Modules are called:

avm_res_desktopvirtualization_applicationgroup

Source: Azure/avm-res-desktopvirtualization-applicationgroup/azurerm

Version: 0.1.3

avm_res_desktopvirtualization_hostpool

Source: Azure/avm-res-desktopvirtualization-hostpool/azurerm

Version: 0.1.4

avm_res_desktopvirtualization_scaling_plan

Source: Azure/avm-res-desktopvirtualization-scalingplan/azurerm

Version: 0.1.2

avm_res_desktopvirtualization_workspace

Source: Azure/avm-res-desktopvirtualization-workspace/azurerm

Version: 0.1.2

avm_res_operationalinsights_workspace

Source: Azure/avm-res-operationalinsights-workspace/azurerm

Version: 0.1.3

naming

Source: Azure/naming/azurerm

Version: 0.3.0

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.