Microsoft.Network vpnGateways 2021-02-01

Article
10/24/2024

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@2021-02-01' = {
  location: 'string'
  name: 'string'
  properties: {
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    connections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          connectionBandwidth: int
          dpdTimeoutSeconds: int
          enableBgp: bool
          enableInternetSecurity: bool
          enableRateLimiting: bool
          ipsecPolicies: [
            {
              dhGroup: 'string'
              ikeEncryption: 'string'
              ikeIntegrity: 'string'
              ipsecEncryption: 'string'
              ipsecIntegrity: 'string'
              pfsGroup: 'string'
              saDataSizeKilobytes: int
              saLifeTimeSeconds: int
            }
          ]
          remoteVpnSite: {
            id: 'string'
          }
          routingConfiguration: {
            associatedRouteTable: {
              id: 'string'
            }
            propagatedRouteTables: {
              ids: [
                {
                  id: 'string'
                }
              ]
              labels: [
                'string'
              ]
            }
            vnetRoutes: {
              staticRoutes: [
                {
                  addressPrefixes: [
                    'string'
                  ]
                  name: 'string'
                  nextHopIpAddress: 'string'
                }
              ]
            }
          }
          routingWeight: int
          sharedKey: 'string'
          trafficSelectorPolicies: [
            {
              localAddressRanges: [
                'string'
              ]
              remoteAddressRanges: [
                'string'
              ]
            }
          ]
          useLocalAzureIpAddress: bool
          usePolicyBasedTrafficSelectors: bool
          vpnConnectionProtocolType: 'string'
          vpnLinkConnections: [
            {
              id: 'string'
              name: 'string'
              properties: {
                connectionBandwidth: int
                egressNatRules: [
                  {
                    id: 'string'
                  }
                ]
                enableBgp: bool
                enableRateLimiting: bool
                ingressNatRules: [
                  {
                    id: 'string'
                  }
                ]
                ipsecPolicies: [
                  {
                    dhGroup: 'string'
                    ikeEncryption: 'string'
                    ikeIntegrity: 'string'
                    ipsecEncryption: 'string'
                    ipsecIntegrity: 'string'
                    pfsGroup: 'string'
                    saDataSizeKilobytes: int
                    saLifeTimeSeconds: int
                  }
                ]
                routingWeight: int
                sharedKey: 'string'
                useLocalAzureIpAddress: bool
                usePolicyBasedTrafficSelectors: bool
                vpnConnectionProtocolType: 'string'
                vpnLinkConnectionMode: 'string'
                vpnSiteLink: {
                  id: 'string'
                }
              }
            }
          ]
        }
      }
    ]
    isRoutingPreferenceInternet: bool
    natRules: [
      {
        id: 'string'
        name: 'string'
        properties: {
          externalMappings: [
            {
              addressSpace: 'string'
            }
          ]
          internalMappings: [
            {
              addressSpace: 'string'
            }
          ]
          ipConfigurationId: 'string'
          mode: 'string'
          type: 'string'
        }
      }
    ]
    virtualHub: {
      id: 'string'
    }
    vpnGatewayScaleUnit: int
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

BgpSettings

Name	Description	Value
asn	The BGP speaker's ASN.	int Constraints: Min value = 0 Max value = 4294967295
bgpPeeringAddress	The BGP peering address and BGP identifier of this BGP speaker.	string
bgpPeeringAddresses	BGP peering address with IP configuration ID for virtual network gateway.	IPConfigurationBgpPeeringAddress[]
peerWeight	The weight added to routes learned from this BGP speaker.	int

IPConfigurationBgpPeeringAddress

Name	Description	Value
customBgpIpAddresses	The list of custom BGP peering addresses which belong to IP configuration.	string[]
ipconfigurationId	The ID of IP configuration which belongs to gateway.	string

IpsecPolicy

