networking/public_ip_prefixes¶
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_prefix.pip_prefix["azurerm_public_ip_prefix.pip_prefix"]
Module Reference¶
Category: networking
Path: modules/networking/public_ip_prefixes
Azure Resources: azurerm_public_ip_prefix
Inputs¶
| Name | Description | Type | Required | Default | Validation |
|---|---|---|---|---|---|
name |
(Required) Specifies the name of the Public IP Prefix resource . Changing this forces a new resource to be created. | string |
yes | - |
- |
resource_group_name |
(Required) The name of the resource group where to create the resource. | string |
yes | - |
- |
location |
(Required) Specifies the supported Azure location where to create the resource. Changing this forces a new resource t... | string |
yes | - |
- |
sku |
(Optional) The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. | string |
no | Basic |
Provide an allowed value as defined in https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/public_ip#sku. |
prefix_length |
(Optional) Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 3... | string |
no | 28 |
Provide an allowed value as defined in https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/public_ip_prefix#prefix_length. |
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. |
tags |
(Optional) Tags for the resource to be deployed. | map(any) |
no | - |
- |
create_pips |
(Optional) When true all IP's will be created and provided as output. | bool |
no | false |
- |
pip_settings |
(Optional) PIP settings when create_ips = true. | any |
no | {} |
- |
zones |
(Optional) The availability zone to allocate the Public IP in. Possible values are Zone-Redundant, 1, 2, 3, and No-Zo... | 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 | {} |
- |
base_tags |
Base tags for the resource to be inherited from the resource group. | map(any) |
yes | - |
- |
Outputs¶
| Name | Description | Sensitive | Value |
|---|---|---|---|
id |
The Public IP Prefix ID. | - | azurerm_public_ip_prefix.pip_prefix.id |
ip_prefix |
The IP address prefix that was allocated. | - | azurerm_public_ip_prefix.pip_prefix.ip_prefix |
Sources¶
modules/networking/public_ip_prefixes/locals.tfmodules/networking/public_ip_prefixes/locals_public_ip_prefixes.tfmodules/networking/public_ip_prefixes/main.tfmodules/networking/public_ip_prefixes/module.tfmodules/networking/public_ip_prefixes/outputs.tfmodules/networking/public_ip_prefixes/variables.tf