terraform-azurerm-avm-res-web-staticsite

Module to deploy Static Web Apps in Azure.

Note: After the Static Site is provisioned, you'll need to associate your target repository, which contains your web app, to the Static Site, by following the Azure Static Site document. This includes manually configuring the respective YAML file for the GitHub Actions workflow to run.

Requirements

The following requirements are needed by this module:

• terraform (>= 1.7.0)

• azapi (~> 2.0, < 3.0.0)

• azurerm (~> 4.0, ~> 4.3, < 5.0.0)

• modtm (~> 0.3)

• random (>= 3.5.0, < 4.0.0)

Resources

The following resources are used by this module:

• azapi_update_resource.this (resource)
• azurerm_dns_cname_record.this (resource)
• azurerm_dns_txt_record.this (resource)
• azurerm_management_lock.pe (resource)
• azurerm_management_lock.this (resource)
• azurerm_private_endpoint.this (resource)
• azurerm_private_endpoint.this_unmanaged_dns_zone_groups (resource)
• azurerm_private_endpoint_application_security_group_association.this (resource)
• azurerm_role_assignment.pe (resource)
• azurerm_role_assignment.this (resource)
• azurerm_static_web_app.this (resource)
• azurerm_static_web_app_custom_domain.this (resource)
• modtm_telemetry.telemetry (resource)
• random_uuid.telemetry (resource)
• azurerm_client_config.telemetry (data source)
• modtm_module_source.telemetry (data source)

Required Inputs

The following input variables are required:

location

Description: Azure region where the resource should be deployed.

Type: string

name

Description: The name of the this resource.

Type: string

resource_group_name

Description: The resource group where the resources will be deployed.

Type: string

Optional Inputs

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

all_child_resources_inherit_lock

Description: Whether all child resources should inherit the locks of the parent resource.

Type: bool

Default: true

all_child_resources_inherit_tags

Description: Whether all child resources should inherit the tags of the parent resource.

Type: bool

Default: true

app_settings

Description: A map of app settings to assign to the static site.

app_settings = {
  WEBSITE_NODE_DEFAULT_VERSION = "10.14.1"
  WEBSITE_TIME_ZONE            = "Pacific Standard Time"
  WEB_CONCURRENCY              = "1"
  WEBSITE_RUN_FROM_PACKAGE     = "1"
  WEBSITE_ENABLE_SYNC_UPDATE_SITE = "true"
  WEBSITE_ENABLE_SYNC_UPDATE_SITE_LOCKED = "false"
  WEBSITE_NODE_DEFAULT_VERSION_LOCKED = "false"
  WEBSITE_TIME_ZONE_LOCKED = "false"
  WEB_CONCURRENCY_LOCKED = "false"
  WEBSITE_RUN_FROM_PACKAGE_LOCKED = "false"
}

Type: map(string)

Default: {}

basic_auth

Description: Object that controls basic authentication access

basic_auth = {
  password = "P@55word1234"
  environments = "StagingEnvironment"
}

Type:

object({
    password     = string
    environments = string
  })

Default: null

basic_auth_enabled

Description: Whether or not basic authentication should be enabled. Needs to be set to true in order for basic_auth credentials to be evaluated. Defaults to false.

Type: bool

Default: false

branch

Description: The branch of the repository to deploy.

Type: string

Default: null

configuration_file_changes_enabled

Description: Should changes to the configuration file be permitted? Defaults to true.

Type: bool

Default: true

custom_domains

Description: A map of custom domains to assign to the static site.