Name	Description	Value
dhGroup	The DH Group used in IKE Phase 1 for initial SA.	'DHGroup1' 'DHGroup14' 'DHGroup2' 'DHGroup2048' 'DHGroup24' 'ECP256' 'ECP384' 'None' (required)
ikeEncryption	The IKE encryption algorithm (IKE phase 2).	'AES128' 'AES192' 'AES256' 'DES' 'DES3' 'GCMAES128' 'GCMAES256' (required)
ikeIntegrity	The IKE integrity algorithm (IKE phase 2).	'GCMAES128' 'GCMAES256' 'MD5' 'SHA1' 'SHA256' 'SHA384' (required)
ipsecEncryption	The IPSec encryption algorithm (IKE phase 1).	'AES128' 'AES192' 'AES256' 'DES' 'DES3' 'GCMAES128' 'GCMAES192' 'GCMAES256' 'None' (required)
ipsecIntegrity	The IPSec integrity algorithm (IKE phase 1).	'GCMAES128' 'GCMAES192' 'GCMAES256' 'MD5' 'SHA1' 'SHA256' (required)
pfsGroup	The Pfs Group used in IKE Phase 2 for new child SA.	'ECP256' 'ECP384' 'None' 'PFS1' 'PFS14' 'PFS2' 'PFS2048' 'PFS24' 'PFSMM' (required)
saDataSizeKilobytes	The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.	int (required)
saLifeTimeSeconds	The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.	int (required)

Microsoft.Network/vpnGateways

Name	Description	Value
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the VPN gateway.	VpnGatewayProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

PropagatedRouteTable

Name	Description	Value
ids	The list of resource ids of all the RouteTables.	SubResource[]
labels	The list of labels.	string[]

ResourceTags

Name	Description	Value

RoutingConfiguration

Name	Description	Value
associatedRouteTable	The resource id RouteTable associated with this RoutingConfiguration.	SubResource
propagatedRouteTables	The list of RouteTables to advertise the routes to.	PropagatedRouteTable
vnetRoutes	List of routes that control routing from VirtualHub into a virtual network connection.	VnetRoute

StaticRoute

Name	Description	Value
addressPrefixes	List of all address prefixes.	string[]
name	The name of the StaticRoute that is unique within a VnetRoute.	string
nextHopIpAddress	The ip address of the next hop.	string

SubResource

Name	Description	Value
id	Resource ID.	string

TrafficSelectorPolicy

Name	Description	Value
localAddressRanges	A collection of local address spaces in CIDR format.	string[] (required)
remoteAddressRanges	A collection of remote address spaces in CIDR format.	string[] (required)

VnetRoute

Name	Description	Value
staticRoutes	List of all Static Routes.	StaticRoute[]

VpnConnection

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the VPN connection.	VpnConnectionProperties

VpnConnectionProperties

Name	Description	Value
connectionBandwidth	Expected bandwidth in MBPS.	int
dpdTimeoutSeconds	DPD timeout in seconds for vpn connection.	int
enableBgp	EnableBgp flag.	bool
enableInternetSecurity	Enable internet security.	bool
enableRateLimiting	EnableBgp flag.	bool
ipsecPolicies	The IPSec Policies to be considered by this connection.	IpsecPolicy[]
remoteVpnSite	Id of the connected vpn site.	SubResource
routingConfiguration	The Routing Configuration indicating the associated and propagated route tables on this connection.	RoutingConfiguration
routingWeight	Routing weight for vpn connection.	int
sharedKey	SharedKey for the vpn connection.	string
trafficSelectorPolicies	The Traffic Selector Policies to be considered by this connection.	TrafficSelectorPolicy[]
useLocalAzureIpAddress	Use local azure ip to initiate connection.	bool
usePolicyBasedTrafficSelectors	Enable policy-based traffic selectors.	bool
vpnConnectionProtocolType	Connection protocol used for this connection.	'IKEv1' 'IKEv2'
vpnLinkConnections	List of all vpn site link connections to the gateway.	VpnSiteLinkConnection[]

