VPN Template

• Overview

Overview

The VPN template object allows you to specify the configuration to deploy Point-to-Site or Site-to-Site VPN Gateways.

You can only have one VPN template object in a template file. The VPN template is defined within the "template" array at the root of the JSON template file, and requires a "type" value of "vpn":

{
    "template": [
        {
            "type": "vpn"
        }
    ]
}

Properties

Point-to-Site

Below are the properties that are used in defining a Point-to-Site VPN template object

Name	Type	Required	Description
configType	string	yes	Specifies the type of VPN Gateway to deploy, can be either p2s or s2s (Point-to-Site and Site-to-Site respectively)
certPath	string	yes	The path to a valid .cer certificate
gatewaySky	string	yes	The type of SKU to use for the VPN, can be either Basic, Standard or HighPerformace
tag	string	yes	The tag-name of this VPN template. ie, if core then the VPN deployed will have the name [rg-name]-core
type	string	yes	Specifies the type of template object, can be either vmor vpn
vpnType	string	yes	The type of VPN to use, can be either RouteBased or PolicyBased

Site-to-Site

Below are the properties that are used in defining a Site-to-Site VPN template object

Name	Type	Required	Description
configType	string	yes	Specifies the type of VPN Gateway to deploy, can be either p2s or s2s (Point-to-Site and Site-to-Site respectively)
gatewaySky	string	yes	The type of SKU to use for the VPN, can be either Basic, Standard or HighPerformace
sharedKey	string	yes	The shared key to use for the VPN
tag	string	yes	The tag-name of this VPN template. ie, if core then the VPN deployed will have the name [rg-name]-core
type	string	yes	Specifies the type of template object, can be either vmor vpn
vpnType	string	yes	The type of VPN to use, can be either RouteBased or PolicyBased