Share via

Microsoft.Network p2svpnGateways 2024-01-01

  • Article

Bicep resource definition

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

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

Resource format

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

resource symbolicname 'Microsoft.Network/p2svpnGateways@2024-01-01' = {
  location: 'string'
  name: 'string'
  properties: {
    customDnsServers: [
      'string'
    ]
    isRoutingPreferenceInternet: bool
    p2SConnectionConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          enableInternetSecurity: bool
          routingConfiguration: {
            associatedRouteTable: {
              id: 'string'
            }
            inboundRouteMap: {
              id: 'string'
            }
            outboundRouteMap: {
              id: 'string'
            }
            propagatedRouteTables: {
              ids: [
                {
                  id: 'string'
                }
              ]
              labels: [
                'string'
              ]
            }
            vnetRoutes: {
              staticRoutes: [
                {
                  addressPrefixes: [
                    'string'
                  ]
                  name: 'string'
                  nextHopIpAddress: 'string'
                }
              ]
              staticRoutesConfig: {
                vnetLocalRouteOverrideCriteria: 'string'
              }
            }
          }
          vpnClientAddressPool: {
            addressPrefixes: [
              'string'
            ]
          }
        }
      }
    ]
    virtualHub: {
      id: 'string'
    }
    vpnGatewayScaleUnit: int
    vpnServerConfiguration: {
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

AddressSpace

Name Description Value
addressPrefixes A list of address blocks reserved for this virtual network in CIDR notation. string[]

Microsoft.Network/p2svpnGateways

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

P2SConnectionConfiguration

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 P2S connection configuration. P2SConnectionConfigurationProperties

P2SConnectionConfigurationProperties

Name Description Value
enableInternetSecurity Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. bool
routingConfiguration The Routing Configuration indicating the associated and propagated route tables on this connection. RoutingConfiguration
vpnClientAddressPool The reference to the address space resource which represents Address space for P2S VpnClient. AddressSpace

P2SVpnGatewayProperties

Name Description Value
customDnsServers List of all customer specified DNS servers IP addresses. string[]
isRoutingPreferenceInternet Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. bool
p2SConnectionConfigurations List of all p2s connection configurations of the gateway. P2SConnectionConfiguration[]
virtualHub The VirtualHub to which the gateway belongs. SubResource
vpnGatewayScaleUnit The scale unit for this p2s vpn gateway. int
vpnServerConfiguration The VpnServerConfiguration to which the p2sVpnGateway is attached to. SubResource

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
inboundRouteMap The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. SubResource
outboundRouteMap The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. 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

StaticRoutesConfig

Name Description Value
vnetLocalRouteOverrideCriteria Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. 'Contains'
'Equal'

SubResource

Name Description Value
id Resource ID. string

VnetRoute

Name Description Value
staticRoutes List of all Static Routes. StaticRoute[]
staticRoutesConfig Configuration for static routes on this HubVnetConnection. StaticRoutesConfig

ARM template resource definition

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

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

Resource format

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

{
  "type": "Microsoft.Network/p2svpnGateways",
  "apiVersion": "2024-01-01",
  "name": "string",
  "location": "string",
  "properties": {
    "customDnsServers": [ "string" ],
    "isRoutingPreferenceInternet": "bool",
    "p2SConnectionConfigurations": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "enableInternetSecurity": "bool",
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "string"
            },
            "inboundRouteMap": {
              "id": "string"
            },
            "outboundRouteMap": {
              "id": "string"
            },
            "propagatedRouteTables": {
              "ids": [
                {
                  "id": "string"
                }
              ],
              "labels": [ "string" ]
            },
            "vnetRoutes": {
              "staticRoutes": [
                {
                  "addressPrefixes": [ "string" ],
                  "name": "string",
                  "nextHopIpAddress": "string"
                }
              ],
              "staticRoutesConfig": {
                "vnetLocalRouteOverrideCriteria": "string"
              }
            }
          },
          "vpnClientAddressPool": {
            "addressPrefixes": [ "string" ]
          }
        }
      }
    ],
    "virtualHub": {
      "id": "string"
    },
    "vpnGatewayScaleUnit": "int",
    "vpnServerConfiguration": {
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

AddressSpace

Name Description Value
addressPrefixes A list of address blocks reserved for this virtual network in CIDR notation. string[]

Microsoft.Network/p2svpnGateways

Name Description Value
apiVersion The api version '2024-01-01'
location Resource location. string
name The resource name string (required)
properties Properties of the P2SVpnGateway. P2SVpnGatewayProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Network/p2svpnGateways'

P2SConnectionConfiguration

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 P2S connection configuration. P2SConnectionConfigurationProperties

P2SConnectionConfigurationProperties

Name Description Value
enableInternetSecurity Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. bool
routingConfiguration The Routing Configuration indicating the associated and propagated route tables on this connection. RoutingConfiguration
vpnClientAddressPool The reference to the address space resource which represents Address space for P2S VpnClient. AddressSpace

P2SVpnGatewayProperties

Name Description Value
customDnsServers List of all customer specified DNS servers IP addresses. string[]
isRoutingPreferenceInternet Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. bool
p2SConnectionConfigurations List of all p2s connection configurations of the gateway. P2SConnectionConfiguration[]
virtualHub The VirtualHub to which the gateway belongs. SubResource
vpnGatewayScaleUnit The scale unit for this p2s vpn gateway. int
vpnServerConfiguration The VpnServerConfiguration to which the p2sVpnGateway is attached to. SubResource

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
inboundRouteMap The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. SubResource
outboundRouteMap The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. 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

StaticRoutesConfig

Name Description Value
vnetLocalRouteOverrideCriteria Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. 'Contains'
'Equal'

SubResource

Name Description Value
id Resource ID. string

VnetRoute

Name Description Value
staticRoutes List of all Static Routes. StaticRoute[]
staticRoutesConfig Configuration for static routes on this HubVnetConnection. StaticRoutesConfig

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Virtual WAN (vWAN) Multi-Hub Deployment

Deploy to Azure		 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

Deploy to Azure		 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.
vWAN P2S deployment with multi address pool and user groups

Deploy to Azure		 This template deploys Azure Virtual WAN (vWAN) with a P2S configured with multiple address pool and user groups

Terraform (AzAPI provider) resource definition

The p2svpnGateways 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/p2svpnGateways resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/p2svpnGateways@2024-01-01"
  name = "string"
  location = "string"
  body = jsonencode({
    properties = {
      customDnsServers = [
        "string"
      ]
      isRoutingPreferenceInternet = bool
      p2SConnectionConfigurations = [
        {
          id = "string"
          name = "string"
          properties = {
            enableInternetSecurity = bool
            routingConfiguration = {
              associatedRouteTable = {
                id = "string"
              }
              inboundRouteMap = {
                id = "string"
              }
              outboundRouteMap = {
                id = "string"
              }
              propagatedRouteTables = {
                ids = [
                  {
                    id = "string"
                  }
                ]
                labels = [
                  "string"
                ]
              }
              vnetRoutes = {
                staticRoutes = [
                  {
                    addressPrefixes = [
                      "string"
                    ]
                    name = "string"
                    nextHopIpAddress = "string"
                  }
                ]
                staticRoutesConfig = {
                  vnetLocalRouteOverrideCriteria = "string"
                }
              }
            }
            vpnClientAddressPool = {
              addressPrefixes = [
                "string"
              ]
            }
          }
        }
      ]
      virtualHub = {
        id = "string"
      }
      vpnGatewayScaleUnit = int
      vpnServerConfiguration = {
        id = "string"
      }
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

AddressSpace

Name Description Value
addressPrefixes A list of address blocks reserved for this virtual network in CIDR notation. string[]

Microsoft.Network/p2svpnGateways

Name Description Value
location Resource location. string
name The resource name string (required)
properties Properties of the P2SVpnGateway. P2SVpnGatewayProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Network/p2svpnGateways@2024-01-01"

P2SConnectionConfiguration

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 P2S connection configuration. P2SConnectionConfigurationProperties

P2SConnectionConfigurationProperties

Name Description Value
enableInternetSecurity Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. bool
routingConfiguration The Routing Configuration indicating the associated and propagated route tables on this connection. RoutingConfiguration
vpnClientAddressPool The reference to the address space resource which represents Address space for P2S VpnClient. AddressSpace

P2SVpnGatewayProperties

Name Description Value
customDnsServers List of all customer specified DNS servers IP addresses. string[]
isRoutingPreferenceInternet Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. bool
p2SConnectionConfigurations List of all p2s connection configurations of the gateway. P2SConnectionConfiguration[]
virtualHub The VirtualHub to which the gateway belongs. SubResource
vpnGatewayScaleUnit The scale unit for this p2s vpn gateway. int
vpnServerConfiguration The VpnServerConfiguration to which the p2sVpnGateway is attached to. SubResource

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
inboundRouteMap The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. SubResource
outboundRouteMap The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. 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

StaticRoutesConfig

Name Description Value
vnetLocalRouteOverrideCriteria Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. 'Contains'
'Equal'

SubResource

Name Description Value
id Resource ID. string

VnetRoute

Name Description Value
staticRoutes List of all Static Routes. StaticRoute[]
staticRoutesConfig Configuration for static routes on this HubVnetConnection. StaticRoutesConfig