networking/public_ip_addresses¶
Overview¶
This page documents the Terraform module implementation, key configuration surfaces, and how it integrates with CAF.
Dependency diagram (Mermaid)¶
graph TD
azurerm_public_ip.pip["azurerm_public_ip.pip"]
module.diagnostics["module.diagnostics"]
module.diagnostics --> azurerm_public_ip.pip
Module Reference¶
Category: networking
Path: modules/networking/public_ip_addresses
Azure Resources: azurerm_public_ip
Inputs¶
| Name | Description | Type | Required | Default | Validation |
|---|---|---|---|---|---|
"global_settings" |
"Global settings object (see module README.md)" | any |
yes | - |
- |
"name" |
"(Required) Specifies the name of the Public IP resource . Changing this forces a new resource to be created." | string |
yes | - |
- |
"sku" |
"(Optional) The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Standard." | string |
no | "Standard" |
"Provide an allowed value as defined in https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/public_ip#sku." |
"sku_tier" |
"(Optional) The SKU Tier that should be used for the Public IP. Possible values are Regional and Global. Defaults to ... | string |
no | "Regional" |
- |
"allocation_method" |
"(Optional) Defines the allocation method for this IP address. Possible values are Static or Dynamic. Defaults to Sta... | string |
no | "Static" |
"Provide an allowed value as defined in https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/public_ip#allocation_method." |
"ip_version" |
"(Optional) The IP Version to use, IPv6 or IPv4." | string |
no | "IPv4" |
"Provide an allowed value as defined in https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/public_ip#ip_version." |
"idle_timeout_in_minutes" |
"(Optional) Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes." | number |
no | - |
"Provide an allowed value as defined in https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/public_ip#idle_timeout_in_minutes." |
"domain_name_label" |
"(Optional) Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DN... | string |
no | - |
- |
"generate_domain_name_label" |
"Generate automatically the domain name label, if set to true, automatically generate a domain name label with the name" | bool |
no | false |
- |
"reverse_fqdn" |
"(Optional) A fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, t... | string |
no | - |
- |
"tags" |
"(Optional) Tags for the resource to be deployed." | map(any) |
no | - |
- |
"zones" |
"The availability zone to allocate the Public IP in. Possible values are 1, 2, 3. Defaults to null." | list(string) |
yes | - |
"Update behavior to mandate specifying the zones in order to avoid accidental resources destructions. https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/public_ip#zone." |
"diagnostics" |
"(Optional) Diagnostics objects where to deploy the diagnostics profiles." | any |
no | {} |
- |
"diagnostic_profiles" |
"(Optional) Diagnostics profile settings to be deployed for the resource." | any |
no | {} |
- |
"ip_tags" |
"(Optional) A mapping of IP tags to assign to the public IP." | map(any) |
no | {} |
- |
"public_ip_prefix_id" |
"(Optional) If specified then public IP address allocated will be provided from the public IP prefix resource." | string |
no | "" |
- |
"location" |
"location of the resource if different from the resource group." | string |
no | - |
- |
"resource_group_name" |
"Resource group object to deploy the Azure resource" | string |
no | - |
- |
"resource_group" |
"Resource group object to deploy the Azure resource" | any |
yes | - |
- |
"base_tags" |
"Base tags for the resource to be inherited from the resource group." | bool |
yes | - |
- |
Outputs¶
| Name | Description | Sensitive | Value |
|---|---|---|---|
"id" |
"The Public IP ID." | - | azurerm_public_ip.pip.id |
"ip_address" |
"The IP address value that was allocated." | - | azurerm_public_ip.pip.ip_address |
"fqdn" |
"Fully qualified domain name of the A DNS record associated with the public IP. domain_name_label must be specified t... | - | azurerm_public_ip.pip.fqdn |
Sources¶
modules/networking/public_ip_addresses/diagnostics.tfmodules/networking/public_ip_addresses/locals.tfmodules/networking/public_ip_addresses/main.tfmodules/networking/public_ip_addresses/module.tfmodules/networking/public_ip_addresses/outputs.tfmodules/networking/public_ip_addresses/variables.tf