Microsoft.Network vpnGateways 2018-06-01

Bicep resource definition

The vpnGateways resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/vpnGateways resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/vpnGateways@2018-06-01' = {
  location: 'string'
  name: 'string'
  properties: {
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      peerWeight: int
    }
    connections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          enableBgp: bool
          ipsecPolicies: [
            {
              dhGroup: 'string'
              ikeEncryption: 'string'
              ikeIntegrity: 'string'
              ipsecEncryption: 'string'
              ipsecIntegrity: 'string'
              pfsGroup: 'string'
              saDataSizeKilobytes: int
              saLifeTimeSeconds: int
            }
          ]
          provisioningState: 'string'
          remoteVpnSite: {
            id: 'string'
          }
          routingWeight: int
          sharedKey: 'string'
        }
      }
    ]
    policies: {
      allowBranchToBranchTraffic: bool
      allowVnetToVnetTraffic: bool
    }
    provisioningState: 'string'
    virtualHub: {
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

BgpSettings

IpsecPolicy

Microsoft.Network/vpnGateways

Policies

ResourceTags

SubResource

VpnConnection

VpnConnectionProperties

VpnGatewayProperties

Quickstart samples

The following quickstart samples deploy this resource type.

ARM template resource definition

The vpnGateways resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/vpnGateways resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/vpnGateways",
  "apiVersion": "2018-06-01",
  "name": "string",
  "location": "string",
  "properties": {
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "peerWeight": "int"
    },
    "connections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "enableBgp": "bool",
          "ipsecPolicies": [
            {
              "dhGroup": "string",
              "ikeEncryption": "string",
              "ikeIntegrity": "string",
              "ipsecEncryption": "string",
              "ipsecIntegrity": "string",
              "pfsGroup": "string",
              "saDataSizeKilobytes": "int",
              "saLifeTimeSeconds": "int"
            }
          ],
          "provisioningState": "string",
          "remoteVpnSite": {
            "id": "string"
          },
          "routingWeight": "int",
          "sharedKey": "string"
        }
      }
    ],
    "policies": {
      "allowBranchToBranchTraffic": "bool",
      "allowVnetToVnetTraffic": "bool"
    },
    "provisioningState": "string",
    "virtualHub": {
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

BgpSettings

IpsecPolicy

Microsoft.Network/vpnGateways

Policies

ResourceTags

SubResource

VpnConnection

VpnConnectionProperties

VpnGatewayProperties

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Azure Virtual WAN (vWAN) Multi-Hub Deployment	This template allows you to create an Azure Virtual WAN (vWAN) multi-hub deployment including all gateways and VNET connections.
Azure vWAN Multi-Hub Deployment with Custom Routing Tables	This template allows you to create an Azure Virtual WAN (vWAN) multi-hub deployment, including all gateways and VNET connections, and demonstrate the usage of Route Tables for custom routing.
Creates Virtual WAN resources	This template allows you to create virtual WAN resources including Virtual WAN, Virtual Hub, VPN Gateway, VPN Site and a VPN Connecton.

Terraform (AzAPI provider) resource definition

The vpnGateways resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/vpnGateways resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnGateways@2018-06-01"
  name = "string"
  location = "string"
  body = jsonencode({
    properties = {
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        peerWeight = int
      }
      connections = [
        {
          id = "string"
          name = "string"
          properties = {
            enableBgp = bool
            ipsecPolicies = [
              {
                dhGroup = "string"
                ikeEncryption = "string"
                ikeIntegrity = "string"
                ipsecEncryption = "string"
                ipsecIntegrity = "string"
                pfsGroup = "string"
                saDataSizeKilobytes = int
                saLifeTimeSeconds = int
              }
            ]
            provisioningState = "string"
            remoteVpnSite = {
              id = "string"
            }
            routingWeight = int
            sharedKey = "string"
          }
        }
      ]
      policies = {
        allowBranchToBranchTraffic = bool
        allowVnetToVnetTraffic = bool
      }
      provisioningState = "string"
      virtualHub = {
        id = "string"
      }
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

BgpSettings

IpsecPolicy

Microsoft.Network/vpnGateways

Policies

ResourceTags

SubResource

VpnConnection

VpnConnectionProperties

VpnGatewayProperties