Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. VirtualWan

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.network.VirtualWan

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

    Manages a Virtual WAN.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleVirtualWan = new azure.network.VirtualWan("example", {
    name: "example-vwan",
    resourceGroupName: example.name,
    location: example.location,
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_virtual_wan = azure.network.VirtualWan("example",
    name="example-vwan",
    resource_group_name=example.name,
    location=example.location)

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = network.NewVirtualWan(ctx, "example", &network.VirtualWanArgs{
			Name:              pulumi.String("example-vwan"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleVirtualWan = new Azure.Network.VirtualWan("example", new()
    {
        Name = "example-vwan",
        ResourceGroupName = example.Name,
        Location = example.Location,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualWan;
import com.pulumi.azure.network.VirtualWanArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleVirtualWan = new VirtualWan("exampleVirtualWan", VirtualWanArgs.builder()
            .name("example-vwan")
            .resourceGroupName(example.name())
            .location(example.location())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleVirtualWan:
    type: azure:network:VirtualWan
    name: example
    properties:
      name: example-vwan
      resourceGroupName: ${example.name}
      location: ${example.location}

    Create VirtualWan Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VirtualWan(name: string, args: VirtualWanArgs, opts?: CustomResourceOptions);
    @overload
def VirtualWan(resource_name: str,
               args: VirtualWanArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def VirtualWan(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               resource_group_name: Optional[str] = None,
               allow_branch_to_branch_traffic: Optional[bool] = None,
               disable_vpn_encryption: Optional[bool] = None,
               location: Optional[str] = None,
               name: Optional[str] = None,
               office365_local_breakout_category: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               type: Optional[str] = None)
    func NewVirtualWan(ctx *Context, name string, args VirtualWanArgs, opts ...ResourceOption) (*VirtualWan, error)
    public VirtualWan(string name, VirtualWanArgs args, CustomResourceOptions? opts = null)
    public VirtualWan(String name, VirtualWanArgs args)
public VirtualWan(String name, VirtualWanArgs args, CustomResourceOptions options)

    type: azure:network:VirtualWan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VirtualWanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VirtualWanArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VirtualWanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualWanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualWanArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var virtualWanResource = new Azure.Network.VirtualWan("virtualWanResource", new()
{
    ResourceGroupName = "string",
    AllowBranchToBranchTraffic = false,
    DisableVpnEncryption = false,
    Location = "string",
    Name = "string",
    Office365LocalBreakoutCategory = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Type = "string",
});

    example, err := network.NewVirtualWan(ctx, "virtualWanResource", &network.VirtualWanArgs{
	ResourceGroupName:              pulumi.String("string"),
	AllowBranchToBranchTraffic:     pulumi.Bool(false),
	DisableVpnEncryption:           pulumi.Bool(false),
	Location:                       pulumi.String("string"),
	Name:                           pulumi.String("string"),
	Office365LocalBreakoutCategory: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Type: pulumi.String("string"),
})

    var virtualWanResource = new VirtualWan("virtualWanResource", VirtualWanArgs.builder()
    .resourceGroupName("string")
    .allowBranchToBranchTraffic(false)
    .disableVpnEncryption(false)
    .location("string")
    .name("string")
    .office365LocalBreakoutCategory("string")
    .tags(Map.of("string", "string"))
    .type("string")
    .build());

    virtual_wan_resource = azure.network.VirtualWan("virtualWanResource",
    resource_group_name="string",
    allow_branch_to_branch_traffic=False,
    disable_vpn_encryption=False,
    location="string",
    name="string",
    office365_local_breakout_category="string",
    tags={
        "string": "string",
    },
    type="string")

    const virtualWanResource = new azure.network.VirtualWan("virtualWanResource", {
    resourceGroupName: "string",
    allowBranchToBranchTraffic: false,
    disableVpnEncryption: false,
    location: "string",
    name: "string",
    office365LocalBreakoutCategory: "string",
    tags: {
        string: "string",
    },
    type: "string",
});

    type: azure:network:VirtualWan
properties:
    allowBranchToBranchTraffic: false
    disableVpnEncryption: false
    location: string
    name: string
    office365LocalBreakoutCategory: string
    resourceGroupName: string
    tags:
        string: string
    type: string

    VirtualWan Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VirtualWan resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group in which to create the Virtual WAN. Changing this forces a new resource to be created.
    AllowBranchToBranchTraffic bool
    Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.
    DisableVpnEncryption bool
    Boolean flag to specify whether VPN encryption is disabled. Defaults to false.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Virtual WAN. Changing this forces a new resource to be created.
    Office365LocalBreakoutCategory string
    Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the Virtual WAN.
    Type string
    Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.
    ResourceGroupName string
    The name of the resource group in which to create the Virtual WAN. Changing this forces a new resource to be created.
    AllowBranchToBranchTraffic bool
    Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.
    DisableVpnEncryption bool
    Boolean flag to specify whether VPN encryption is disabled. Defaults to false.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Virtual WAN. Changing this forces a new resource to be created.
    Office365LocalBreakoutCategory string
    Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.
    Tags map[string]string
    A mapping of tags to assign to the Virtual WAN.
    Type string
    Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.
    resourceGroupName String
    The name of the resource group in which to create the Virtual WAN. Changing this forces a new resource to be created.
    allowBranchToBranchTraffic Boolean
    Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.
    disableVpnEncryption Boolean
    Boolean flag to specify whether VPN encryption is disabled. Defaults to false.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Virtual WAN. Changing this forces a new resource to be created.
    office365LocalBreakoutCategory String
    Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.
    tags Map<String,String>
    A mapping of tags to assign to the Virtual WAN.
    type String
    Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.
    resourceGroupName string
    The name of the resource group in which to create the Virtual WAN. Changing this forces a new resource to be created.
    allowBranchToBranchTraffic boolean
    Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.
    disableVpnEncryption boolean
    Boolean flag to specify whether VPN encryption is disabled. Defaults to false.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of the Virtual WAN. Changing this forces a new resource to be created.
    office365LocalBreakoutCategory string
    Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.
    tags {[key: string]: string}
    A mapping of tags to assign to the Virtual WAN.
    type string
    Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.
    resource_group_name str
    The name of the resource group in which to create the Virtual WAN. Changing this forces a new resource to be created.
    allow_branch_to_branch_traffic bool
    Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.
    disable_vpn_encryption bool
    Boolean flag to specify whether VPN encryption is disabled. Defaults to false.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of the Virtual WAN. Changing this forces a new resource to be created.
    office365_local_breakout_category str
    Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.
    tags Mapping[str, str]
    A mapping of tags to assign to the Virtual WAN.
    type str
    Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.
    resourceGroupName String
    The name of the resource group in which to create the Virtual WAN. Changing this forces a new resource to be created.
    allowBranchToBranchTraffic Boolean
    Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.
    disableVpnEncryption Boolean
    Boolean flag to specify whether VPN encryption is disabled. Defaults to false.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Virtual WAN. Changing this forces a new resource to be created.
    office365LocalBreakoutCategory String
    Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.
    tags Map<String>
    A mapping of tags to assign to the Virtual WAN.
    type String
    Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VirtualWan resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VirtualWan Resource

    Get an existing VirtualWan resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VirtualWanState, opts?: CustomResourceOptions): VirtualWan
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_branch_to_branch_traffic: Optional[bool] = None,
        disable_vpn_encryption: Optional[bool] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        office365_local_breakout_category: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        type: Optional[str] = None) -> VirtualWan
    func GetVirtualWan(ctx *Context, name string, id IDInput, state *VirtualWanState, opts ...ResourceOption) (*VirtualWan, error)
    public static VirtualWan Get(string name, Input<string> id, VirtualWanState? state, CustomResourceOptions? opts = null)
    public static VirtualWan get(String name, Output<String> id, VirtualWanState state, CustomResourceOptions options)
    resources:  _:    type: azure:network:VirtualWan    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowBranchToBranchTraffic bool
    Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.
    DisableVpnEncryption bool
    Boolean flag to specify whether VPN encryption is disabled. Defaults to false.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Virtual WAN. Changing this forces a new resource to be created.
    Office365LocalBreakoutCategory string
    Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.
    ResourceGroupName string
    The name of the resource group in which to create the Virtual WAN. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the Virtual WAN.
    Type string
    Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.
    AllowBranchToBranchTraffic bool
    Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.
    DisableVpnEncryption bool
    Boolean flag to specify whether VPN encryption is disabled. Defaults to false.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Virtual WAN. Changing this forces a new resource to be created.
    Office365LocalBreakoutCategory string
    Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.
    ResourceGroupName string
    The name of the resource group in which to create the Virtual WAN. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the Virtual WAN.
    Type string
    Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.
    allowBranchToBranchTraffic Boolean
    Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.
    disableVpnEncryption Boolean
    Boolean flag to specify whether VPN encryption is disabled. Defaults to false.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Virtual WAN. Changing this forces a new resource to be created.
    office365LocalBreakoutCategory String
    Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.
    resourceGroupName String
    The name of the resource group in which to create the Virtual WAN. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the Virtual WAN.
    type String
    Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.
    allowBranchToBranchTraffic boolean
    Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.
    disableVpnEncryption boolean
    Boolean flag to specify whether VPN encryption is disabled. Defaults to false.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of the Virtual WAN. Changing this forces a new resource to be created.
    office365LocalBreakoutCategory string
    Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.
    resourceGroupName string
    The name of the resource group in which to create the Virtual WAN. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the Virtual WAN.
    type string
    Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.
    allow_branch_to_branch_traffic bool
    Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.
    disable_vpn_encryption bool
    Boolean flag to specify whether VPN encryption is disabled. Defaults to false.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of the Virtual WAN. Changing this forces a new resource to be created.
    office365_local_breakout_category str
    Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.
    resource_group_name str
    The name of the resource group in which to create the Virtual WAN. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the Virtual WAN.
    type str
    Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.
    allowBranchToBranchTraffic Boolean
    Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.
    disableVpnEncryption Boolean
    Boolean flag to specify whether VPN encryption is disabled. Defaults to false.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Virtual WAN. Changing this forces a new resource to be created.
    office365LocalBreakoutCategory String
    Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.
    resourceGroupName String
    The name of the resource group in which to create the Virtual WAN. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the Virtual WAN.
    type String
    Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.

    Import

    Virtual WAN can be imported using the resource id, e.g.

    $ pulumi import azure:network/virtualWan:VirtualWan example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/virtualWans/testvwan

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
    pulumi/pulumi-azure