Microsoft.Network vpnSites 2019-08-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@2019-08-01' = {
  location: 'string'
  name: 'string'
  properties: {
    addressSpace: {
      addressPrefixes: [
        'string'
      ]
    }
    bgpProperties: {
      asn: int
      bgpPeeringAddress: 'string'
      peerWeight: int
    }
    deviceProperties: {
      deviceModel: 'string'
      deviceVendor: 'string'
      linkSpeedInMbps: int
    }
    ipAddress: 'string'
    isSecuritySite: bool
    siteKey: 'string'
    virtualWan: {
      id: 'string'
    }
    vpnSiteLinks: [
      {
        id: 'string'
        name: 'string'
        properties: {
          bgpProperties: {
            asn: int
            bgpPeeringAddress: 'string'
          }
          ipAddress: 'string'
          linkProperties: {
            linkProviderName: 'string'
            linkSpeedInMbps: int
          }
        }
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Network/vpnSites

AddressSpace

BgpSettings

DeviceProperties

ResourceTags

SubResource

VpnLinkBgpSettings

VpnLinkProviderProperties

VpnSiteLink

VpnSiteLinkProperties

VpnSiteProperties

Usage Examples

Bicep Samples

A basic example of deploying VPN Site.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource virtualWan 'Microsoft.Network/virtualWans@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    allowBranchToBranchTraffic: true
    disableVpnEncryption: false
    office365LocalBreakoutCategory: 'None'
    type: 'Standard'
  }
}

resource vpnSite 'Microsoft.Network/vpnSites@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    addressSpace: {
      addressPrefixes: [
        '10.0.1.0/24'
      ]
    }
    virtualWan: {
      id: virtualWan.id
    }
    vpnSiteLinks: [
      {
        name: 'link1'
        properties: {
          fqdn: ''
          ipAddress: '10.0.1.1'
          linkProperties: {
            linkProviderName: ''
            linkSpeedInMbps: 0
          }
        }
      }
      {
        name: 'link2'
        properties: {
          fqdn: ''
          ipAddress: '10.0.1.2'
          linkProperties: {
            linkProviderName: ''
            linkSpeedInMbps: 0
          }
        }
      }
    ]
  }
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

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": "2019-08-01",
  "name": "string",
  "location": "string",
  "properties": {
    "addressSpace": {
      "addressPrefixes": [ "string" ]
    },
    "bgpProperties": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "peerWeight": "int"
    },
    "deviceProperties": {
      "deviceModel": "string",
      "deviceVendor": "string",
      "linkSpeedInMbps": "int"
    },
    "ipAddress": "string",
    "isSecuritySite": "bool",
    "siteKey": "string",
    "virtualWan": {
      "id": "string"
    },
    "vpnSiteLinks": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "bgpProperties": {
            "asn": "int",
            "bgpPeeringAddress": "string"
          },
          "ipAddress": "string",
          "linkProperties": {
            "linkProviderName": "string",
            "linkSpeedInMbps": "int"
          }
        }
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Network/vpnSites

AddressSpace

BgpSettings

DeviceProperties

ResourceTags

SubResource

VpnLinkBgpSettings

VpnLinkProviderProperties

VpnSiteLink

VpnSiteLinkProperties

VpnSiteProperties

Usage Examples

Azure Quickstart Templates

The following Azure 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@2019-08-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      addressSpace = {
        addressPrefixes = [
          "string"
        ]
      }
      bgpProperties = {
        asn = int
        bgpPeeringAddress = "string"
        peerWeight = int
      }
      deviceProperties = {
        deviceModel = "string"
        deviceVendor = "string"
        linkSpeedInMbps = int
      }
      ipAddress = "string"
      isSecuritySite = bool
      siteKey = "string"
      virtualWan = {
        id = "string"
      }
      vpnSiteLinks = [
        {
          id = "string"
          name = "string"
          properties = {
            bgpProperties = {
              asn = int
              bgpPeeringAddress = "string"
            }
            ipAddress = "string"
            linkProperties = {
              linkProviderName = "string"
              linkSpeedInMbps = int
            }
          }
        }
      ]
    }
  }
}

Property Values

Microsoft.Network/vpnSites

AddressSpace

BgpSettings

DeviceProperties

ResourceTags

SubResource

VpnLinkBgpSettings

VpnLinkProviderProperties

VpnSiteLink

VpnSiteLinkProperties

VpnSiteProperties

Usage Examples

Terraform Samples

A basic example of deploying VPN Site.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "virtualWan" {
  type      = "Microsoft.Network/virtualWans@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      allowBranchToBranchTraffic     = true
      disableVpnEncryption           = false
      office365LocalBreakoutCategory = "None"
      type                           = "Standard"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "vpnSite" {
  type      = "Microsoft.Network/vpnSites@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      addressSpace = {
        addressPrefixes = [
          "10.0.1.0/24",
        ]
      }
      virtualWan = {
        id = azapi_resource.virtualWan.id
      }
      vpnSiteLinks = [
        {
          name = "link1"
          properties = {
            fqdn      = ""
            ipAddress = "10.0.1.1"
            linkProperties = {
              linkProviderName = ""
              linkSpeedInMbps  = 0
            }
          }
        },
        {
          name = "link2"
          properties = {
            fqdn      = ""
            ipAddress = "10.0.1.2"
            linkProperties = {
              linkProviderName = ""
              linkSpeedInMbps  = 0
            }
          }
        },
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}