Skip to content

networking/virtual_network_gateway_connections

Overview

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

Dependency diagram (Mermaid)

graph TD azurecaf_name.vngw_connection["azurecaf_name.vngw_connection"] azurerm_virtual_network_gateway_connection.vngw_connection["azurerm_virtual_network_gateway_connection.vngw_connection"] azurerm_virtual_network_gateway_connection.vngw_connection --> azurecaf_name.vngw_connection

Module Reference

Category: networking
Path: modules/networking/virtual_network_gateway_connections
Azure Resources: azurecaf_name, azurerm_virtual_network_gateway_connection

Inputs

Name Description Type Required Default Validation
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 - -
base_tags Base tags for the resource to be inherited from the resource group. map(any) yes - -
settings Settings for azurerm_virtual_network_gateway_connection. Supported fields: - name: (Required) The name of the connect... any yes - -
global_settings Global settings object (see module README.md) any yes - -
diagnostics any yes - -
client_config Client configuration object (see module README.md). any yes - -
express_route_circuit_id any yes - -
authorization_key any yes - -
virtual_network_gateway_id any yes - -
local_network_gateway_id any yes - -
remote_objects Remote objects to be used in the module (see module README.md). any yes - -

Outputs

Name Description Sensitive Value
id - azurerm_virtual_network_gateway_connection.vngw_connection.id

Sources

  • modules/networking/virtual_network_gateway_connections/locals.tf
  • modules/networking/virtual_network_gateway_connections/main.tf
  • modules/networking/virtual_network_gateway_connections/module.tf
  • modules/networking/virtual_network_gateway_connections/outputs.tf
  • modules/networking/virtual_network_gateway_connections/variables.tf