Microsoft.Network p2svpnGateways 2020-03-01

The p2svpnGateways resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

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

resource symbolicname 'Microsoft.Network/p2svpnGateways@2020-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    p2SConnectionConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          vpnClientAddressPool: {
            addressPrefixes: [ 'string' ]
          }
        }
      }
    ]
    virtualHub: {
      id: 'string'
    }
    vpnGatewayScaleUnit: int
    vpnServerConfiguration: {
      id: 'string'
    }
  }
}

Property values

p2svpnGateways

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Network/p2svpnGateways'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2020-03-01'
name The resource name string (required)
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Parameters for P2SVpnGateway. P2SVpnGatewayProperties

P2SVpnGatewayProperties

Name Description Value
p2SConnectionConfigurations List of all p2s connection configurations of the gateway. P2SConnectionConfiguration[]
virtualHub Reference to another subresource. SubResource
vpnGatewayScaleUnit The scale unit for this p2s vpn gateway. int
vpnServerConfiguration Reference to another subresource. SubResource

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 Parameters for P2SConnectionConfiguration. P2SConnectionConfigurationProperties

P2SConnectionConfigurationProperties

Name Description Value
vpnClientAddressPool AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. AddressSpace

AddressSpace

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

SubResource

Name Description Value
id Resource ID. string

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.