avm-res-web-serverfarm
Azure/avm-res-web-serverfarm/azurerm
Terraform Azure Verified Resource Module for App Service Plan
terraform-azurerm-avm-res-web-serverfarm This is the web server farm (App Service Plan) resource module for the Azure Verified Modules library. This module deploys an App Service Plan (ASP). It leverages the AzureRM provider and sets a number of initial defaults to minimize the overall inputs for simple configurations. > [!IMPORTANT] > As the overall AVM framework is not GA (generally available) yet - the CI framework and test automation is not fully functional and implemented across all supported languages yet - breaking changes are expected, and additional customer feedback is yet to be gathered and incorporated. Hence, modules WILL NOT be published at version 1.0.0 or higher at this time. > > However, it is important to note that this DOES NOT mean that this module cannot be consumed an
| Name | Type | Description | Default |
|---|---|---|---|
| location | string | The location where the resources will be deployed. | required |
| name | string | The name of the this resource. | required |
| os_type | string | The operating system type of the service plan. Possible values are `Windows`, `L | required |
| parent_id | string | The resource ID of the resource group in which to create this resource. | required |
| plan_default_identity | object({ identity_type | Optional: The default identity configuration for the Managed Instance App Serv | null |
| premium_plan_auto_scale_enabled | bool | Defaults to false. Should elastic scale be enabled for this App Service Plan. On | false |
| rdp_enabled | bool | Optional: Whether RDP is enabled for the Managed Instance App Service Plan. Only | null |
| registry_adapters | list(object({ registry_key | Optional: A list of registry adapters associated with this App Service Plan. O | null |
| tags | map(string) | Tags of the resource. | null |
| worker_count | number | The number of workers to allocate for this App Service Plan. Defaults to `3`, wh | 3 |
| app_service_environment_id | string | Optional: The ID of the App Service Environment. | null |
| install_scripts | list(object({ name = strin | Optional: A list of install scripts to run on the Managed Instance App Service | null |
| lock | object({ kind = string | Controls the Resource Lock configuration for this resource. The following prop | null |
| timeouts | object({ create = optional | The timeout configuration for azapi resources. The following properties can be | null |
| virtual_network_subnet_id | string | Optional: The resource ID of the subnet to integrate the App Service Plan with. | null |
| diagnostic_settings | map(object({ name = option | A map of diagnostic settings to create on the App Service Environment (ASE). T | {} |
| enable_telemetry | bool | This variable controls whether or not telemetry is enabled for the module. For m | true |
| maximum_elastic_worker_count | number | The maximum number of total workers allowed for this ElasticScaleEnabled App Ser | 3 |
| per_site_scaling_enabled | bool | Should per site scaling be enabled for this App Service Plan. | false |
| retry | object({ error_message_reg | The retry configuration for azapi resources. The following properties can be s | null |
| server_farm_resource_type | string | The resource type for the server farm. Defaults to `Microsoft.Web/serverfarms`. | "Microsoft.Web/serverfarms@2025-03-01" |
| storage_mounts | list(object({ name | Optional: A list of storage mounts to configure on the App Service Plan. Only | null |
| managed_identities | object({ system_assigned | Controls the managed identity configuration on this resource. The following pr | {} |
| role_assignments | map(object({ role_definiti | A map of role assignments to create on the resource. The map key is deliberate | {} |
name — Name of the app service planresource_id — Resource id of the app service plan