Share via

Microsoft.Network p2svpnGateways 2019-07-01

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@2019-07-01' = {
  location: 'string'
  name: 'string'
  properties: {
    customRoutes: {
      addressPrefixes: [
        'string'
      ]
    }
    p2SVpnServerConfiguration: {
      id: 'string'
    }
    virtualHub: {
      id: 'string'
    }
    vpnClientAddressPool: {
      addressPrefixes: [
        'string'
      ]
    }
    vpnGatewayScaleUnit: int
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

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

AddressSpace

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

P2SVpnGatewayProperties

Name Description Value
customRoutes The reference of the address space resource which represents the custom routes specified by the customer for P2SVpnGateway and P2S VpnClient. AddressSpace
p2SVpnServerConfiguration The P2SVpnServerConfiguration to which the p2sVpnGateway is attached to. SubResource
virtualHub The VirtualHub to which the gateway belongs. SubResource
vpnClientAddressPool The reference of the address space resource which represents Address space for P2S VpnClient. AddressSpace
vpnGatewayScaleUnit The scale unit for this p2s vpn gateway. int

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource ID. string

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
P2S VPN Gateway AVM Resource Module for P2S VPN Gateway

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": "2019-07-01",
  "name": "string",
  "location": "string",
  "properties": {
    "customRoutes": {
      "addressPrefixes": [ "string" ]
    },
    "p2SVpnServerConfiguration": {
      "id": "string"
    },
    "virtualHub": {
      "id": "string"
    },
    "vpnClientAddressPool": {
      "addressPrefixes": [ "string" ]
    },
    "vpnGatewayScaleUnit": "int"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Network/p2svpnGateways

Name Description Value
apiVersion The api version '2019-07-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'

AddressSpace

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

P2SVpnGatewayProperties

Name Description Value
customRoutes The reference of the address space resource which represents the custom routes specified by the customer for P2SVpnGateway and P2S VpnClient. AddressSpace
p2SVpnServerConfiguration The P2SVpnServerConfiguration to which the p2sVpnGateway is attached to. SubResource
virtualHub The VirtualHub to which the gateway belongs. SubResource
vpnClientAddressPool The reference of the address space resource which represents Address space for P2S VpnClient. AddressSpace
vpnGatewayScaleUnit The scale unit for this p2s vpn gateway. int

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource ID. string

Usage Examples

Azure Quickstart Templates

The following Azure 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@2019-07-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      customRoutes = {
        addressPrefixes = [
          "string"
        ]
      }
      p2SVpnServerConfiguration = {
        id = "string"
      }
      virtualHub = {
        id = "string"
      }
      vpnClientAddressPool = {
        addressPrefixes = [
          "string"
        ]
      }
      vpnGatewayScaleUnit = int
    }
  }
}

Property Values

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@2019-07-01"

AddressSpace

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

P2SVpnGatewayProperties

Name Description Value
customRoutes The reference of the address space resource which represents the custom routes specified by the customer for P2SVpnGateway and P2S VpnClient. AddressSpace
p2SVpnServerConfiguration The P2SVpnServerConfiguration to which the p2sVpnGateway is attached to. SubResource
virtualHub The VirtualHub to which the gateway belongs. SubResource
vpnClientAddressPool The reference of the address space resource which represents Address space for P2S VpnClient. AddressSpace
vpnGatewayScaleUnit The scale unit for this p2s vpn gateway. int

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource ID. string