Skip to content

networking/private_endpoint

Overview

This page documents the Terraform module implementation, key configuration surfaces, and how it integrates with CAF.

Dependency diagram (Mermaid)

graph TD azurecaf_name.pep["azurecaf_name.pep"] azurerm_private_endpoint.pep["azurerm_private_endpoint.pep"] time_sleep.delay["time_sleep.delay"] azurerm_private_endpoint.pep --> azurecaf_name.pep time_sleep.delay --> azurerm_private_endpoint.pep

Module Reference

Category: networking
Path: modules/networking/private_endpoint
Azure Resources: azurecaf_name, azurerm_private_endpoint, time_sleep

Inputs

Name Description Type Required Default Validation
resource_id any yes - -
name (Required) Specifies the name. Changing this forces a new resource to be created. string yes - -
resource_group_name The name of the resource group. Changing this forces a new resource to be created. any no - -
resource_groups The combined_objects of the resource groups. Changing this forces a new resource to be created. any no {} -
location Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. any no - -
subnet_id any yes - -
settings The settings for the Azure resource. any yes - -
global_settings Global settings object (see module README.md) any yes - -
base_tags Base tags for the resource to be inherited from the resource group. bool yes - -
subresource_names any no [] -
client_config any no {} -
private_dns any no {} -
tags any no {} -

Outputs

Name Description Sensitive Value
id The ID of the Private Endpoint - azurerm_private_endpoint.pep.id
name The name of the Private Endpoint - azurerm_private_endpoint.pep.name
private_dns_zone_group The private DNS zone group configuration - azurerm_private_endpoint.pep.private_dns_zone_group
private_dns_zone_configs The private DNS zone configuration details - azurerm_private_endpoint.pep.private_dns_zone_configs
custom_dns_configs The custom DNS configurations - azurerm_private_endpoint.pep.custom_dns_configs
network_interface The network interface details of the private endpoint - azurerm_private_endpoint.pep.network_interface
private_service_connection The private service connection details - azurerm_private_endpoint.pep.private_service_connection
private_ip_address The private IP address of the private endpoint - try(azurerm_private_endpoint.pep.private_service_connection[0].private_ip_address, null)
ip_configuration The IP configuration details of the private endpoint - azurerm_private_endpoint.pep.ip_configuration

Sources

  • modules/networking/private_endpoint/locals.tf
  • modules/networking/private_endpoint/main.tf
  • modules/networking/private_endpoint/outputs.tf
  • modules/networking/private_endpoint/private_endpoint.tf
  • modules/networking/private_endpoint/variables.tf