VpnGatewayNatRule

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the VpnGateway NAT rule.	VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Name	Description	Value
externalMappings	The private IP address external mapping for NAT.	VpnNatRuleMapping[]
internalMappings	The private IP address internal mapping for NAT.	VpnNatRuleMapping[]
ipConfigurationId	The IP Configuration ID this NAT rule applies to.	string
mode	The Source NAT direction of a VPN NAT.	'EgressSnat' 'IngressSnat'
type	The type of NAT rule for VPN NAT.	'Dynamic' 'Static'

VpnGatewayProperties

Name	Description	Value
bgpSettings	Local network gateway's BGP speaker settings.	BgpSettings
connections	List of all vpn connections to the gateway.	VpnConnection[]
isRoutingPreferenceInternet	Enable Routing Preference property for the Public IP Interface of the VpnGateway.	bool
natRules	List of all the nat Rules associated with the gateway.	VpnGatewayNatRule[]
virtualHub	The VirtualHub to which the gateway belongs.	SubResource
vpnGatewayScaleUnit	The scale unit for this vpn gateway.	int

VpnNatRuleMapping

Name	Description	Value
addressSpace	Address space for Vpn NatRule mapping.	string

VpnSiteLinkConnection

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the VPN site link connection.	VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Name	Description	Value
connectionBandwidth	Expected bandwidth in MBPS.	int
egressNatRules	List of egress NatRules.	SubResource[]
enableBgp	EnableBgp flag.	bool
enableRateLimiting	EnableBgp flag.	bool
ingressNatRules	List of ingress NatRules.	SubResource[]
ipsecPolicies	The IPSec Policies to be considered by this connection.	IpsecPolicy[]
routingWeight	Routing weight for vpn connection.	int
sharedKey	SharedKey for the vpn connection.	string
useLocalAzureIpAddress	Use local azure ip to initiate connection.	bool
usePolicyBasedTrafficSelectors	Enable policy-based traffic selectors.	bool
vpnConnectionProtocolType	Connection protocol used for this connection.	'IKEv1' 'IKEv2'
vpnLinkConnectionMode	Vpn link connection mode.	'Default' 'InitiatorOnly' 'ResponderOnly'
vpnSiteLink	Id of the connected vpn site link.	SubResource

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
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.

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": "2021-02-01",
  "name": "string",
  "location": "string",
  "properties": {
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "connections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "connectionBandwidth": "int",
          "dpdTimeoutSeconds": "int",
          "enableBgp": "bool",
          "enableInternetSecurity": "bool",
          "enableRateLimiting": "bool",
          "ipsecPolicies": [
            {
              "dhGroup": "string",
              "ikeEncryption": "string",
              "ikeIntegrity": "string",
              "ipsecEncryption": "string",
              "ipsecIntegrity": "string",
              "pfsGroup": "string",
              "saDataSizeKilobytes": "int",
              "saLifeTimeSeconds": "int"
            }
          ],
          "remoteVpnSite": {
            "id": "string"
          },
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "string"
            },
            "propagatedRouteTables": {
              "ids": [
                {
                  "id": "string"
                }
              ],
              "labels": [ "string" ]
            },
            "vnetRoutes": {
              "staticRoutes": [
                {
                  "addressPrefixes": [ "string" ],
                  "name": "string",
                  "nextHopIpAddress": "string"
                }
              ]
            }
          },
          "routingWeight": "int",
          "sharedKey": "string",
          "trafficSelectorPolicies": [
            {
              "localAddressRanges": [ "string" ],
              "remoteAddressRanges": [ "string" ]
            }
          ],
          "useLocalAzureIpAddress": "bool",
          "usePolicyBasedTrafficSelectors": "bool",
          "vpnConnectionProtocolType": "string",
          "vpnLinkConnections": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "connectionBandwidth": "int",
                "egressNatRules": [
                  {
                    "id": "string"
                  }
                ],
                "enableBgp": "bool",
                "enableRateLimiting": "bool",
                "ingressNatRules": [
                  {
                    "id": "string"
                  }
                ],
                "ipsecPolicies": [
                  {
                    "dhGroup": "string",
                    "ikeEncryption": "string",
                    "ikeIntegrity": "string",
                    "ipsecEncryption": "string",
                    "ipsecIntegrity": "string",
                    "pfsGroup": "string",
                    "saDataSizeKilobytes": "int",
                    "saLifeTimeSeconds": "int"
                  }
                ],
                "routingWeight": "int",
                "sharedKey": "string",
                "useLocalAzureIpAddress": "bool",
                "usePolicyBasedTrafficSelectors": "bool",
                "vpnConnectionProtocolType": "string",
                "vpnLinkConnectionMode": "string",
                "vpnSiteLink": {
                  "id": "string"
                }
              }
            }
          ]
        }
      }
    ],
    "isRoutingPreferenceInternet": "bool",
    "natRules": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "externalMappings": [
            {
              "addressSpace": "string"
            }
          ],
          "internalMappings": [
            {
              "addressSpace": "string"
            }
          ],
          "ipConfigurationId": "string",
          "mode": "string",
          "type": "string"
        }
      }
    ],
    "virtualHub": {
      "id": "string"
    },
    "vpnGatewayScaleUnit": "int"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

