Top / Microsoft Azure / Azure Network / Gateway Connection

Azure Network Gateway Connection

This page shows how to write Terraform and Azure Resource Manager for Network Gateway Connection and write them securely.

terraform-logo

Review your .tf file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

azurerm_virtual_network_gateway_connection (Terraform)

The Gateway Connection in Network can be configured in Terraform with the resource name azurerm_virtual_network_gateway_connection. The following sections describe 10 examples of how to use the resource and its parameters.

Example Usage from GitHub

azure.tf#L98
resource "azurerm_virtual_network_gateway_connection" "virtual_network_gateway_connection_1_tunnel1"{

    name= "virtual_network_gateway_connection_1_tunnel1"
    location =azurerm_resource_group.resource_group.location
    resouce_group_name=azurerm_resource_group.resource_group.name
azurerm_virtual_network_gateway_connection.tf#L1
resource "azurerm_virtual_network_gateway_connection" "virtual_network_gateway_cxn_1_tunl_1" {
  local_network_gateway_id   = azurerm_local_network_gateway.local_network_gtwy_1_tunl_1.id
  location                   = azurerm_resource_group.resource_group.location
  name                       = "virtual_network_gateway_cxn_1_tunl_1"
  resource_group_name        = azurerm_resource_group.resource_group.name
  shared_key                 = aws_vpn_connection.vpn_connection_1.tunnel1_preshared_key # AWS VPN Connection secret shared key
gateway_connection.tf#L12
resource "azurerm_virtual_network_gateway_connection" "virtual_network_gateway_connection_1_tunnel1" {
  name                                                  = var.tunnel1_gateway_name
  location                                              = var.resource_group.location
  resource_group_name                                   = var.resource_group.name
  type                                                  = "IPsec"
  virtual_network_gateway_id                            = azurerm_virtual_network_gateway.azure_virtual_network_gateway.id
azure2.tf#L16
resource "azurerm_virtual_network_gateway_connection" "virtual_network_gateway_connection_1_tunnel1" {
  name                = "virtual_network_gateway_connection_1_tunnel1"
  location            = azurerm_resource_group.resource_group.location
  resource_group_name = azurerm_resource_group.resource_group.name

  type                       = "IPsec"
northeurope.tf#L118
resource "azurerm_virtual_network_gateway_connection" "connection_neu-to-weu" {
  name                = "neu-to-weu"
  location            = azurerm_resource_group.resource_group_neu.location
  resource_group_name = azurerm_resource_group.resource_group_neu.name

  type                       = "IPsec"
eastus2.tf#L118
resource "azurerm_virtual_network_gateway_connection" "connection_eus-to-weu" {
  name                = "eus-to-weu"
  location            = azurerm_resource_group.resource_group_eus.location
  resource_group_name = azurerm_resource_group.resource_group_eus.name

  type                       = "IPsec"
westeurope.tf#L118
resource "azurerm_virtual_network_gateway_connection" "connection_weu-to-neu" {
  name                = "weu-to-neu"
  location            = azurerm_resource_group.resource_group_weu.location
  resource_group_name = azurerm_resource_group.resource_group_weu.name

  type                       = "IPsec"
azure.tf#L47
resource "azurerm_virtual_network_gateway_connection" "aws1" {
  name                = "aws-connection-1"
  resource_group_name = var.azure_resource_group_name
  location            = var.azure_location

  type                       = "IPsec"
azure.tf#L16
resource "azurerm_virtual_network_gateway_connection" "virtual-network-gateway-connection-1-tunnel1" {
  name                       = "virtual-network-gateway-connection-1-tunnel1"
  location                   = azurerm_resource_group.az-resource-group.location
  resource_group_name        = azurerm_resource_group.az-resource-group.name
  type                       = "IPSec"
  virtual_network_gateway_id = azurerm_virtual_network_gateway.az-virtual-network-gateway.id
s2s_vpn.tf#L5
resource "azurerm_virtual_network_gateway_connection" "hub_to_onprem" {
  name                = "hub-onprem-connection"
  location            = azurerm_resource_group.hub.location
  resource_group_name = azurerm_resource_group.hub.name
  type           = "Vnet2Vnet"
  routing_weight = 1

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

>> from Terraform Registry

Explanation in Terraform Registry

Manages a connection in an existing Virtual Network Gateway.

>> from Terraform Registry

Tips: Best Practices for The Other Azure Network Resources

In addition to the azurerm_network_security_group, Azure Network has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.

risk-label

azurerm_network_security_group

Ensure to disable RDP port from the Internet

It is better to disable the RDP port from the Internet. RDP access should not be accepted from the Internet (*, 0.0.0.0, /0, internet, any), and consider using the Azure Bastion Service.

risk-label

azurerm_network_security_rule

Ensure to set a more restrictive CIDR range for ingress from the internet

It is better to set a more restrictive CIDR range not to use very broad subnets. If possible, segments should be divided into smaller subnets.

risk-label

azurerm_network_watcher_flow_log

Ensure to enable Retention policy for flow logs and set it to enough duration

It is better to enable a retention policy for flow logs. Flow logs show us all network activity in the cloud environment and support us when we face critical incidents.

Review your Azure Network settings

In addition to the above, there are other security points you should be aware of making sure that your .tf files are protected in Shisho Cloud.

Microsoft.Network/connections (Azure Resource Manager)

The connections in Microsoft.Network can be configured in Azure Resource Manager with the resource name Microsoft.Network/connections. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

branchesConnections.json#L201
            "type": "Microsoft.Network/connections",
            "name": "branch-ne-to-we-hub0",
            "apiVersion": "2018-12-01",
            "location": "northeurope",
            "dependsOn": [
                "[concat('Microsoft.Network/localNetworkGateways/', 'branch-ne-we-hub-config0')]"
vpn2.json#L479
            "type": "Microsoft.Network/connections",
            "name": "[variables('connectionName11-21')]",
            "apiVersion": "2020-06-01",
            "comments": "VPN connection between [Gateway1] and [Gateway2-pubIP1]",
            "location": "[variables('location1')]",
            "dependsOn": [
establishingVpnConnection.json#L34
      "type": "Microsoft.Network/connections",
      "name": "[parameters('connectionName1')]",
      "location": "[parameters('location1')]",
      "properties": {
        "virtualNetworkGateway1": {
          "id": "[parameters('gateway1Id')]"
vpn2.json#L351
            "type": "Microsoft.Network/connections",
            "name": "[variables('connectionName11-21')]",
            "apiVersion": "2020-06-01",
            "comments": "VPN connection between [Gateway1] and [Gateway2-pubIP1]",
            "location": "[variables('location1')]",
            "dependsOn": [
VirtualNetworkGatewayConnectionsList.json#L15
                    "type": "Microsoft.Network/connections",
                    "location": "centralus",
                    "properties": {
                      "provisioningState": "Succeeded",
                      "resourceGuid": "00000000-0000-0000-0000-000000000000",
                      "virtualNetworkGateway1": {
arm_vnet_core.json#L423
            "type": "Microsoft.Network/connections",
            "name": "Connection-WEU-NEU",
            "apiVersion": "2017-10-01",
            "location": "westeurope",
            "scale": null,
            "properties": {
connections.json#L34
            "type": "Microsoft.Network/connections",
            "apiVersion": "[variables('apiVersion')]",
            "location": "[variables('location_1')]",
            "properties": {
                "publicIPAllocationMethod": "Dynamic",
                "virtualNetworkGateway1": {
VirtualNetworkGatewayConnectionsList.json#L15
                    "type": "Microsoft.Network/connections",
                    "location": "centralus",
                    "properties": {
                      "provisioningState": "Succeeded",
                      "resourceGuid": "00000000-0000-0000-0000-000000000000",
                      "virtualNetworkGateway1": {
VirtualNetworkGatewayConnectionsList.json#L15
                    "type": "Microsoft.Network/connections",
                    "location": "centralus",
                    "properties": {
                      "provisioningState": "Succeeded",
                      "resourceGuid": "00000000-0000-0000-0000-000000000000",
                      "virtualNetworkGateway1": {
VirtualNetworkGatewayConnectionsList.json#L15
                    "type": "Microsoft.Network/connections",
                    "location": "centralus",
                    "properties": {
                      "provisioningState": "Succeeded",
                      "resourceGuid": "00000000-0000-0000-0000-000000000000",
                      "virtualNetworkGateway1": {

Parameters

  • name required - string
  • type required - string
  • apiVersion required - string
  • location required - string

    Resource location.

  • tags optional - string

    Resource tags.

  • properties required
      • authorizationKey optional - string

        The authorizationKey.

      • virtualNetworkGateway1 required
          • id required - string

            Resource ID.

      • virtualNetworkGateway2 optional
          • id required - string

            Resource ID.

      • localNetworkGateway2 optional
          • id required - string

            Resource ID.

      • connectionType required - string

        Gateway connection type.

      • connectionProtocol optional - string

        Connection protocol used for this connection.

      • routingWeight optional - integer

        The routing weight.

      • dpdTimeoutSeconds optional - integer

        The dead peer detection timeout of this connection in seconds.

      • connectionMode optional - string

        The connection mode for this connection.

      • sharedKey optional - string

        The IPSec shared key.

      • peer optional
          • id required - string

            Resource ID.

      • enableBgp optional - boolean

        EnableBgp flag.

      • useLocalAzureIpAddress optional - boolean

        Use private local Azure IP for the connection.

      • usePolicyBasedTrafficSelectors optional - boolean

        Enable policy-based traffic selectors.

      • ipsecPolicies optional array
          • saLifeTimeSeconds required - integer

            The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.

          • saDataSizeKilobytes required - integer

            The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.

          • ipsecEncryption required - string

            The IPSec encryption algorithm (IKE phase 1).

          • ipsecIntegrity required - string

            The IPSec integrity algorithm (IKE phase 1).

          • ikeEncryption required - string

            The IKE encryption algorithm (IKE phase 2).

          • ikeIntegrity required - string

            The IKE integrity algorithm (IKE phase 2).

          • dhGroup required - string

            The DH Group used in IKE Phase 1 for initial SA.

          • pfsGroup required - string

            The Pfs Group used in IKE Phase 2 for new child SA.

      • trafficSelectorPolicies optional array
          • localAddressRanges required - array

            A collection of local address spaces in CIDR format.

          • remoteAddressRanges required - array

            A collection of remote address spaces in CIDR format.

      • expressRouteGatewayBypass optional - boolean

        Bypass ExpressRoute Gateway for data forwarding.

>> from Azure Resource Manager Documentation

The Other Related Azure Network Resources

Frequently asked questions

What is Azure Network Gateway Connection?

Azure Network Gateway Connection is a resource for Network of Microsoft Azure. Settings can be wrote in Terraform.

Where can I find the example code for the Azure Network Gateway Connection?

For Terraform, the mukesh-ranjan/Hashicorp-Terraform-Associate-Certification-Preparation-Guide-LAB, gmirsky/aws-azure-vpn and ITEFARMAT/tf-aks source code examples are useful. See the Terraform Example section for further details.

For Azure Resource Manager, the tkubica12/azure-virtual-wan, fabferri/az-pattern and noendscripting/Azure-PoC-Template source code examples are useful. See the Azure Resource Manager Example section for further details.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents