Microsoft.Network vpnGateways/vpnConnections template reference

Template format

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

{
  "name": "string",
  "type": "Microsoft.Network/vpnGateways/vpnConnections",
  "apiVersion": "2018-04-01",
  "location": "string",
  "tags": {},
  "properties": {
    "remoteVpnSite": {
      "id": "string"
    },
    "routingWeight": "integer",
    "connectionStatus": "string",
    "sharedKey": "string",
    "enableBgp": boolean,
    "ipsecPolicies": [
      {
        "saLifeTimeSeconds": "integer",
        "saDataSizeKilobytes": "integer",
        "ipsecEncryption": "string",
        "ipsecIntegrity": "string",
        "ikeEncryption": "string",
        "ikeIntegrity": "string",
        "dhGroup": "string",
        "pfsGroup": "string"
      }
    ]
  }
}

Property values

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

Microsoft.Network/vpnGateways/vpnConnections object

Name Type Required Value
name string Yes
type enum Yes Microsoft.Network/vpnGateways/vpnConnections
apiVersion enum Yes 2018-04-01
location string No Resource location.
tags object No Resource tags.
properties object Yes VpnConnectionProperties object

VpnConnectionProperties object

Name Type Required Value
remoteVpnSite object No Id of the connected vpn site. - SubResource object
routingWeight integer No routing weight for vpn connection.
connectionStatus enum No The connection status. - Unknown, Connecting, Connected, NotConnected
sharedKey string No SharedKey for the vpn connection.
enableBgp boolean No EnableBgp flag
ipsecPolicies array No The IPSec Policies to be considered by this connection. - IpsecPolicy object

SubResource object

Name Type Required Value
id string No Resource ID.

IpsecPolicy object

Name Type Required Value
saLifeTimeSeconds integer Yes The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.
saDataSizeKilobytes integer Yes The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
ipsecEncryption enum Yes The IPSec encryption algorithm (IKE phase 1). - None, DES, DES3, AES128, AES192, AES256, GCMAES128, GCMAES192, GCMAES256
ipsecIntegrity enum Yes The IPSec integrity algorithm (IKE phase 1). - MD5, SHA1, SHA256, GCMAES128, GCMAES192, GCMAES256
ikeEncryption enum Yes The IKE encryption algorithm (IKE phase 2). - DES, DES3, AES128, AES192, AES256, GCMAES256, GCMAES128
ikeIntegrity enum Yes The IKE integrity algorithm (IKE phase 2). - MD5, SHA1, SHA256, SHA384, GCMAES256, GCMAES128
dhGroup enum Yes The DH Groups used in IKE Phase 1 for initial SA. - None, DHGroup1, DHGroup2, DHGroup14, DHGroup2048, ECP256, ECP384, DHGroup24
pfsGroup enum Yes The Pfs Groups used in IKE Phase 2 for new child SA. - None, PFS1, PFS2, PFS2048, ECP256, ECP384, PFS24, PFS14, PFSMM