BgpSettings

Name	Description	Value
asn	The BGP speaker's ASN.	int Constraints: Min value = 0 Max value = 4294967295
bgpPeeringAddress	The BGP peering address and BGP identifier of this BGP speaker.	string
bgpPeeringAddresses	BGP peering address with IP configuration ID for virtual network gateway.	IPConfigurationBgpPeeringAddress[]
peerWeight	The weight added to routes learned from this BGP speaker.	int

IPConfigurationBgpPeeringAddress

Name	Description	Value
customBgpIpAddresses	The list of custom BGP peering addresses which belong to IP configuration.	string[]
ipconfigurationId	The ID of IP configuration which belongs to gateway.	string

IpsecPolicy

Name	Description	Value
dhGroup	The DH Group used in IKE Phase 1 for initial SA.	'DHGroup1' 'DHGroup14' 'DHGroup2' 'DHGroup2048' 'DHGroup24' 'ECP256' 'ECP384' 'None' (required)
ikeEncryption	The IKE encryption algorithm (IKE phase 2).	'AES128' 'AES192' 'AES256' 'DES' 'DES3' 'GCMAES128' 'GCMAES256' (required)
ikeIntegrity	The IKE integrity algorithm (IKE phase 2).	'GCMAES128' 'GCMAES256' 'MD5' 'SHA1' 'SHA256' 'SHA384' (required)
ipsecEncryption	The IPSec encryption algorithm (IKE phase 1).	'AES128' 'AES192' 'AES256' 'DES' 'DES3' 'GCMAES128' 'GCMAES192' 'GCMAES256' 'None' (required)
ipsecIntegrity	The IPSec integrity algorithm (IKE phase 1).	'GCMAES128' 'GCMAES192' 'GCMAES256' 'MD5' 'SHA1' 'SHA256' (required)
pfsGroup	The Pfs Group used in IKE Phase 2 for new child SA.	'ECP256' 'ECP384' 'None' 'PFS1' 'PFS14' 'PFS2' 'PFS2048' 'PFS24' 'PFSMM' (required)
saDataSizeKilobytes	The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.	int (required)
saLifeTimeSeconds	The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.	int (required)

Microsoft.Network/vpnGateways

Name	Description	Value
apiVersion	The api version	'2021-02-01'
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the VPN gateway.	VpnGatewayProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Network/vpnGateways'

PropagatedRouteTable

Name	Description	Value
ids	The list of resource ids of all the RouteTables.	SubResource[]
labels	The list of labels.	string[]

ResourceTags

Name	Description	Value

RoutingConfiguration

Name	Description	Value
associatedRouteTable	The resource id RouteTable associated with this RoutingConfiguration.	SubResource
propagatedRouteTables	The list of RouteTables to advertise the routes to.	PropagatedRouteTable
vnetRoutes	List of routes that control routing from VirtualHub into a virtual network connection.	VnetRoute

StaticRoute

Name	Description	Value
addressPrefixes	List of all address prefixes.	string[]
name	The name of the StaticRoute that is unique within a VnetRoute.	string
nextHopIpAddress	The ip address of the next hop.	string