• resource_group_name - (Optional) The name of the resource group where the custom domain is located. If not set, the resource group of the static site will be used.
• domain_name - (Optional) The domain name of the custom domain. If not set, the domain name will be generated from the cname_name and cname_zone_name.
• ttl - (Optional) The TTL of the custom domain. Defaults to 300.
• validation_type - (Optional) The type of validation to use for the custom domain. Possible values are cname-delegation and dns-txt-token. Defaults to cname-delegation.
• create_cname_records - (Optional) If set to true, CNAME records will be created for the custom domain. Defaults to false.
• create_txt_records - (Optional) If set to true, TXT records will be created for the custom domain. Defaults to false.
• cname_name - (Optional) The name of the CNAME record to create for the custom domain.
• cname_zone_name - (Optional) The name of the DNS zone to create the CNAME record in.
• cname_record - (Optional) The value of the CNAME record to create for the custom domain. Conflicts with cname_target_resource_id.
• cname_target_resource_id - (Optional) The resource ID of the resource the CNAME record should point to. Conflicts with cname_record.
• txt_name - (Optional) The name of the TXT record to create for the custom domain.
• txt_zone_name - (Optional) The name of the DNS zone to create the TXT record in.
• txt_records - (Optional) A map of TXT records to create for the custom domain. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
  • value - The value of the TXT record.

custom_domains = {
  example = {
    resource_group_name = "example"
    domain_name         = "example.com"
    ttl                 = 300
    validation_type     = "cname-delegation"

    cname_name               = "www"
    cname_zone_name          = "example.com"
    cname_record             = "example.azurewebsites.net"
  }
}

Type:

map(object({
    resource_group_name = optional(string)
    domain_name         = optional(string)
    ttl                 = optional(number, 300)
    validation_type     = optional(string, "cname-delegation")

    create_cname_records     = optional(bool, false)
    cname_name               = optional(string)
    cname_zone_name          = optional(string)
    cname_record             = optional(string)
    cname_target_resource_id = optional(string)

    create_txt_records = optional(bool, false)
    txt_name           = optional(string)
    txt_zone_name      = optional(string)
    txt_records        = optional(map(object({ value = string })))
  }))

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

lock

Description: The lock level to apply. Default is None. Possible values are CanNotDelete and ReadOnly.

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

preview_environments_enabled

Description: Are Preview (Staging) environments enabled? Defaults to true.

Type: bool

Default: true

private_endpoints

Description: A map of private endpoints to create on this 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. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time. See var.role_assignments for more information.
• 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.
• 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 this resource.
• ip_configurations - (Optional) A map of IP configurations to create on the private endpoint. If not specified the platform will create one. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
  • name - The name of the IP configuration.
  • private_ip_address - The private IP address of the IP configuration.
• inherit_lock - (Optional) If set to true, the private endpoint will inherit the lock level of the parent resource. Defaults to true.
• inherit_tags - (Optional) If set to true, the private endpoint will inherit the tags of the parent resource. Defaults to true.

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)
      principal_type                         = optional(string, null)
    })), {})
    lock = optional(object({
      kind = string
      name = optional(string, null)
    }), 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: {}

private_endpoints_inherit_lock

Description: Whether private endpoints should inherit the lock of the parent resource.

Type: bool

Default: true

private_endpoints_manage_dns_zone_group

Description: Whether to manage private DNS zone groups with this module. If set to false, you must manage private DNS zone groups externally, e.g. using Azure Policy.

Type: bool

Default: true

public_network_access_enabled

Description: Should public network access be enabled for the Static Web App. Defaults to true.

Type: bool

Default: true

repository_url

Description: The repository URL of the static site.

Type: string

Default: null

role_assignments

Description: A map of role assignments to create on this 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. Valid values are '2.0'.
• delegated_managed_identity_resource_id - The resource ID of the delegated managed identity resource to assign the role to.

> 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)
    principal_type                         = optional(string, null)
  }))

Default: {}

sku_size

Description: The size of the SKU. The SKU size must be one of: Free, Standard.

Type: string

Default: "Free"

sku_tier

Description: The tier of the SKU. The SKU tier must be one of: Free, Standard.

Type: string

Default: "Free"

tags

Description: A map of tags that will be applied to the Static Web App.

Type: map(string)

Default: null

Outputs

The following outputs are exported:

api_key

Description: The API key of this static web app.

domains

Description: The domains of this static web app.

name

Description: The name of the static web app.

resource

Description: This is the full output for the resource.

resource_id

Description: The ID of the static web app.

resource_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_uri

Description: The default hostname of the static web app.

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

 
 {
  "workingFolder": "packages",
  "packages": [
    // packages defined earlier
    {
      "name": "avm-terraform/web-staticsite",
      "version": "0.6.1"
    }
  ]
}