Microsoft.Network vpnSites template reference

Template format

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

  "name": "string",
  "type": "Microsoft.Network/vpnSites",
  "apiVersion": "2018-10-01",
  "location": "string",
  "tags": {},
  "properties": {
    "virtualWan": {
      "id": "string"
    "deviceProperties": {
      "deviceVendor": "string",
      "deviceModel": "string",
      "linkSpeedInMbps": "integer"
    "ipAddress": "string",
    "siteKey": "string",
    "addressSpace": {
      "addressPrefixes": [
    "bgpProperties": {
      "asn": "integer",
      "bgpPeeringAddress": "string",
      "peerWeight": "integer"
    "isSecuritySite": "boolean"

Property values

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

Microsoft.Network/vpnSites object

Name Type Required Value
name string Yes The name of the VpnSite being created or updated.
type enum Yes Microsoft.Network/vpnSites
apiVersion enum Yes 2018-10-01
location string No Resource location.
tags object No Resource tags.
properties object Yes VpnSiteProperties object

VpnSiteProperties object

Name Type Required Value
virtualWan object No The VirtualWAN to which the vpnSite belongs - SubResource object
deviceProperties object No The device properties - DeviceProperties object
ipAddress string No The ip-address for the vpn-site.
siteKey string No The key for vpn-site that can be used for connections.
addressSpace object No The AddressSpace that contains an array of IP address ranges. - AddressSpace object
bgpProperties object No The set of bgp properties. - BgpSettings object
isSecuritySite boolean No IsSecuritySite flag

SubResource object

Name Type Required Value
id string No Resource ID.

DeviceProperties object

Name Type Required Value
deviceVendor string No Name of the device Vendor.
deviceModel string No Model of the device.
linkSpeedInMbps integer No Link speed.

AddressSpace object

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

BgpSettings object

Name Type Required Value
asn integer No The BGP speaker's ASN.
bgpPeeringAddress string No The BGP peering address and BGP identifier of this BGP speaker.
peerWeight integer No The weight added to routes learned from this BGP speaker.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Creates Virtual wan resources

Deploy to Azure
This template allows you to create virtual wan resources including virtual wan, virtual hub, vpn gateway, vpnsite and a vpn connecton.