SubResource

Name	Description	Value
id	Resource ID.	string

TrafficSelectorPolicy

Name	Description	Value
localAddressRanges	A collection of local address spaces in CIDR format.	string[] (required)
remoteAddressRanges	A collection of remote address spaces in CIDR format.	string[] (required)

VnetRoute

Name	Description	Value
staticRoutes	List of all Static Routes.	StaticRoute[]

VpnConnection

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the VPN connection.	VpnConnectionProperties

VpnConnectionProperties

Name	Description	Value
connectionBandwidth	Expected bandwidth in MBPS.	int
dpdTimeoutSeconds	DPD timeout in seconds for vpn connection.	int
enableBgp	EnableBgp flag.	bool
enableInternetSecurity	Enable internet security.	bool
enableRateLimiting	EnableBgp flag.	bool
ipsecPolicies	The IPSec Policies to be considered by this connection.	IpsecPolicy[]
remoteVpnSite	Id of the connected vpn site.	SubResource
routingConfiguration	The Routing Configuration indicating the associated and propagated route tables on this connection.	RoutingConfiguration
routingWeight	Routing weight for vpn connection.	int
sharedKey	SharedKey for the vpn connection.	string
trafficSelectorPolicies	The Traffic Selector Policies to be considered by this connection.	TrafficSelectorPolicy[]
useLocalAzureIpAddress	Use local azure ip to initiate connection.	bool
usePolicyBasedTrafficSelectors	Enable policy-based traffic selectors.	bool
vpnConnectionProtocolType	Connection protocol used for this connection.	'IKEv1' 'IKEv2'
vpnLinkConnections	List of all vpn site link connections to the gateway.	VpnSiteLinkConnection[]

VpnGatewayNatRule

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the VpnGateway NAT rule.	VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Name	Description	Value
externalMappings	The private IP address external mapping for NAT.	VpnNatRuleMapping[]
internalMappings	The private IP address internal mapping for NAT.	VpnNatRuleMapping[]
ipConfigurationId	The IP Configuration ID this NAT rule applies to.	string
mode	The Source NAT direction of a VPN NAT.	'EgressSnat' 'IngressSnat'
type	The type of NAT rule for VPN NAT.	'Dynamic' 'Static'

VpnGatewayProperties

Name	Description	Value
bgpSettings	Local network gateway's BGP speaker settings.	BgpSettings
connections	List of all vpn connections to the gateway.	VpnConnection[]
isRoutingPreferenceInternet	Enable Routing Preference property for the Public IP Interface of the VpnGateway.	bool
natRules	List of all the nat Rules associated with the gateway.	VpnGatewayNatRule[]
virtualHub	The VirtualHub to which the gateway belongs.	SubResource
vpnGatewayScaleUnit	The scale unit for this vpn gateway.	int

VpnNatRuleMapping

Name	Description	Value
addressSpace	Address space for Vpn NatRule mapping.	string

