terraform-azurerm-avm-res-network-publicipaddress

This is a module developed as part of Terraform Azure Verified Modules project and can be used to deploy Public IP Address.

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_management_lock.this (resource)
• azurerm_monitor_diagnostic_setting.this (resource)
• azurerm_public_ip.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:

location

Description: The Azure location where the resources will be deployed.

Type: string

name

Description: Name of public IP address 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):

allocation_method

Description: The allocation method to use.

Type: string

Default: "Static"

ddos_protection_mode

Description: The DDoS protection mode to use.

Type: string

Default: "VirtualNetworkInherited"

ddos_protection_plan_id

Description: The ID of the DDoS protection plan to associate with the public IP address. This is required if ddos_protection_mode is set to Standard.

Type: string

Default: null

diagnostic_settings

Description: A map of diagnostic settings to create on the ddos protection plan. 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: {}

domain_name_label

Description: The domain name label for the public IP address.

Type: string

Default: null

edge_zone

Description: The edge zone to use for the public IP address. This is required if sku_tier is set to Global.

Type: string

Default: null

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

idle_timeout_in_minutes

Description: The idle timeout in minutes.

Type: number

Default: 4

ip_tags

Description: The IP tags for the public IP address

Type: map(string)

Default: {}

ip_version

Description: The IP version to use.

Type: string

Default: "IPv4"

lock

Description: The lock level to apply to the deployed resource. Default is None. Possible values are None, CanNotDelete, and ReadOnly.

Type:

object({
    name = optional(string, null)
    kind = optional(string, "None")
  })

Default: {}

public_ip_prefix_id

Description: The ID of the public IP prefix to associate with the public IP address.

Type: string

Default: null

reverse_fqdn

Description: The reverse FQDN for the public IP address. This must be a valid FQDN. If you specify a reverse FQDN, you cannot specify a DNS name label. Not all regions support this.

Type: string

Default: null

role_assignments

Description: n/a

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

sku

Description: The SKU of the public IP address.

Type: string

Default: "Standard"

sku_tier

Description: The tier of the SKU of the public IP address.

Type: string

Default: "Regional"

tags

Description: Map of tags to assign to the deployed resource.

Type: map(any)

Default: null

zones

Description: A set of availability zones to use.

Type: set(number)

Default:

[
  1,
  2,
  3
]

Outputs

The following outputs are exported:

public_ip_address

Description: The assigned IP address of the public IP

public_ip_id

Description: The ID of the created public IP address

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.