Azure PostgreSQL Flexible Server module

This is a Terraform module for PostgreSQL Flexible Server in the style of Azure Verified Modules. For official modules please see https://aka.ms/AVM.

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 MUST NOT be published at version 1.0.0 or higher at this time.

All module MUST be published as a pre-release version (e.g., 0.1.0, 0.1.1, 0.2.0, etc.) until the AVM framework becomes GA.

However, it is important to note that this DOES NOT mean that the modules cannot be consumed and utilized. They CAN be leveraged in all types of environments (dev, test, prod etc.). Consumers can treat them just like any other IaC module and raise issues or feature requests against them as they learn from the usage of the module. Consumers should also read the release notes for each version, if considering updating to a more recent version of a module to see if there are any considerations or breaking changes etc.

Requirements

The following requirements are needed by this module:

• terraform (~> 1.9)

• azurerm (~> 4.12)

• modtm (~> 0.3)

• random (~> 3.6)

Resources

The following resources are used by this module:

• azurerm_management_lock.this (resource)
• azurerm_monitor_diagnostic_setting.this (resource)
• azurerm_postgresql_flexible_server.this (resource)
• azurerm_postgresql_flexible_server_active_directory_administrator.this (resource)
• azurerm_postgresql_flexible_server_configuration.this (resource)
• azurerm_postgresql_flexible_server_database.this (resource)
• azurerm_postgresql_flexible_server_firewall_rule.this (resource)
• azurerm_postgresql_flexible_server_virtual_endpoint.this (resource)
• azurerm_private_endpoint.this_managed_dns_zone_groups (resource)
• azurerm_private_endpoint.this_unmanaged_dns_zone_groups (resource)
• azurerm_private_endpoint_application_security_group_association.this (resource)
• azurerm_role_assignment.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):

ad_administrator

Description: A map to allow you to set a user or group as the AD administrator for a PostgreSQL Flexible Server.

• tenant_id - The Azure Tenant ID. Changing this forces a new resource to be created.
• object_id - The object ID of a user, service principal or security group in the Azure Active Directory tenant set as the Flexible Server Admin. Changing this forces a new resource to be created.
• principal_name - The name of Azure Active Directory principal. Changing this forces a new resource to be created.
• principal_type - The type of Azure Active Directory principal. Possible values are Group, ServicePrincipal and User. Changing this forces a new resource to be created.

Type:

map(object({
    tenant_id      = string
    object_id      = string
    principal_name = string
    principal_type = string
  }))

Default: {}

administrator_login

Description: (Optional) The Administrator login for the PostgreSQL Flexible Server. Required when create_mode is Default and authentication.password_auth_enabled is true.

Type: string

Default: null

administrator_password

Description: (Optional) The Password associated with the administrator_login for the PostgreSQL Flexible Server. Required when create_mode is Default and authentication.password_auth_enabled is true.

Type: string

Default: null

authentication

Description: - active_directory_auth_enabled - (Optional) Whether or not Active Directory authentication is allowed to access the PostgreSQL Flexible Server. Defaults to false.

• password_auth_enabled - (Optional) Whether or not password authentication is allowed to access the PostgreSQL Flexible Server. Defaults to true.
• tenant_id - (Optional) The Tenant ID of the Azure Active Directory which is used by the Active Directory authentication. active_directory_auth_enabled must be set to true.

Type:

object({
    active_directory_auth_enabled = optional(bool)
    password_auth_enabled         = optional(bool)
    tenant_id                     = optional(string)
  })

Default: null

auto_grow_enabled

Description: (Optional) Is the storage auto grow for PostgreSQL Flexible Server enabled? Defaults to false.

Type: bool

Default: null

backup_retention_days

Description: (Optional) The backup retention days for the PostgreSQL Flexible Server. Possible values are between 7 and 35 days.

Type: number

Default: null

create_mode

Description: (Optional) The creation mode which can be used to restore or replicate existing servers. Possible values are Default, GeoRestore, PointInTimeRestore, Replica and Update.

