Microsoft.Network vpnSites 2022-05-01

• Latest
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01
• 2019-02-01
• 2018-12-01
• 2018-11-01
• 2018-10-01
• 2018-08-01
• 2018-07-01
• 2018-06-01
• 2018-04-01

Bicep resource definition

The vpnSites resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.Network/vpnSites@2022-05-01' = {
  location: 'string'
  name: 'string'
  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
          }
        }
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

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 Constraints: Min value = 0 Max value = 4294967295
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

DeviceProperties

Name	Description	Value
deviceModel	Model of the device.	string
deviceVendor	Name of the device Vendor.	string
linkSpeedInMbps	Link speed.	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

Microsoft.Network/vpnSites

Name	Description	Value
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the VPN site.	VpnSiteProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

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

O365PolicyProperties

Name	Description	Value
breakOutCategories	Office365 breakout categories.	O365BreakOutCategoryPolicies

ResourceTags

Name	Description	Value

SubResource

Name	Description	Value
id	Resource ID.	string

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

VpnSiteLink

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	Properties of the VPN site link.	VpnSiteLinkProperties

VpnSiteLinkProperties

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

VpnSiteProperties

Name	Description	Value
addressSpace	The AddressSpace that contains an array of IP address ranges.	AddressSpace
bgpProperties	The set of bgp properties.	BgpSettings
deviceProperties	The device properties.	DeviceProperties
ipAddress	The ip-address for the vpn-site.	string
isSecuritySite	IsSecuritySite flag.	bool
o365Policy	Office365 Policy.	O365PolicyProperties
siteKey	The key for vpn-site that can be used for connections.	string
virtualWan	The VirtualWAN to which the vpnSite belongs.	SubResource
vpnSiteLinks	List of all vpn site links.	VpnSiteLink[]

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Creates Virtual WAN resources	This template allows you to create virtual WAN resources including Virtual WAN, Virtual Hub, VPN Gateway, VPN Site and a VPN Connecton.

ARM template resource definition

The vpnSites resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.Network/vpnSites",
  "apiVersion": "2022-05-01",
  "name": "string",
  "location": "string",
  "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"
          }
        }
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

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 Constraints: Min value = 0 Max value = 4294967295
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

DeviceProperties

Name	Description	Value
deviceModel	Model of the device.	string
deviceVendor	Name of the device Vendor.	string
linkSpeedInMbps	Link speed.	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

Microsoft.Network/vpnSites

Name	Description	Value
apiVersion	The api version	'2022-05-01'
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the VPN site.	VpnSiteProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Network/vpnSites'

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

O365PolicyProperties

Name	Description	Value
breakOutCategories	Office365 breakout categories.	O365BreakOutCategoryPolicies

ResourceTags

Name	Description	Value

SubResource

Name	Description	Value
id	Resource ID.	string

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

VpnSiteLink

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	Properties of the VPN site link.	VpnSiteLinkProperties

VpnSiteLinkProperties

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

VpnSiteProperties

Name	Description	Value
addressSpace	The AddressSpace that contains an array of IP address ranges.	AddressSpace
bgpProperties	The set of bgp properties.	BgpSettings
deviceProperties	The device properties.	DeviceProperties
ipAddress	The ip-address for the vpn-site.	string
isSecuritySite	IsSecuritySite flag.	bool
o365Policy	Office365 Policy.	O365PolicyProperties
siteKey	The key for vpn-site that can be used for connections.	string
virtualWan	The VirtualWAN to which the vpnSite belongs.	SubResource
vpnSiteLinks	List of all vpn site links.	VpnSiteLink[]

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Creates Virtual WAN resources	This template allows you to create virtual WAN resources including Virtual WAN, Virtual Hub, VPN Gateway, VPN Site and a VPN Connecton.

Terraform (AzAPI provider) resource definition

The vpnSites resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnSites@2022-05-01"
  name = "string"
  location = "string"
  body = jsonencode({
    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
            }
          }
        }
      ]
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

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 Constraints: Min value = 0 Max value = 4294967295
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

DeviceProperties

Name	Description	Value
deviceModel	Model of the device.	string
deviceVendor	Name of the device Vendor.	string
linkSpeedInMbps	Link speed.	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

Microsoft.Network/vpnSites

Name	Description	Value
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the VPN site.	VpnSiteProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Network/vpnSites@2022-05-01"

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

O365PolicyProperties

Name	Description	Value
breakOutCategories	Office365 breakout categories.	O365BreakOutCategoryPolicies

ResourceTags

Name	Description	Value

SubResource

Name	Description	Value
id	Resource ID.	string

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

VpnSiteLink

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	Properties of the VPN site link.	VpnSiteLinkProperties

VpnSiteLinkProperties

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

VpnSiteProperties

Name	Description	Value
addressSpace	The AddressSpace that contains an array of IP address ranges.	AddressSpace
bgpProperties	The set of bgp properties.	BgpSettings
deviceProperties	The device properties.	DeviceProperties
ipAddress	The ip-address for the vpn-site.	string
isSecuritySite	IsSecuritySite flag.	bool
o365Policy	Office365 Policy.	O365PolicyProperties
siteKey	The key for vpn-site that can be used for connections.	string
virtualWan	The VirtualWAN to which the vpnSite belongs.	SubResource
vpnSiteLinks	List of all vpn site links.	VpnSiteLink[]