Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/claranet/terraform-azurerm-function-app

Terraform module for Azure Function App
https://github.com/claranet/terraform-azurerm-function-app
azure claranet module terraform
Last synced: about 3 hours ago
JSON representation
Terraform module for Azure Function App
Host: GitHub
URL: https://github.com/claranet/terraform-azurerm-function-app
Owner: claranet
License: apache-2.0
Created: 2021-06-23T08:15:27.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-10-16T23:47:12.000Z (23 days ago)
Last Synced: 2024-10-19T00:05:23.093Z (20 days ago)
Topics: azure, claranet, module, terraform
Language: HCL
Homepage:
Size: 502 KB
Stars: 15
Watchers: 6
Forks: 29
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG-function-app-single.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project

README

        # Azure Function App

[![Changelog](https://img.shields.io/badge/changelog-release-green.svg)](CHANGELOG.md) [![Notice](https://img.shields.io/badge/notice-copyright-blue.svg)](NOTICE) [![Apache V2 License](https://img.shields.io/badge/license-Apache%20V2-orange.svg)](LICENSE) [![OpenTofu Registry](https://img.shields.io/badge/opentofu-registry-yellow.svg)](https://search.opentofu.org/module/claranet/function-app/azurerm/)

This Terraform module creates an [Azure Function App](https://docs.microsoft.com/en-us/azure/azure-functions/)

with its [App Service Plan](https://docs.microsoft.com/en-us/azure/app-service/overview-hosting-plans),

a consumption plan by default.

A [Storage Account](https://docs.microsoft.com/en-us/azure/storage/) and an [Application Insights](https://docs.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview)

are required and are created if not provided.

This module allows to deploy a application from a local or remote ZIP file that will be stored on the associated storage

account.

You can create an Azure Function without plan by using the submodule `modules/functionapp`.

Azure Functions v3 are now supported by this module and is the default one.

## Limitations

Based on a current limitation, you cannot mix Windows and Linux apps in the same resource group.

Limitations documentation: [docs.microsoft.com/en-us/azure/app-service/containers/app-service-linux-intro#limitations](https://docs.microsoft.com/en-us/azure/app-service/containers/app-service-linux-intro#limitations)

## Global versioning rule for Claranet Azure modules

| Module version | Terraform version | OpenTofu version | AzureRM version |

| -------------- | ----------------- | ---------------- | --------------- |

| >= 8.x.x       | **Unverified**    | 1.8.x            | >= 4.0          |

| >= 7.x.x       | 1.3.x             |                  | >= 3.0          |

| >= 6.x.x       | 1.x               |                  | >= 3.0          |

| >= 5.x.x       | 0.15.x            |                  | >= 2.0          |

| >= 4.x.x       | 0.13.x / 0.14.x   |                  | >= 2.0          |

| >= 3.x.x       | 0.12.x            |                  | >= 2.0          |

| >= 2.x.x       | 0.12.x            |                  | < 2.0           |

| <  2.x.x       | 0.11.x            |                  | < 2.0           |

## Contributing

If you want to contribute to this repository, feel free to use our [pre-commit](https://pre-commit.com/) git hook configuration

which will help you automatically update and format some files for you by enforcing our Terraform code module best-practices.

More details are available in the [CONTRIBUTING.md](./CONTRIBUTING.md#pull-request-process) file.

## Usage

This module is optimized to work with the [Claranet terraform-wrapper](https://github.com/claranet/terraform-wrapper) tool

which set some terraform variables in the environment needed by this module.

More details about variables set by the `terraform-wrapper` available in the [documentation](https://github.com/claranet/terraform-wrapper#environment).

⚠️ Since modules version v8.0.0, we do not maintain/check anymore the compatibility with

[Hashicorp Terraform](https://github.com/hashicorp/terraform/). Instead, we recommend to use [OpenTofu](https://github.com/opentofu/opentofu/).

```hcl

module "azure_region" {

  source  = "claranet/regions/azurerm"

  version = "x.x.x"

  azure_region = var.azure_region

}

module "rg" {

  source  = "claranet/rg/azurerm"

  version = "x.x.x"

  location    = module.azure_region.location

  client_name = var.client_name

  environment = var.environment

  stack       = var.stack

}

module "logs" {

  source  = "claranet/run/azurerm//modules/logs"

  version = "x.x.x"

  client_name         = var.client_name

  environment         = var.environment

  stack               = var.stack

  location            = module.azure_region.location

  location_short      = module.azure_region.location_short

  resource_group_name = module.rg.resource_group_name

}

### Windows

module "function_app_windows" {

  source  = "claranet/function-app/azurerm"

  version = "x.x.x"

  client_name         = var.client_name

  environment         = var.environment

  stack               = var.stack

  location            = module.azure_region.location

  location_short      = module.azure_region.location_short

  resource_group_name = module.rg.resource_group_name

  name_prefix = "hello"

  os_type = "Windows"

  function_app_application_settings = {

    "tracker_id"      = "AJKGDFJKHFDS"

    "backend_api_url" = "https://backend.domain.tld/api"

  }

  storage_account_identity_type = "SystemAssigned"

  application_insights_log_analytics_workspace_id = module.logs.log_analytics_workspace_id

  logs_destinations_ids = [

    module.logs.logs_storage_account_id,

    module.logs.log_analytics_workspace_id

  ]

  extra_tags = {

    foo = "bar"

  }

}

### Linux

module "function_app_linux" {

  source  = "claranet/function-app/azurerm"

  version = "x.x.x"

  client_name         = var.client_name

  environment         = var.environment

  stack               = var.stack

  location            = module.azure_region.location

  location_short      = module.azure_region.location_short

  resource_group_name = module.rg.resource_group_name

  name_prefix = "hello"

  os_type              = "Linux"

  function_app_version = 4

  function_app_site_config = {

    application_stack = {

      python_version = "3.9"

    }

  }

  function_app_application_settings = {

    "tracker_id"      = "AJKGDFJKHFDS"

    "backend_api_url" = "https://backend.domain.tld/api"

  }

  storage_account_identity_type = "SystemAssigned"

  application_insights_log_analytics_workspace_id = module.logs.log_analytics_workspace_id

  logs_destinations_ids = [

    module.logs.logs_storage_account_id,

    module.logs.log_analytics_workspace_id

  ]

  extra_tags = {

    foo = "bar"

  }

}

```

## Providers

No providers.

## Modules

| Name | Source | Version |

|------|--------|---------|

| linux\_function | ./modules/linux-function | n/a |

| service\_plan | claranet/app-service-plan/azurerm | ~> 7.1.0 |

| windows\_function | ./modules/windows-function | n/a |

## Resources

No resources.

## Inputs

| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

| app\_service\_environment\_id | ID of the App Service Environment to create this Service Plan in. Requires an Isolated SKU. Use one of I1, I2, I3 for azurerm\_app\_service\_environment, or I1v2, I2v2, I3v2 for azurerm\_app\_service\_environment\_v3. | `string` | `null` | no |

| application\_insights\_custom\_name | Custom name for application insights deployed with function app. | `string` | `""` | no |

| application\_insights\_daily\_data\_cap | Daily data volume cap (in GB) for Application Insights. | `number` | `null` | no |

| application\_insights\_daily\_data\_cap\_notifications\_disabled | Whether disable email notifications when data volume cap is met. | `bool` | `null` | no |

| application\_insights\_enabled | Whether Application Insights should be deployed. | `bool` | `true` | no |

| application\_insights\_extra\_tags | Extra tags to add to Application Insights. | `map(string)` | `{}` | no |

| application\_insights\_force\_customer\_storage\_for\_profiler | Whether to enforce users to create their own Storage Account for profiling in Application Insights. | `bool` | `false` | no |

| application\_insights\_id | ID of the existing Application Insights to use instead of deploying a new one. | `string` | `null` | no |

| application\_insights\_internet\_ingestion\_enabled | Whether ingestion support from Application Insights component over the Public Internet is enabled. | `bool` | `true` | no |

| application\_insights\_internet\_query\_enabled | Whether querying support from Application Insights component over the Public Internet is enabled. | `bool` | `true` | no |

| application\_insights\_ip\_masking\_disabled | Whether IP masking in logs is disabled. | `bool` | `false` | no |

| application\_insights\_local\_authentication\_disabled | Whether Non-Azure AD based authentication is disabled. | `bool` | `false` | no |

| application\_insights\_log\_analytics\_workspace\_id | ID of the Log Analytics Workspace to be used with Application Insights. | `string` | `null` | no |

| application\_insights\_name\_prefix | Application Insights name prefix. | `string` | `""` | no |

| application\_insights\_retention | Retention period (in days) for logs. | `number` | `90` | no |

| application\_insights\_sampling\_percentage | Percentage of data produced by the monitored application sampled for Application Insights telemetry. | `number` | `null` | no |

| application\_insights\_type | Application Insights type if need to be generated. See documentation https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/application_insights#application_type | `string` | `"web"` | no |

| application\_zip\_package\_path | Local or remote path of a zip package to deploy on the Function App. | `string` | `null` | no |

| authorized\_ips | IPs restriction for Function in CIDR format. See documentation https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/function_app#ip_restriction | `list(string)` | `[]` | no |

| authorized\_service\_tags | Service Tags restriction for Function App. See documentation https://www.terraform.io/docs/providers/azurerm/r/function_app.html#ip_restriction | `list(string)` | `[]` | no |

| authorized\_subnet\_ids | Subnets restriction for Function App. See documentation https://www.terraform.io/docs/providers/azurerm/r/function_app.html#ip_restriction | `list(string)` | `[]` | no |

| builtin\_logging\_enabled | Whether built-in logging is enabled. | `bool` | `true` | no |

| client\_certificate\_enabled | Whether the Function App uses client certificates. | `bool` | `null` | no |

| client\_certificate\_mode | The mode of the Function App's client certificates requirement for incoming requests. Possible values are `Required`, `Optional`, and `OptionalInteractiveUser`. | `string` | `null` | no |

| client\_name | Client name/account used in naming. | `string` | n/a | yes |

| custom\_diagnostic\_settings\_name | Custom name of the diagnostics settings, name will be 'default' if not set. | `string` | `"default"` | no |

| default\_tags\_enabled | Option to enable or disable default tags. | `bool` | `true` | no |

| environment | Project environment. | `string` | n/a | yes |

| extra\_tags | Extra tags to add. | `map(string)` | `{}` | no |

| function\_app\_application\_settings | Function App application settings. | `map(string)` | `{}` | no |

| function\_app\_application\_settings\_drift\_ignore | Ignore drift from settings manually set. | `bool` | `true` | no |

| function\_app\_auth\_settings\_v2 | Authentication settings V2. See https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/linux_function_app#auth_settings_v2 | `any` | `{}` | no |

| function\_app\_custom\_name | Custom name for function app. | `string` | `""` | no |

| function\_app\_extra\_tags | Extra tags to add to Function App. | `map(string)` | `{}` | no |

| function\_app\_name\_prefix | Function App name prefix. | `string` | `""` | no |

| function\_app\_site\_config | Site config for Function App. See documentation https://www.terraform.io/docs/providers/azurerm/r/app_service.html#site_config. IP restriction attribute is not managed in this block. | `any` | `{}` | no |

| function\_app\_sticky\_settings | Lists of connection strings and app settings to prevent from swapping between slots. | 
object({
    app_setting_names       = optional(list(string))
    connection_string_names = optional(list(string))
  }) | `null` | no |

| function\_app\_version | Version of the function app runtime to use. | `number` | `3` | no |

| function\_app\_vnet\_integration\_subnet\_id | ID of the subnet to associate with the Function App (Virtual Network integration). | `string` | `null` | no |

| https\_only | Whether HTTPS traffic only is enabled. | `bool` | `true` | no |

| identity\_ids | User Assigned Identities IDs to add to Function App. Mandatory if type is UserAssigned. | `list(string)` | `null` | no |

| identity\_type | Add an Identity (MSI) to the function app. Possible values are SystemAssigned or UserAssigned. | `string` | `"SystemAssigned"` | no |

| ip\_restriction\_headers | IPs restriction headers for Function. See documentation https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/function_app#headers | `map(list(string))` | `null` | no |

| location | Azure location for Function App and related resources. | `string` | n/a | yes |

| location\_short | Short string for Azure location. | `string` | n/a | yes |

| logs\_categories | Log categories to send to destinations. | `list(string)` | `null` | no |

| logs\_destinations\_ids | List of destination resources IDs for logs diagnostic destination.
Can be `Storage Account`, `Log Analytics Workspace` and `Event Hub`. No more than one of each can be set.
If you want to use Azure EventHub as destination, you must provide a formatted string with both the EventHub Namespace authorization send ID and the EventHub name (name of the queue to use in the Namespace) separated by the | character. | `list(string)` | n/a | yes |

| logs\_metrics\_categories | Metrics categories to send to destinations. | `list(string)` | `null` | no |

| maximum\_elastic\_worker\_count | Maximum number of workers to use in an Elastic SKU Plan. Cannot be set unless using an Elastic SKU. | `number` | `null` | no |

| name\_prefix | Optional prefix for the generated name. | `string` | `""` | no |

| name\_suffix | Optional suffix for the generated name. | `string` | `""` | no |

| os\_type | OS type for the Functions to be hosted in the Service Plan. Possible values include `Windows`, `Linux`, and `WindowsContainer`. | `string` | n/a | yes |

| per\_site\_scaling\_enabled | Should per site scaling be enabled on the Service Plan. | `bool` | `false` | no |

| resource\_group\_name | Resource group name. | `string` | n/a | yes |

| scm\_authorized\_ips | SCM IPs restriction for Function App. See documentation https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/function_app#scm_ip_restriction | `list(string)` | `[]` | no |

| scm\_authorized\_service\_tags | SCM Service Tags restriction for Function App. See documentation https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/function_app#scm_ip_restriction | `list(string)` | `[]` | no |

| scm\_authorized\_subnet\_ids | SCM subnets restriction for Function App. See documentation https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/function_app#scm_ip_restriction | `list(string)` | `[]` | no |

| scm\_ip\_restriction\_headers | IPs restriction headers for Function App. See documentation https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/function_app#scm_ip_restriction | `map(list(string))` | `null` | no |

| service\_plan\_custom\_name | Name of the App Service Plan, generated if not set. | `string` | `""` | no |

| service\_plan\_extra\_tags | Extra tags to add to Service Plan. | `map(string)` | `{}` | no |

| sku\_name | The SKU for the Service Plan. Possible values include B1, B2, B3, D1, F1, I1, I2, I3, I1v2, I2v2, I3v2, P1v2, P2v2, P3v2, P1v3, P2v3, P3v3, P1mv3, P2mv3, P3mv3, P4mv3, P5mv3, S1, S2, S3, SHARED, EP1, EP2, EP3, WS1, WS2, WS3, and Y1. | `string` | `"Y1"` | no |

| stack | Project stack name. | `string` | n/a | yes |

| staging\_slot\_custom\_application\_settings | Override staging slot with custom application settings. | `map(string)` | `null` | no |

| staging\_slot\_custom\_name | Custom name of the Function App slot. | `string` | `null` | no |

| staging\_slot\_enabled | Create a staging slot alongside the Function App for blue/green deployment purposes. | `bool` | `false` | no |

| storage\_account\_authorized\_ips | IPs restrictions for Function Storage Account in CIDR format. | `list(string)` | `[]` | no |

| storage\_account\_custom\_name | Custom name of the Storage account to attach to function. | `string` | `null` | no |

| storage\_account\_enable\_advanced\_threat\_protection | Whether advanced threat protection is enabled. See documentation: https://docs.microsoft.com/en-us/azure/storage/common/storage-advanced-threat-protection?tabs=azure-portal | `bool` | `false` | no |

| storage\_account\_enable\_https\_traffic\_only | Whether HTTPS traffic only is enabled for Storage Account. | `bool` | `true` | no |

| storage\_account\_extra\_tags | Extra tags to add to Storage Account. | `map(string)` | `{}` | no |

| storage\_account\_id | ID of the existing Storage Account to use. | `string` | `null` | no |

| storage\_account\_identity\_ids | Specifies a list of User Assigned Managed Identity IDs to be assigned to the Storage Account. | `list(string)` | `null` | no |

| storage\_account\_identity\_type | Type of Managed Service Identity that should be configured on the Storage Account. | `string` | `null` | no |

| storage\_account\_kind | Storage Account Kind. | `string` | `"StorageV2"` | no |

| storage\_account\_min\_tls\_version | Storage Account minimal TLS version. | `string` | `"TLS1_2"` | no |

| storage\_account\_name\_prefix | Storage Account name prefix. | `string` | `""` | no |

| storage\_account\_network\_bypass | Whether traffic is bypassed for Logging/Metrics/AzureServices. Valid options are any combination of `Logging`, `Metrics`, `AzureServices`, or `None`. | `list(string)` | [
  "Logging",
  "Metrics",
  "AzureServices"
] | no |

| storage\_account\_network\_rules\_enabled | Whether to enable Storage Account network default rules for functions. | `bool` | `true` | no |

| storage\_uses\_managed\_identity | Whether the Function App use Managed Identity to access the Storage Account. **Caution** This disable the storage keys on the Storage Account if created within the module. | `bool` | `false` | no |

| use\_caf\_naming | Use the Azure CAF naming provider to generate default resource name. `custom_name` override this if set. Legacy default name is used if this is set to `false`. | `bool` | `true` | no |

| use\_existing\_storage\_account | Whether existing Storage Account should be used instead of creating a new one. | `bool` | `false` | no |

| worker\_count | Number of Workers (instances) to be allocated. | `number` | `null` | no |

| zone\_balancing\_enabled | Should the Service Plan balance across Availability Zones in the region. Defaults to `false` because the default SKU `Y1` for the App Service Plan cannot use this feature. | `bool` | `false` | no |

## Outputs

| Name | Description |

|------|-------------|

| application\_insights\_app\_id | App ID of the associated Application Insights |

| application\_insights\_application\_type | Application Type of the associated Application Insights |

| application\_insights\_id | ID of the associated Application Insights |

| application\_insights\_instrumentation\_key | Instrumentation key of the associated Application Insights |

| application\_insights\_name | Name of the associated Application Insights |

| function\_app\_connection\_string | Connection string of the created Function App |

| function\_app\_default\_hostname | Default hostname of the created Function App |

| function\_app\_id | ID of the created Function App |

| function\_app\_identity | Identity block output of the Function App |

| function\_app\_name | Name of the created Function App |

| function\_app\_outbound\_ip\_addresses | Outbound IP adresses of the created Function App |

| function\_app\_possible\_outbound\_ip\_addresses | All possible outbound IP adresses of the created Function App |

| function\_app\_slot\_default\_hostname | Default hostname of the Function App slot |

| function\_app\_slot\_identity | Identity block output of the Function App slot |

| function\_app\_slot\_name | Name of the Function App slot |

| linux\_function\_app | Linux Function App output object if Linux is chosen. Please refer to `./modules/linux-function/README.md` |

| os\_type | The OS type for the Functions to be hosted in this plan. |

| service\_plan\_id | ID of the created Service Plan |

| service\_plan\_name | Name of the created Service Plan |

| storage\_account\_id | ID of the associated Storage Account, empty if connection string provided |

| storage\_account\_name | Name of the associated Storage Account, empty if connection string provided |

| storage\_account\_network\_rules | Network rules of the associated Storage Account |

| storage\_account\_primary\_access\_key | Primary connection string of the associated Storage Account, empty if connection string provided |

| storage\_account\_primary\_connection\_string | Primary connection string of the associated Storage Account, empty if connection string provided |

| storage\_account\_secondary\_access\_key | Secondary connection string of the associated Storage Account, empty if connection string provided |

| storage\_account\_secondary\_connection\_string | Secondary connection string of the associated Storage Account, empty if connection string provided |

| windows\_function\_app | Windows Function App output object if Windows is chosen. Please refer to `./modules/windows-function/README.md` |

## Related documentation

Microsoft Azure Functions documentation: [github.com/Azure/Azure-Functions#documentation-1](https://github.com/Azure/Azure-Functions#documentation-1)