Type: string

Default: null

customer_managed_key

Description: A map describing customer-managed keys to associate with the resource. This includes the following properties:

• key_vault_key_id - (Required) The ID of the Key Vault Key..
• geo_backup_key_vault_key_id - (Optional) The ID of the geo backup Key Vault Key
• geo_backup_user_assigned_identity_id - (Optional) The geo backup user managed identity id for a Customer Managed Key. Should be added with identity_ids
• primary_user_assigned_identity - (Optional) Specifies the primary user managed identity id for a Customer Managed Key. Should be added with identity_ids

Type:

object({
    key_vault_key_id                     = string
    geo_backup_key_vault_key_id          = optional(string)
    geo_backup_user_assigned_identity_id = optional(string)
    primary_user_assigned_identity_id    = optional(string)
  })

Default: null

databases

Description: - name - (Required) Specifies the name of the PostgreSQL Database, which needs to be a valid PostgreSQL identifier. Changing this forces a new resource to be created.

• charset - (Optional) Specifies the Charset for the PostgreSQL Database, which needs to be a valid PostgreSQL Charset. Changing this forces a new resource to be created.
• collation - (Optional) Specifies the Collation for the PostgreSQL Database, which needs to be a valid PostgreSQL Collation. Note that Microsoft uses different notation

---

timeouts block supports the following:

• create - (Defaults to 60 minutes) Used when creating the PostgreSQL Database.
• delete - (Defaults to 60 minutes) Used when deleting the PostgreSQL Database.
• read - (Defaults to 5 minutes) Used when retrieving the PostgreSQL Database.

Type:

map(object({
    name      = string
    charset   = optional(string)
    collation = optional(string)
    timeouts = optional(object({
      create = optional(string)
      delete = optional(string)
      read   = optional(string)
    }))
  }))

Default: {}

delegated_subnet_id

Description: (Optional) The ID of the virtual network subnet to create the PostgreSQL Flexible Server. The provided subnet should not have any other resource deployed in it and this subnet will be delegated to the PostgreSQL Flexible Server, if not already delegated. Changing this forces a new PostgreSQL Flexible Server to be created.

Type: string

Default: null

diagnostic_settings

Description: A map of diagnostic settings to create on the Key Vault. 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

firewall_rules

Description: - name - (Optional) The name which should be used for this PostgreSQL Flexible Server Firewall Rule.

• start_ip_address - (Optional) The Start IP Address associated with this PostgreSQL Flexible Server Firewall Rule.
• end_ip_address - (Optional) The End IP Address associated with this PostgreSQL Flexible Server Firewall Rule.

Type:

map(object({
    name             = string
    end_ip_address   = string
    start_ip_address = string
  }))

Default:

{
  "rule1": {
    "end_ip_address": "255.255.255.255",
    "name": "AllowAllFireWallRule",
    "start_ip_address": "0.0.0.0"
  }
}

geo_redundant_backup_enabled

Description: (Optional) Is Geo-Redundant backup enabled on the PostgreSQL Flexible Server. Defaults to false. Changing this forces a new PostgreSQL Flexible Server to be created.

Type: bool

Default: null

high_availability

Description: - mode - (Required) The high availability mode for the PostgreSQL Flexible Server. Possible value are SameZone or ZoneRedundant.

• standby_availability_zone - (Optional) Specifies the Availability Zone in which the standby Flexible Server should be located.

Type:

object({
    mode                      = string
    standby_availability_zone = optional(string)
  })

Default:

{
  "mode": "ZoneRedundant"
}

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

maintenance_window

Description: - day_of_week - (Optional) The day of week for maintenance window, where the week starts on a Sunday, i.e. Sunday = 0, Monday = 1. Defaults to 0.

• start_hour - (Optional) The start hour for maintenance window. Defaults to 0.
• start_minute - (Optional) The start minute for maintenance window. Defaults to 0.

