Microsoft.Network p2svpnGateways 2022-11-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@2022-11-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

Microsoft.Network/p2svpnGateways

P2SConnectionConfiguration

P2SConnectionConfigurationProperties

P2SVpnGatewayProperties

PropagatedRouteTable

ResourceTags

RoutingConfiguration

StaticRoute

StaticRoutesConfig

SubResource

VnetRoute

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": "2022-11-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

Microsoft.Network/p2svpnGateways

P2SConnectionConfiguration

P2SConnectionConfigurationProperties

P2SVpnGatewayProperties

PropagatedRouteTable

ResourceTags

RoutingConfiguration

StaticRoute

StaticRoutesConfig

SubResource

VnetRoute

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@2022-11-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

Microsoft.Network/p2svpnGateways

P2SConnectionConfiguration

P2SConnectionConfigurationProperties

P2SVpnGatewayProperties

PropagatedRouteTable

ResourceTags

RoutingConfiguration

StaticRoute

StaticRoutesConfig

SubResource

VnetRoute