Microsoft.Network p2svpnGateways template reference

Template format

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

  "name": "string",
  "type": "Microsoft.Network/p2svpnGateways",
  "apiVersion": "2018-08-01",
  "location": "string",
  "tags": {},
  "properties": {
    "virtualHub": {
      "id": "string"
    "vpnGatewayScaleUnit": "integer",
    "p2SVpnServerConfiguration": {
      "id": "string"
    "vpnClientAddressPool": {
      "addressPrefixes": [

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Network/p2svpnGateways object


In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes The name of the gateway.
type enum Yes For JSON - Microsoft.Network/p2svpnGateways
apiVersion enum Yes For JSON - 2018-08-01
id string No Resource ID.
location string No Resource location.
tags object No Resource tags.
properties object Yes P2SVpnGatewayProperties object

P2SVpnGatewayProperties object

Name Type Required Value
virtualHub object No The VirtualHub to which the gateway belongs - SubResource object
vpnGatewayScaleUnit integer No The scale unit for this p2s vpn gateway.
p2SVpnServerConfiguration object No The P2SVpnServerConfiguration to which the p2sVpnGateway is attached to. - SubResource object
vpnClientAddressPool object No The reference of the address space resource which represents Address space for P2S VpnClient. - AddressSpace object

SubResource object

Name Type Required Value
id string No Resource ID.

AddressSpace object

Name Type Required Value
addressPrefixes array No A list of address blocks reserved for this virtual network in CIDR notation. - string