VpnSiteLinkConnection

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the VPN site link connection.	VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Name	Description	Value
connectionBandwidth	Expected bandwidth in MBPS.	int
egressNatRules	List of egress NatRules.	SubResource[]
enableBgp	EnableBgp flag.	bool
enableRateLimiting	EnableBgp flag.	bool
ingressNatRules	List of ingress NatRules.	SubResource[]
ipsecPolicies	The IPSec Policies to be considered by this connection.	IpsecPolicy[]
routingWeight	Routing weight for vpn connection.	int
sharedKey	SharedKey for the vpn connection.	string
useLocalAzureIpAddress	Use local azure ip to initiate connection.	bool
usePolicyBasedTrafficSelectors	Enable policy-based traffic selectors.	bool
vpnConnectionProtocolType	Connection protocol used for this connection.	'IKEv1' 'IKEv2'
vpnLinkConnectionMode	Vpn link connection mode.	'Default' 'InitiatorOnly' 'ResponderOnly'
vpnSiteLink	Id of the connected vpn site link.	SubResource

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@2021-02-01"
  name = "string"
  location = "string"
  body = jsonencode({
    properties = {
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        bgpPeeringAddresses = [
          {
            customBgpIpAddresses = [
              "string"
            ]
            ipconfigurationId = "string"
          }
        ]
        peerWeight = int
      }
      connections = [
        {
          id = "string"
          name = "string"
          properties = {
            connectionBandwidth = int
            dpdTimeoutSeconds = int
            enableBgp = bool
            enableInternetSecurity = bool
            enableRateLimiting = bool
            ipsecPolicies = [
              {
                dhGroup = "string"
                ikeEncryption = "string"
                ikeIntegrity = "string"
                ipsecEncryption = "string"
                ipsecIntegrity = "string"
                pfsGroup = "string"
                saDataSizeKilobytes = int
                saLifeTimeSeconds = int
              }
            ]
            remoteVpnSite = {
              id = "string"
            }
            routingConfiguration = {
              associatedRouteTable = {
                id = "string"
              }
              propagatedRouteTables = {
                ids = [
                  {
                    id = "string"
                  }
                ]
                labels = [
                  "string"
                ]
              }
              vnetRoutes = {
                staticRoutes = [
                  {
                    addressPrefixes = [
                      "string"
                    ]
                    name = "string"
                    nextHopIpAddress = "string"
                  }
                ]
              }
            }
            routingWeight = int
            sharedKey = "string"
            trafficSelectorPolicies = [
              {
                localAddressRanges = [
                  "string"
                ]
                remoteAddressRanges = [
                  "string"
                ]
              }
            ]
            useLocalAzureIpAddress = bool
            usePolicyBasedTrafficSelectors = bool
            vpnConnectionProtocolType = "string"
            vpnLinkConnections = [
              {
                id = "string"
                name = "string"
                properties = {
                  connectionBandwidth = int
                  egressNatRules = [
                    {
                      id = "string"
                    }
                  ]
                  enableBgp = bool
                  enableRateLimiting = bool
                  ingressNatRules = [
                    {
                      id = "string"
                    }
                  ]
                  ipsecPolicies = [
                    {
                      dhGroup = "string"
                      ikeEncryption = "string"
                      ikeIntegrity = "string"
                      ipsecEncryption = "string"
                      ipsecIntegrity = "string"
                      pfsGroup = "string"
                      saDataSizeKilobytes = int
                      saLifeTimeSeconds = int
                    }
                  ]
                  routingWeight = int
                  sharedKey = "string"
                  useLocalAzureIpAddress = bool
                  usePolicyBasedTrafficSelectors = bool
                  vpnConnectionProtocolType = "string"
                  vpnLinkConnectionMode = "string"
                  vpnSiteLink = {
                    id = "string"
                  }
                }
              }
            ]
          }
        }
      ]
      isRoutingPreferenceInternet = bool
      natRules = [
        {
          id = "string"
          name = "string"
          properties = {
            externalMappings = [
              {
                addressSpace = "string"
              }
            ]
            internalMappings = [
              {
                addressSpace = "string"
              }
            ]
            ipConfigurationId = "string"
            mode = "string"
            type = "string"
          }
        }
      ]
      virtualHub = {
        id = "string"
      }
      vpnGatewayScaleUnit = int
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

BgpSettings

Name	Description	Value
asn	The BGP speaker's ASN.	int Constraints: Min value = 0 Max value = 4294967295
bgpPeeringAddress	The BGP peering address and BGP identifier of this BGP speaker.	string
bgpPeeringAddresses	BGP peering address with IP configuration ID for virtual network gateway.	IPConfigurationBgpPeeringAddress[]
peerWeight	The weight added to routes learned from this BGP speaker.	int

IPConfigurationBgpPeeringAddress

Name	Description	Value
customBgpIpAddresses	The list of custom BGP peering addresses which belong to IP configuration.	string[]
ipconfigurationId	The ID of IP configuration which belongs to gateway.	string

IpsecPolicy

Name	Description	Value
dhGroup	The DH Group used in IKE Phase 1 for initial SA.	'DHGroup1' 'DHGroup14' 'DHGroup2' 'DHGroup2048' 'DHGroup24' 'ECP256' 'ECP384' 'None' (required)
ikeEncryption	The IKE encryption algorithm (IKE phase 2).	'AES128' 'AES192' 'AES256' 'DES' 'DES3' 'GCMAES128' 'GCMAES256' (required)
ikeIntegrity	The IKE integrity algorithm (IKE phase 2).	'GCMAES128' 'GCMAES256' 'MD5' 'SHA1' 'SHA256' 'SHA384' (required)
ipsecEncryption	The IPSec encryption algorithm (IKE phase 1).	'AES128' 'AES192' 'AES256' 'DES' 'DES3' 'GCMAES128' 'GCMAES192' 'GCMAES256' 'None' (required)
ipsecIntegrity	The IPSec integrity algorithm (IKE phase 1).	'GCMAES128' 'GCMAES192' 'GCMAES256' 'MD5' 'SHA1' 'SHA256' (required)
pfsGroup	The Pfs Group used in IKE Phase 2 for new child SA.	'ECP256' 'ECP384' 'None' 'PFS1' 'PFS14' 'PFS2' 'PFS2048' 'PFS24' 'PFSMM' (required)
saDataSizeKilobytes	The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.	int (required)
saLifeTimeSeconds	The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.	int (required)

Microsoft.Network/vpnGateways

Name	Description	Value
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the VPN gateway.	VpnGatewayProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Network/vpnGateways@2021-02-01"

PropagatedRouteTable

Name	Description	Value
ids	The list of resource ids of all the RouteTables.	SubResource[]
labels	The list of labels.	string[]

ResourceTags

Name	Description	Value

RoutingConfiguration

Name	Description	Value
associatedRouteTable	The resource id RouteTable associated with this RoutingConfiguration.	SubResource
propagatedRouteTables	The list of RouteTables to advertise the routes to.	PropagatedRouteTable
vnetRoutes	List of routes that control routing from VirtualHub into a virtual network connection.	VnetRoute

StaticRoute

Name	Description	Value
addressPrefixes	List of all address prefixes.	string[]
name	The name of the StaticRoute that is unique within a VnetRoute.	string
nextHopIpAddress	The ip address of the next hop.	string

SubResource

Name	Description	Value
id	Resource ID.	string

TrafficSelectorPolicy

Name	Description	Value
localAddressRanges	A collection of local address spaces in CIDR format.	string[] (required)
remoteAddressRanges	A collection of remote address spaces in CIDR format.	string[] (required)

VnetRoute

Name	Description	Value
staticRoutes	List of all Static Routes.	StaticRoute[]

VpnConnection

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the VPN connection.	VpnConnectionProperties

VpnConnectionProperties

Name	Description	Value
connectionBandwidth	Expected bandwidth in MBPS.	int
dpdTimeoutSeconds	DPD timeout in seconds for vpn connection.	int
enableBgp	EnableBgp flag.	bool
enableInternetSecurity	Enable internet security.	bool
enableRateLimiting	EnableBgp flag.	bool
ipsecPolicies	The IPSec Policies to be considered by this connection.	IpsecPolicy[]
remoteVpnSite	Id of the connected vpn site.	SubResource
routingConfiguration	The Routing Configuration indicating the associated and propagated route tables on this connection.	RoutingConfiguration
routingWeight	Routing weight for vpn connection.	int
sharedKey	SharedKey for the vpn connection.	string
trafficSelectorPolicies	The Traffic Selector Policies to be considered by this connection.	TrafficSelectorPolicy[]
useLocalAzureIpAddress	Use local azure ip to initiate connection.	bool
usePolicyBasedTrafficSelectors	Enable policy-based traffic selectors.	bool
vpnConnectionProtocolType	Connection protocol used for this connection.	'IKEv1' 'IKEv2'
vpnLinkConnections	List of all vpn site link connections to the gateway.	VpnSiteLinkConnection[]

VpnGatewayNatRule

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the VpnGateway NAT rule.	VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Name	Description	Value
externalMappings	The private IP address external mapping for NAT.	VpnNatRuleMapping[]
internalMappings	The private IP address internal mapping for NAT.	VpnNatRuleMapping[]
ipConfigurationId	The IP Configuration ID this NAT rule applies to.	string
mode	The Source NAT direction of a VPN NAT.	'EgressSnat' 'IngressSnat'
type	The type of NAT rule for VPN NAT.	'Dynamic' 'Static'

VpnGatewayProperties

Name	Description	Value
bgpSettings	Local network gateway's BGP speaker settings.	BgpSettings
connections	List of all vpn connections to the gateway.	VpnConnection[]
isRoutingPreferenceInternet	Enable Routing Preference property for the Public IP Interface of the VpnGateway.	bool
natRules	List of all the nat Rules associated with the gateway.	VpnGatewayNatRule[]
virtualHub	The VirtualHub to which the gateway belongs.	SubResource
vpnGatewayScaleUnit	The scale unit for this vpn gateway.	int

VpnNatRuleMapping

Name	Description	Value
addressSpace	Address space for Vpn NatRule mapping.	string

VpnSiteLinkConnection

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the VPN site link connection.	VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Name	Description	Value
connectionBandwidth	Expected bandwidth in MBPS.	int
egressNatRules	List of egress NatRules.	SubResource[]
enableBgp	EnableBgp flag.	bool
enableRateLimiting	EnableBgp flag.	bool
ingressNatRules	List of ingress NatRules.	SubResource[]
ipsecPolicies	The IPSec Policies to be considered by this connection.	IpsecPolicy[]
routingWeight	Routing weight for vpn connection.	int
sharedKey	SharedKey for the vpn connection.	string
useLocalAzureIpAddress	Use local azure ip to initiate connection.	bool
usePolicyBasedTrafficSelectors	Enable policy-based traffic selectors.	bool
vpnConnectionProtocolType	Connection protocol used for this connection.	'IKEv1' 'IKEv2'
vpnLinkConnectionMode	Vpn link connection mode.	'Default' 'InitiatorOnly' 'ResponderOnly'
vpnSiteLink	Id of the connected vpn site link.	SubResource

Share via

Microsoft.Network vpnGateways 2021-02-01

Bicep resource definition

Resource format

Property values

BgpSettings

IPConfigurationBgpPeeringAddress

IpsecPolicy

Microsoft.Network/vpnGateways

PropagatedRouteTable

ResourceTags

RoutingConfiguration

StaticRoute

SubResource

TrafficSelectorPolicy

VnetRoute

VpnConnection

VpnConnectionProperties

VpnGatewayNatRule

VpnGatewayNatRuleProperties

VpnGatewayProperties

VpnNatRuleMapping

VpnSiteLinkConnection

VpnSiteLinkConnectionProperties

Quickstart samples

ARM template resource definition

Resource format

Property values

BgpSettings

IPConfigurationBgpPeeringAddress

IpsecPolicy

Microsoft.Network/vpnGateways

PropagatedRouteTable

ResourceTags

RoutingConfiguration

StaticRoute

SubResource

TrafficSelectorPolicy

VnetRoute

VpnConnection

VpnConnectionProperties

VpnGatewayNatRule

VpnGatewayNatRuleProperties

VpnGatewayProperties

VpnNatRuleMapping

VpnSiteLinkConnection

VpnSiteLinkConnectionProperties

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

BgpSettings

IPConfigurationBgpPeeringAddress

IpsecPolicy

Microsoft.Network/vpnGateways

PropagatedRouteTable

ResourceTags

RoutingConfiguration

StaticRoute

SubResource

TrafficSelectorPolicy

VnetRoute

VpnConnection

VpnConnectionProperties

VpnGatewayNatRule

VpnGatewayNatRuleProperties

VpnGatewayProperties

VpnNatRuleMapping

VpnSiteLinkConnection

VpnSiteLinkConnectionProperties

Feedback

Additional resources