Microsoft.Network virtualWans 2022-07-01

• Latest
• 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

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/virtualWans@2022-07-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    allowBranchToBranchTraffic: bool
    allowVnetToVnetTraffic: bool
    disableVpnEncryption: bool
    type: 'string'
  }
}

Property values

virtualWans

Name	Description	Value
name	The resource name	string (required) Character limit: 1-80 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. End alphanumeric or underscore.
location	Resource location.	string
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
properties	Properties of the virtual WAN.	VirtualWanProperties

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
Secured virtual hubs	This template creates a secured virtual hub using Azure Firewall to secure your cloud network traffic destined to the Internet.
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.
Azure Virtual WAN Routing Intent and Policies	This template provisions an Azure Virtual WAN with two hubs with Routing Intent and Policies feature enabled.
Azure Virtual WAN (vWAN) Multi-Hub Deployment	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	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.

ARM template resource definition

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

{
  "type": "Microsoft.Network/virtualWans",
  "apiVersion": "2022-07-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "allowBranchToBranchTraffic": "bool",
    "allowVnetToVnetTraffic": "bool",
    "disableVpnEncryption": "bool",
    "type": "string"
  }
}

Property values

virtualWans

Name	Description	Value
type	The resource type	'Microsoft.Network/virtualWans'
apiVersion	The resource api version	'2022-07-01'
name	The resource name	string (required) Character limit: 1-80 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. End alphanumeric or underscore.
location	Resource location.	string
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
properties	Properties of the virtual WAN.	VirtualWanProperties

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
Secured virtual hubs	This template creates a secured virtual hub using Azure Firewall to secure your cloud network traffic destined to the Internet.
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.
Azure Virtual WAN Routing Intent and Policies	This template provisions an Azure Virtual WAN with two hubs with Routing Intent and Policies feature enabled.
Azure Virtual WAN (vWAN) Multi-Hub Deployment	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	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.

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@2022-07-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      allowBranchToBranchTraffic = bool
      allowVnetToVnetTraffic = bool
      disableVpnEncryption = bool
      type = "string"
    }
  })
}

Property values

virtualWans

Name	Description	Value
type	The resource type	"Microsoft.Network/virtualWans@2022-07-01"
name	The resource name	string (required) Character limit: 1-80 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. End alphanumeric or underscore.
location	Resource location.	string
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags.	Dictionary of tag names and values.
properties	Properties of the virtual WAN.	VirtualWanProperties

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