Type:

object({
    day_of_week  = optional(string)
    start_hour   = optional(number)
    start_minute = optional(number)
  })

Default:

{
  "day_of_week": "0",
  "start_hour": 0,
  "start_minute": 0
}

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

point_in_time_restore_time_in_utc

Description: (Optional) The point in time to restore from source_server_id when create_mode is GeoRestore, PointInTimeRestore. Changing this forces a new PostgreSQL Flexible Server to be created.

Type: string

Default: null

private_dns_zone_id

Description: (Optional) The ID of the private DNS zone to create the PostgreSQL Flexible Server.

Type: string

Default: null

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.

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_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: (Optional) Whether the server is publicly accessible. Defaults to false.

Type: bool

Default: false

replication_role

Description: (Optional) The replication role for the PostgreSQL Flexible Server. Possible value is None.

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

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

server_configuration

Description: A map to set a PostgreSQL Configuration value on a Azure PostgreSQL Flexible Server.

• name - Specifies the name of the PostgreSQL Configuration, which needs to be a valid PostgreSQL configuration name. Changing this forces a new resource to be created.
• config - Specifies the value of the PostgreSQL Configuration. See the PostgreSQL documentation for valid values.

Type:

map(object({
    name   = string
    config = string
  }))

Default: {}

server_version

Description: (Optional) The version of PostgreSQL Flexible Server to use. Possible values are 11,12, 13, 14, 15 and 16. Required when create_mode is Default.

Type: string

Default: null

sku_name

Description: (Optional) The SKU Name for the PostgreSQL Flexible Server. The name of the SKU, follows the tier + name pattern (e.g. B_Standard_B1ms, GP_Standard_D2s_v3, MO_Standard_E4s_v3).

Type: string

Default: null

source_server_id

Description: (Optional) The resource ID of the source PostgreSQL Flexible Server to be restored. Required when create_mode is GeoRestore, PointInTimeRestore or Replica. Changing this forces a new PostgreSQL Flexible Server to be created.

Type: string

Default: null

storage_mb

Description: (Optional) The max storage allowed for the PostgreSQL Flexible Server. Possible values are 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4193280, 4194304, 8388608, 16777216 and 33553408.

Type: number

Default: null

storage_tier

Description: (Optional) The storage tier for the PostgreSQL Flexible Server. Possible values are P4, P6, P10, P15, P20, P30, P40, P50, P60, P70 or P80.

Type: string

Default: null

tags

Description: (Optional) Tags of the resource.

Type: map(string)

Default: null

timeouts

Description: - create - (Defaults to 1 hour) Used when creating the PostgreSQL Flexible Server.

• delete - (Defaults to 1 hour) Used when deleting the PostgreSQL Flexible Server.
• read - (Defaults to 5 minutes) Used when retrieving the PostgreSQL Flexible Server.
• update - (Defaults to 1 hour) Used when updating the PostgreSQL Flexible Server.

Type:

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

Default: null

virtual_endpoint

Description: A map to allow you to create a Virtual Endpoint associated with a Postgres Flexible Replica.

• name - (Required) The name of the Virtual Endpoint.
• replica_server_id - (Required) The Resource ID of the Replica Postgres Flexible Server this should be associated with.
• type - (Required) The type of Virtual Endpoint. Currently only ReadWrite is supported.

Type:

map(object({
    name              = string
    replica_server_id = string
    type              = string
  }))

Default: {}

zone

Description: (Optional) Specifies the Availability Zone in which the PostgreSQL Flexible Server should be located.

Type: string

Default: null

Outputs

The following outputs are exported:

database_name

Description: A map of database keys to database name.

database_resource_ids

Description: A map of database keys to resource ids.

fqdn

Description: The fully qualified domain name of the PostgreSQL Flexible Server.

name

Description: The resource ID for the resource.

private_endpoints

Description: A map of the private endpoints created.

resource_id

Description: The resource ID for the resource.

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.