terraform-azurerm-avm-res-network-firewall

Module to deploy Azure Firewall

"Major version Zero (0.y.z) is for initial development. Anything MAY change at any time. The module SHOULD NOT be considered stable till at least it is major version one (1.0.0) or greater. Changes will always be via new versions being published and no changes will be made to existing published versions. For more details please go to https://semver.org/"

Requirements

The following requirements are needed by this module:

• terraform (>= 1.0.0)

• azurerm (>= 3.71.0)

• random (>= 3.5.0)

Providers

The following providers are used by this module:

• azurerm (>= 3.71.0)

• random (>= 3.5.0)

Resources

The following resources are used by this module:

• azurerm_firewall.this (resource)
• azurerm_monitor_diagnostic_setting.this (resource)
• azurerm_resource_group_template_deployment.telemetry (resource)
• azurerm_role_assignment.this (resource)
• random_id.telem (resource)

Required Inputs

The following input variables are required:

firewall_sku_name

Description: (Required) SKU name of the Firewall. Possible values are AZFW_Hub and AZFW_VNet. Changing this forces a new resource to be created.

Type: string

firewall_sku_tier

Description: (Required) SKU tier of the Firewall. Possible values are Premium, Standard and Basic.

Type: string

location

Description: (Required) Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Type: string

name

Description: (Required) Specifies the name of the Firewall. Changing this forces a new resource to be created.

Type: string

resource_group_name

Description: (Required) The name of the resource group in which to create the resource. Changing this forces a new resource to be created.

Type: string

Optional Inputs

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

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_ip_configuration

Description: - name - (Required) Specifies the name of the IP Configuration.

• public_ip_address_id - (Optional) The ID of the Public IP Address associated with the firewall.
• subnet_id - (Optional) Reference to the subnet associated with the IP Configuration. Changing this forces a new resource to be created.

Type:

list(object({
    name                 = string
    public_ip_address_id = optional(string)
    subnet_id            = optional(string)
  }))

Default: null

firewall_management_ip_configuration

Description: - name - (Required) Specifies the name of the IP Configuration.

• public_ip_address_id - (Required) The ID of the Public IP Address associated with the firewall.
• subnet_id - (Required) Reference to the subnet associated with the IP Configuration. Changing this forces a new resource to be created.

Type:

object({
    name                 = string
    public_ip_address_id = string
    subnet_id            = string
  })

Default: null

firewall_policy_id

Description: (Optional) The ID of the Firewall Policy applied to this Firewall.

Type: string

Default: null

firewall_private_ip_ranges

Description: (Optional) A list of SNAT private CIDR IP ranges, or the special string IANAPrivateRanges, which indicates Azure Firewall does not SNAT when the destination IP address is a private range per IANA RFC 1918.

Type: set(string)

Default: null

firewall_timeouts

Description: - create - (Defaults to 90 minutes) Used when creating the Firewall.

• delete - (Defaults to 90 minutes) Used when deleting the Firewall.
• read - (Defaults to 5 minutes) Used when retrieving the Firewall.
• update - (Defaults to 90 minutes) Used when updating the Firewall.

Type:

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

Default: null

firewall_virtual_hub

Description: - public_ip_count - (Optional) Specifies the number of public IPs to assign to the Firewall. Defaults to 1.

• virtual_hub_id - (Required) Specifies the ID of the Virtual Hub where the Firewall resides in.

Type:

object({
    public_ip_count = optional(number)
    virtual_hub_id  = string
  })

Default: null

firewall_zones

Description: (Required) Specifies a list of Availability Zones in which this Azure Firewall should be located. Changing this forces a new Azure Firewall to be created.

Type: set(string)

Default:

[
  "1",
  "2",
  "3"
]

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

role_assignments

Description: A map of role assignments to create on the Key Vault. 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. Leave as null if you are not using a condition, if you are then 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)
  }))

Default: {}

tags

Description: (Optional) A mapping of tags to assign to the resource.

Type: map(string)

Default: null

Outputs

The following outputs are exported:

resource

Description: "This is the full output for the resource. This is the default output for the module following AVM standards. Review the examples below for the correct output to use in your module."
Examples:

• module.firewall.resource.id
• module.firewall.resource.name
• module.firewall.resource.ip_configuration
• module.firewall.resource.virtual_hub

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.