Azure App Configuration

Azure module to deploy an Azure App Configuration.

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

Usage

This module is optimized to work with the 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.

⚠️ Since modules version v8.0.0, we do not maintain/check anymore the compatibility with Hashicorp Terraform. Instead, we recommend to use OpenTofu.

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 "run" {
  source  = "claranet/run/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

  monitoring_function_enabled = false
}

module "app_configuration" {
  source  = "claranet/app-configuration/azurerm"
  version = "x.x.x"

  location            = module.azure_region.location
  location_short      = module.azure_region.location_short
  resource_group_name = module.rg.resource_group_name

  client_name = var.client_name
  environment = var.environment
  stack       = var.stack

  logs_destinations_ids = [
    module.run.logs_storage_account_id,
    module.run.log_analytics_workspace_id
  ]

  paired_region_replication_enabled = true

  custom_replica = [
    {
      location = "westeurope"
      name     = "euwest"
    }
  ]

  extra_tags = {
    foo = "bar"
  }
}

Providers

Name	Version
azurecaf	~> 1.2, >= 1.2.22
azurerm	~> 3.74

Modules

Name	Source	Version
azure_region	claranet/regions/azurerm	~> 7.3.0
diagnostics	claranet/diagnostic-settings/azurerm	~> 7.0.0

Resources

Name	Type
azurerm_app_configuration.app_configuration	resource
azurecaf_name.app_configuration	data source

Inputs

Name	Description	Type	Default	Required
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
custom_name	Custom App Configuration, generated if not set	string	""	no
custom_replica	Create one or multiple custom AppConfig replica.	list(object({ location = string name = string }))	[]	no
default_tags_enabled	Option to enable or disable default tags.	bool	true	no
environment	Project environment.	string	n/a	yes
extra_tags	Additional tags to add on resources.	map(string)	{}	no
identity_type	App configuration identity type. Possible values are null and SystemAssigned.	string	"SystemAssigned"	no
local_auth_enabled	Whether local authentication methods is enabled. Defaults to false.	bool	false	no
location	Azure region to use.	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 specify an Azure EventHub to send logs and metrics to, you need to provide a formated 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
logs_metrics_categories	Metrics categories to send to destinations.	list(string)	null	no
name_prefix	Optional prefix for the generated name	string	""	no
name_suffix	Optional suffix for the generated name	string	""	no
paired_region_replication_enabled	Whether replication is enabled on paired region.	bool	false	no
paired_region_replication_replica_custom_name	Custom replica name on paired region.	string	null	no
public_network_access_enabled	Whether the App Configuration is available from public network.	bool	false	no
purge_protection_enabled	Whether Purge Protection is enabled. This field only works for standard SKU. Defaults to false.	bool	false	no
resource_group_name	Name of the resource group.	string	n/a	yes
sku	The SKU name of the App Configuration. Possible values are free and standard. Defaults to standard.	string	"standard"	no
soft_delete_retention_days	The number of days that items should be retained for once soft-deleted. This field only works for standard sku. This value can be between 1 and 7 days. Defaults to 7. Changing this forces a new resource to be created.	number	7	no
stack	Project stack name.	string	n/a	yes

Outputs

Name	Description
app_configuration	App Configuration output object
endpoint	App Configuration Endpoint URL
id	App Configuration ID
identity_principal_id	App Configuration system identity principal ID
name	App Configuration name
primary_read_key	App Configuration primary read key
primary_write_key	App Configuration primary write key
secondary_read_key	App Configuration secondary read key
secondary_write_key	App Configuration secondary write key

Related documentation

Microsoft Azure documentation: learn.microsoft.com/en-us/azure/azure-app-configuration/overview