Microsoft.Network vpnSites

The vpnSites resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Network/vpnSites resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Network/vpnSites@2021-02-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    addressSpace: {
      addressPrefixes: [ 'string' ]
    }
    bgpProperties: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [ 'string' ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    deviceProperties: {
      deviceModel: 'string'
      deviceVendor: 'string'
      linkSpeedInMbps: int
    }
    ipAddress: 'string'
    isSecuritySite: bool
    o365Policy: {
      breakOutCategories: {
        allow: bool
        default: bool
        optimize: bool
      }
    }
    siteKey: 'string'
    virtualWan: {
      id: 'string'
    }
    vpnSiteLinks: [
      {
        id: 'string'
        name: 'string'
        properties: {
          bgpProperties: {
            asn: int
            bgpPeeringAddress: 'string'
          }
          fqdn: 'string'
          ipAddress: 'string'
          linkProperties: {
            linkProviderName: 'string'
            linkSpeedInMbps: int
          }
        }
      }
    ]
  }
}

Property values

vpnSites

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Network/vpnSites'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-02-01'
name The resource name string (required)
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Parameters for VpnSite. VpnSiteProperties

VpnSiteProperties

Name Description Value
addressSpace AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. AddressSpace
bgpProperties BGP settings details. BgpSettings
deviceProperties List of properties of the device. DeviceProperties
ipAddress The ip-address for the vpn-site. string
isSecuritySite IsSecuritySite flag. bool
o365Policy The Office365 breakout policy. O365PolicyProperties
siteKey The key for vpn-site that can be used for connections. string
virtualWan Reference to another subresource. SubResource
vpnSiteLinks List of all vpn site links. VpnSiteLink[]

AddressSpace

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

BgpSettings

Name Description Value
asn The BGP speaker's ASN. int
bgpPeeringAddress The BGP peering address and BGP identifier of this BGP speaker. string
bgpPeeringAddresses BGP peering address with IP configuration ID for virtual network gateway. IPConfigurationBgpPeeringAddress[]
peerWeight The weight added to routes learned from this BGP speaker. int

IPConfigurationBgpPeeringAddress

Name Description Value
customBgpIpAddresses The list of custom BGP peering addresses which belong to IP configuration. string[]
ipconfigurationId The ID of IP configuration which belongs to gateway. string

DeviceProperties

Name Description Value
deviceModel Model of the device. string
deviceVendor Name of the device Vendor. string
linkSpeedInMbps Link speed. int

O365PolicyProperties

Name Description Value
breakOutCategories Office365 breakout categories. O365BreakOutCategoryPolicies

O365BreakOutCategoryPolicies

Name Description Value
allow Flag to control allow category. bool
default Flag to control default category. bool
optimize Flag to control optimize category. bool

SubResource

Name Description Value
id Resource ID. string
Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Parameters for VpnSite. VpnSiteLinkProperties

VpnSiteLinkProperties

Name Description Value
bgpProperties BGP settings details for a link. VpnLinkBgpSettings
fqdn FQDN of vpn-site-link. string
ipAddress The ip-address for the vpn-site-link. string
linkProperties List of properties of a link provider. VpnLinkProviderProperties

VpnLinkBgpSettings

Name Description Value
asn The BGP speaker's ASN. int
bgpPeeringAddress The BGP peering address and BGP identifier of this BGP speaker. string

VpnLinkProviderProperties

Name Description Value
linkProviderName Name of the link provider. string
linkSpeedInMbps Link speed. int

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.