This is a Terraform module for the MySQL Flexible Server written for contribution to 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.
The following requirements are needed by this module:
The following resources are used by this module:
- azurerm_management_lock.this (resource)
- azurerm_mysql_flexible_database.this (resource)
- azurerm_mysql_flexible_server.this (resource)
- azurerm_mysql_flexible_server_active_directory_administrator.this (resource)
- azurerm_mysql_flexible_server_configuration.example (resource)
- azurerm_mysql_flexible_server_firewall_rule.this (resource)
- azurerm_private_endpoint.this (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)
The following input variables are required:
Description: Azure region where the resource should be deployed. If null, the location will be inferred from the resource group location.
Type: string
Description: The name of the resource.
Type: string
Description: The resource group where the resources will be deployed.
Type: string
The following input variables are optional (have default values):
Description: - identity_id - (Required) The resource ID of the identity used for AAD Authentication.
login- (Required) The login name of the principal to set as the server administrator.object_id- (Required) The ID of the principal to set as the server administrator. For a managed identity, this should be the Client ID of the identity.tenant_id- (Required) The Azure Tenant ID.
timeouts block supports the following:
create- (Defaults to 30 minutes) Used when creating the MySQL Flexible Server Active Directory Administrator.read- (Defaults to 5 minutes) Used when retrieving the MySQL Flexible Server Active Directory Administrator.update- (Defaults to 30 minutes) Used when updating the MySQL Flexible Server Active Directory Administrator.delete- (Defaults to 30 minutes) Used when deleting the MySQL Flexible Server Active Directory Administrator.
Type:
object({
login = optional(string)
object_id = optional(string)
tenant_id = optional(string)
timeouts = optional(object({
create = optional(string)
read = optional(string)
update = optional(string)
delete = optional(string)
}))
})Default: {}
Description: (Optional) The Administrator login for the MySQL Flexible Server. Required when create_mode is Default. Changing this forces a new MySQL Flexible Server to be created.
Type: string
Default: null
Description: (Optional) The Password associated with the administrator_login for the MySQL Flexible Server. Required when create_mode is Default.
Type: string
Default: null
Description: (Optional) The backup retention days for the MySQL Flexible Server. Possible values are between 1 and 35 days. Defaults to 7.
Type: number
Default: null
Description: (Optional)The creation mode which can be used to restore or replicate existing servers. Possible values are Default, PointInTimeRestore, GeoRestore, and Replica. Changing this forces a new MySQL Flexible Server to be created.
Type: string
Default: null
Description: - geo_backup_key_vault_key_id - (Optional) The ID of the geo backup Key Vault Key. It can't cross region and need Customer Managed Key in same region as geo backup.
geo_backup_user_assigned_identity_id- (Optional) The geo backup user managed identity id for a Customer Managed Key. Should be added withidentity_ids. It can't cross region and need identity in same region as geo backup.key_vault_key_id- (Optional) The ID of the Key Vault Key.primary_user_assigned_identity_id- (Optional) Specifies the primary user managed identity id for a Customer Managed Key. Should be added withidentity_ids.
Type:
object({
key_vault_resource_id = string
key_name = string
key_version = optional(string, null)
user_assigned_identity = optional(object({
resource_id = string
}), null)
})Default: null
Description: - charset - (Required) Specifies the Charset for the MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created.
collation- (Required) Specifies the Collation for the MySQL Database, which needs to be a valid MySQL Collation. Changing this forces a new resource to be created.name- (Required) Specifies the name of the MySQL Database, which needs to be a valid MySQL identifier. Changing this forces a new resource to be created.
timeouts block supports the following:
create- (Defaults to 60 minutes) Used when creating the MySQL Database.delete- (Defaults to 60 minutes) Used when deleting the MySQL Database.read- (Defaults to 5 minutes) Used when retrieving the MySQL Database.
Type:
map(object({
charset = string
collation = string
name = string
timeouts = optional(object({
create = optional(string)
delete = optional(string)
read = optional(string)
}))
}))Default: {}
Description: (Optional) The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
Type: string
Default: null
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
Description: - end_ip_address - (Required) Specifies the End IP Address associated with this Firewall Rule.
start_ip_address- (Required) Specifies the Start IP Address associated with this Firewall Rule.
timeouts block supports the following:
create- (Defaults to 30 minutes) Used when creating the MySQL Firewall Rule.delete- (Defaults to 30 minutes) Used when deleting the MySQL Firewall Rule.read- (Defaults to 5 minutes) Used when retrieving the MySQL Firewall Rule.update- (Defaults to 30 minutes) Used when updating the MySQL Firewall Rule.
Type:
map(object({
end_ip_address = string
start_ip_address = string
timeouts = optional(object({
create = optional(string)
delete = optional(string)
read = optional(string)
update = optional(string)
}))
}))Default: {}
Description: (Optional) Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.
Type: bool
Default: null
Description: - mode - (Required) The high availability mode for the MySQL Flexible Server. Possibles values are SameZone and ZoneRedundant.
standby_availability_zone- (Optional) Specifies the Availability Zone in which the standby Flexible Server should be located. Possible values are1,2and3.
Type:
object({
mode = string
standby_availability_zone = optional(string)
})Default:
{
"mode": "ZoneRedundant"
}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 thekindvalue. Changing this forces the creation of a new resource.
Type:
object({
kind = string
name = optional(string, null)
})Default: null
Description: - day_of_week - (Optional) The day of week for maintenance window. Defaults to 0.
start_hour- (Optional) The start hour for maintenance window. Defaults to0.start_minute- (Optional) The start minute for maintenance window. Defaults to0.
Type:
object({
day_of_week = optional(string)
start_hour = optional(number)
start_minute = optional(number)
})Default:
{
"day_of_week": "0"
}Description: Managed identities to be created for the resource.
Type:
object({
system_assigned = optional(bool, false)
user_assigned_resource_ids = optional(set(string), [])
})Default: {}
Description: (Optional) The version of the MySQL Flexible Server to use. Possible values are 5.7, and 8.0.21. Changing this forces a new MySQL Flexible Server to be created.
Type: string
Default: null
Description: (Optional) The point in time to restore from creation_source_server_id when create_mode is PointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.
Type: string
Default: null
Description: (Optional) The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
Type: string
Default: null
Description: A map of private endpoints 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 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. Seevar.role_assignmentsfor more information.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- (Optional) The description of the role assignment.skip_service_principal_aad_check- (Optional) If set to true, skips the Azure Active Directory check for the service principal in the tenant. Defaults to false.condition- (Optional) The condition which will be used to scope the role assignment.condition_version- (Optional) The version of the condition syntax. Leave asnullif you are not using a condition, if you are then valid values are '2.0'.delegated_managed_identity_resource_id- (Optional) The delegated Azure Resource Id which contains a Managed Identity. Changing this forces a new resource to be created. This field is only used in cross-tenant scenario.principal_type- (Optional) The type of theprincipal_id. Possible values areUser,GroupandServicePrincipal. It is necessary to explicitly set this attribute when creating role assignments if the principal creating the assignment is constrained by ABAC rules that filters on the PrincipalType attribute.
lock- (Optional) The lock level to apply to the private endpoint. Default isNone. Possible values areNone,CanNotDelete, andReadOnly.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 thekindvalue. Changing this forces the creation of a new resource.
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.subresource_name- The name of the sub resource for the private endpoint.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 the Key Vault.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
subresource_name = string # NOTE: `subresource_name` can be excluded if the resource does not support multiple sub resource types (e.g. storage account supports blob, queue, etc)
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: {}
Description: (Optional) The replication role. Possible value is None.
Type: string
Default: null
Description: A map of role assignments to create on the MySQL Flexible Server. 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- (Optional) The description of the role assignment.skip_service_principal_aad_check- (Optional) If set to true, skips the Azure Active Directory check for the service principal in the tenant. Defaults to false.condition- (Optional) The condition which will be used to scope the role assignment.condition_version- (Optional) The version of the condition syntax. Leave asnullif you are not using a condition, if you are then valid values are '2.0'.delegated_managed_identity_resource_id- (Optional) The delegated Azure Resource Id which contains a Managed Identity. Changing this forces a new resource to be created. This field is only used in cross-tenant scenario.principal_type- (Optional) The type of theprincipal_id. Possible values areUser,GroupandServicePrincipal. It is necessary to explicitly set this attribute when creating role assignments if the principal creating the assignment is constrained by ABAC rules that filters on the PrincipalType attribute.
Note: only set
skip_service_principal_aad_checkto 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: {}
Description: (Optional) A configuration block supports the following:
object({
name = (Required) Specifies the name of the MySQL Flexible Server Configuration, which needs to be a valid MySQL configuration name. Changing this forces a new resource to be created.
value = (Required) Specifies the value of the MySQL Flexible Server Configuration. See the MySQL documentation for valid values.
})
Type:
map(object({
name = string
value = string
}))Default: {}
Description: (Optional) The SKU Name for the MySQL Flexible Server.
Type: string
Default: null
Description: (Optional)The resource ID of the source MySQL Flexible Server to be restored. Required when create_mode is PointInTimeRestore, GeoRestore, and Replica. Changing this forces a new MySQL Flexible Server to be created.
Type: string
Default: null
Description: - auto_grow_enabled - (Optional) Should Storage Auto Grow be enabled? Defaults to true.
io_scaling_enabled- (Optional) Should IOPS be scaled automatically? Iftrue,iopscan not be set. Defaults tofalse.iops- (Optional) The storage IOPS for the MySQL Flexible Server. Possible values are between360and20000.size_gb- (Optional) The max storage allowed for the MySQL Flexible Server. Possible values are between20and16384.
Type:
object({
auto_grow_enabled = optional(bool)
io_scaling_enabled = optional(bool)
iops = optional(number)
size_gb = optional(number)
})Default: null
Description: (Optional) Tags which should be assigned to the MySQL Flexible Server.
Type: map(string)
Default: null
Description: - create - (Defaults to 1 hour) Used when creating the MySQL Flexible Server.
delete- (Defaults to 1 hour) Used when deleting the MySQL Flexible Server.read- (Defaults to 5 minutes) Used when retrieving the MySQL Flexible Server.update- (Defaults to 1 hour) Used when updating the MySQL Flexible Server.
Type:
object({
create = optional(string)
delete = optional(string)
read = optional(string)
update = optional(string)
})Default: null
Description: (Optional) Specifies the Availability Zone in which this MySQL Flexible Server should be located. Possible values are 1, 2 and 3.
Type: string
Default: null
The following outputs are exported:
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.
Description: The name of the rresource
Description: This is the full output for the resource.
Description: The ID of the resoure
No modules.
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.