Microsoft.Network p2svpnGateways 2020-05-01

• Latest
• 2024-05-01
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01
• 2019-02-01
• 2018-12-01
• 2018-11-01
• 2018-10-01
• 2018-08-01

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/p2svpnGateways@2020-05-01' = {
  location: 'string'
  name: 'string'
  properties: {
    customDnsServers: [
      'string'
    ]
    p2SConnectionConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          routingConfiguration: {
            associatedRouteTable: {
              id: 'string'
            }
            propagatedRouteTables: {
              ids: [
                {
                  id: 'string'
                }
              ]
              labels: [
                'string'
              ]
            }
            vnetRoutes: {
              staticRoutes: [
                {
                  addressPrefixes: [
                    'string'
                  ]
                  name: 'string'
                  nextHopIpAddress: '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
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[]
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
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

VnetRoute

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

ARM template resource definition

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

{
  "type": "Microsoft.Network/p2svpnGateways",
  "apiVersion": "2020-05-01",
  "name": "string",
  "location": "string",
  "properties": {
    "customDnsServers": [ "string" ],
    "p2SConnectionConfigurations": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "string"
            },
            "propagatedRouteTables": {
              "ids": [
                {
                  "id": "string"
                }
              ],
              "labels": [ "string" ]
            },
            "vnetRoutes": {
              "staticRoutes": [
                {
                  "addressPrefixes": [ "string" ],
                  "name": "string",
                  "nextHopIpAddress": "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	'2020-05-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
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[]
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
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

VnetRoute

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

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.
vWAN P2S deployment with multi address pool and user groups	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@2020-05-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      customDnsServers = [
        "string"
      ]
      p2SConnectionConfigurations = [
        {
          id = "string"
          name = "string"
          properties = {
            routingConfiguration = {
              associatedRouteTable = {
                id = "string"
              }
              propagatedRouteTables = {
                ids = [
                  {
                    id = "string"
                  }
                ]
                labels = [
                  "string"
                ]
              }
              vnetRoutes = {
                staticRoutes = [
                  {
                    addressPrefixes = [
                      "string"
                    ]
                    name = "string"
                    nextHopIpAddress = "string"
                  }
                ]
              }
            }
            vpnClientAddressPool = {
              addressPrefixes = [
                "string"
              ]
            }
          }
        }
      ]
      virtualHub = {
        id = "string"
      }
      vpnGatewayScaleUnit = int
      vpnServerConfiguration = {
        id = "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@2020-05-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
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[]
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
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

VnetRoute

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