Microsoft.Network virtualWans 2021-05-01

Bicep resource definition

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

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

Resource format

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

resource symbolicname 'Microsoft.Network/virtualWans@2021-05-01' = {
  location: 'string'
  name: 'string'
  properties: {
    allowBranchToBranchTraffic: bool
    allowVnetToVnetTraffic: bool
    disableVpnEncryption: bool
    type: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

Microsoft.Network/virtualWans

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

ResourceTags

Name Description Value

VirtualWanProperties

Name Description Value
allowBranchToBranchTraffic True if branch to branch traffic is allowed. bool
allowVnetToVnetTraffic True if Vnet to Vnet traffic is allowed. bool
disableVpnEncryption Vpn encryption to be disabled or not. bool
type The type of the VirtualWAN. string

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.
Secured virtual hubs This template creates a secured virtual hub using Azure Firewall to secure your cloud network traffic destined to the Internet.

ARM template resource definition

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

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

Resource format

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

{
  "type": "Microsoft.Network/virtualWans",
  "apiVersion": "2021-05-01",
  "name": "string",
  "location": "string",
  "properties": {
    "allowBranchToBranchTraffic": "bool",
    "allowVnetToVnetTraffic": "bool",
    "disableVpnEncryption": "bool",
    "type": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

Microsoft.Network/virtualWans

Name Description Value
apiVersion The api version '2021-05-01'
location Resource location. string
name The resource name string (required)
properties Properties of the virtual WAN. VirtualWanProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Network/virtualWans'

ResourceTags

Name Description Value

VirtualWanProperties

Name Description Value
allowBranchToBranchTraffic True if branch to branch traffic is allowed. bool
allowVnetToVnetTraffic True if Vnet to Vnet traffic is allowed. bool
disableVpnEncryption Vpn encryption to be disabled or not. bool
type The type of the VirtualWAN. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Virtual WAN (vWAN) Multi-Hub Deployment

Deploy to Azure
This template allows you to create an Azure Virtual WAN (vWAN) multi-hub deployment including all gateways and VNET connections.
Azure vWAN Multi-Hub Deployment with Custom Routing Tables

Deploy to Azure
This template allows you to create an Azure Virtual WAN (vWAN) multi-hub deployment, including all gateways and VNET connections, and demonstrate the usage of Route Tables for custom routing.
Creates Virtual WAN resources

Deploy to Azure
This template allows you to create virtual WAN resources including Virtual WAN, Virtual Hub, VPN Gateway, VPN Site and a VPN Connecton.
Secured virtual hubs

Deploy to Azure
This template creates a secured virtual hub using Azure Firewall to secure your cloud network traffic destined to the Internet.
vWAN P2S deployment with multi address pool and user groups

Deploy to Azure
This template deploys Azure Virtual WAN (vWAN) with a P2S configured with multiple address pool and user groups

Terraform (AzAPI provider) resource definition

The virtualWans 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/virtualWans resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualWans@2021-05-01"
  name = "string"
  location = "string"
  body = jsonencode({
    properties = {
      allowBranchToBranchTraffic = bool
      allowVnetToVnetTraffic = bool
      disableVpnEncryption = bool
      type = "string"
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

Microsoft.Network/virtualWans

Name Description Value
location Resource location. string
name The resource name string (required)
properties Properties of the virtual WAN. VirtualWanProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Network/virtualWans@2021-05-01"

ResourceTags

Name Description Value

VirtualWanProperties

Name Description Value
allowBranchToBranchTraffic True if branch to branch traffic is allowed. bool
allowVnetToVnetTraffic True if Vnet to Vnet traffic is allowed. bool
disableVpnEncryption Vpn encryption to be disabled or not. bool
type The type of the VirtualWAN. string