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": "2020-05-01",
  "location": "string",
  "tags": {},
  "properties": {
    "virtualWan": {
      "id": "string"
    },
    "deviceProperties": {
      "deviceVendor": "string",
      "deviceModel": "string",
      "linkSpeedInMbps": "integer"
    },
    "ipAddress": "string",
    "siteKey": "string",
    "addressSpace": {
      "addressPrefixes": [
        "string"
      ]
    },
    "bgpProperties": {
      "asn": "integer",
      "bgpPeeringAddress": "string",
      "peerWeight": "integer",
      "bgpPeeringAddresses": [
        {
          "ipconfigurationId": "string",
          "customBgpIpAddresses": [
            "string"
          ]
        }
      ]
    },
    "isSecuritySite": "boolean",
    "vpnSiteLinks": [
      {
        "id": "string",
        "properties": {
          "linkProperties": {
            "linkProviderName": "string",
            "linkSpeedInMbps": "integer"
          },
          "ipAddress": "string",
          "fqdn": "string",
          "bgpProperties": {
            "asn": "integer",
            "bgpPeeringAddress": "string"
          }
        },
        "name": "string"
      }
    ]
  }
}

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 2020-05-01
location string Yes Resource location.
tags object No Resource tags.
properties object Yes Properties of the VPN site. - 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.
vpnSiteLinks array No List of all vpn site links. - VpnSiteLink object

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.
bgpPeeringAddresses array No BGP peering address with IP configuration ID for virtual network gateway. - IPConfigurationBgpPeeringAddress object

Name Type Required Value
id string No Resource ID.
properties object No Properties of the VPN site link. - VpnSiteLinkProperties object
name string No The name of the resource that is unique within a resource group. This name can be used to access the resource.

IPConfigurationBgpPeeringAddress object

Name Type Required Value
ipconfigurationId string No The ID of IP configuration which belongs to gateway.
customBgpIpAddresses array No The list of custom BGP peering addresses which belong to IP configuration. - string

VpnSiteLinkProperties object

Name Type Required Value
linkProperties object No The link provider properties. - VpnLinkProviderProperties object
ipAddress string No The ip-address for the vpn-site-link.
fqdn string No FQDN of vpn-site-link.
bgpProperties object No The set of bgp properties. - VpnLinkBgpSettings object

VpnLinkProviderProperties object

Name Type Required Value
linkProviderName string No Name of the link provider.
linkSpeedInMbps integer No Link speed.

VpnLinkBgpSettings 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.

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.