1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. VirtualWan
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi

azure-native.network.VirtualWan

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi

    VirtualWAN Resource. Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2020-11-01.

    Other available API versions: 2019-07-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01.

    Example Usage

    VirtualWANCreate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var virtualWan = new AzureNative.Network.VirtualWan("virtualWan", new()
        {
            DisableVpnEncryption = false,
            Location = "West US",
            ResourceGroupName = "rg1",
            Tags = 
            {
                { "key1", "value1" },
            },
            Type = "Basic",
            VirtualWANName = "wan1",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/network/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := network.NewVirtualWan(ctx, "virtualWan", &network.VirtualWanArgs{
    			DisableVpnEncryption: pulumi.Bool(false),
    			Location:             pulumi.String("West US"),
    			ResourceGroupName:    pulumi.String("rg1"),
    			Tags: pulumi.StringMap{
    				"key1": pulumi.String("value1"),
    			},
    			Type:           pulumi.String("Basic"),
    			VirtualWANName: pulumi.String("wan1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.network.VirtualWan;
    import com.pulumi.azurenative.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 virtualWan = new VirtualWan("virtualWan", VirtualWanArgs.builder()        
                .disableVpnEncryption(false)
                .location("West US")
                .resourceGroupName("rg1")
                .tags(Map.of("key1", "value1"))
                .type("Basic")
                .virtualWANName("wan1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    virtual_wan = azure_native.network.VirtualWan("virtualWan",
        disable_vpn_encryption=False,
        location="West US",
        resource_group_name="rg1",
        tags={
            "key1": "value1",
        },
        type="Basic",
        virtual_wan_name="wan1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const virtualWan = new azure_native.network.VirtualWan("virtualWan", {
        disableVpnEncryption: false,
        location: "West US",
        resourceGroupName: "rg1",
        tags: {
            key1: "value1",
        },
        type: "Basic",
        virtualWANName: "wan1",
    });
    
    resources:
      virtualWan:
        type: azure-native:network:VirtualWan
        properties:
          disableVpnEncryption: false
          location: West US
          resourceGroupName: rg1
          tags:
            key1: value1
          type: Basic
          virtualWANName: wan1
    

    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,
                   allow_vnet_to_vnet_traffic: Optional[bool] = None,
                   disable_vpn_encryption: Optional[bool] = None,
                   id: Optional[str] = None,
                   location: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   type: Optional[str] = None,
                   virtual_wan_name: 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-native: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.

    Example

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

    var virtualWanResource = new AzureNative.Network.VirtualWan("virtualWanResource", new()
    {
        ResourceGroupName = "string",
        AllowBranchToBranchTraffic = false,
        AllowVnetToVnetTraffic = false,
        DisableVpnEncryption = false,
        Id = "string",
        Location = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Type = "string",
        VirtualWANName = "string",
    });
    
    example, err := network.NewVirtualWan(ctx, "virtualWanResource", &network.VirtualWanArgs{
    ResourceGroupName: pulumi.String("string"),
    AllowBranchToBranchTraffic: pulumi.Bool(false),
    AllowVnetToVnetTraffic: pulumi.Bool(false),
    DisableVpnEncryption: pulumi.Bool(false),
    Id: pulumi.String("string"),
    Location: pulumi.String("string"),
    Tags: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    Type: pulumi.String("string"),
    VirtualWANName: pulumi.String("string"),
    })
    
    var virtualWanResource = new VirtualWan("virtualWanResource", VirtualWanArgs.builder()        
        .resourceGroupName("string")
        .allowBranchToBranchTraffic(false)
        .allowVnetToVnetTraffic(false)
        .disableVpnEncryption(false)
        .id("string")
        .location("string")
        .tags(Map.of("string", "string"))
        .type("string")
        .virtualWANName("string")
        .build());
    
    virtual_wan_resource = azure_native.network.VirtualWan("virtualWanResource",
        resource_group_name="string",
        allow_branch_to_branch_traffic=False,
        allow_vnet_to_vnet_traffic=False,
        disable_vpn_encryption=False,
        id="string",
        location="string",
        tags={
            "string": "string",
        },
        type="string",
        virtual_wan_name="string")
    
    const virtualWanResource = new azure_native.network.VirtualWan("virtualWanResource", {
        resourceGroupName: "string",
        allowBranchToBranchTraffic: false,
        allowVnetToVnetTraffic: false,
        disableVpnEncryption: false,
        id: "string",
        location: "string",
        tags: {
            string: "string",
        },
        type: "string",
        virtualWANName: "string",
    });
    
    type: azure-native:network:VirtualWan
    properties:
        allowBranchToBranchTraffic: false
        allowVnetToVnetTraffic: false
        disableVpnEncryption: false
        id: string
        location: string
        resourceGroupName: string
        tags:
            string: string
        type: string
        virtualWANName: 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

    The VirtualWan resource accepts the following input properties:

    ResourceGroupName string
    The resource group name of the VirtualWan.
    AllowBranchToBranchTraffic bool
    True if branch to branch traffic is allowed.
    AllowVnetToVnetTraffic bool
    True if Vnet to Vnet traffic is allowed.
    DisableVpnEncryption bool
    Vpn encryption to be disabled or not.
    Id string
    Resource ID.
    Location string
    Resource location.
    Tags Dictionary<string, string>
    Resource tags.
    Type string
    The type of the VirtualWAN.
    VirtualWANName string
    The name of the VirtualWAN being created or updated.
    ResourceGroupName string
    The resource group name of the VirtualWan.
    AllowBranchToBranchTraffic bool
    True if branch to branch traffic is allowed.
    AllowVnetToVnetTraffic bool
    True if Vnet to Vnet traffic is allowed.
    DisableVpnEncryption bool
    Vpn encryption to be disabled or not.
    Id string
    Resource ID.
    Location string
    Resource location.
    Tags map[string]string
    Resource tags.
    Type string
    The type of the VirtualWAN.
    VirtualWANName string
    The name of the VirtualWAN being created or updated.
    resourceGroupName String
    The resource group name of the VirtualWan.
    allowBranchToBranchTraffic Boolean
    True if branch to branch traffic is allowed.
    allowVnetToVnetTraffic Boolean
    True if Vnet to Vnet traffic is allowed.
    disableVpnEncryption Boolean
    Vpn encryption to be disabled or not.
    id String
    Resource ID.
    location String
    Resource location.
    tags Map<String,String>
    Resource tags.
    type String
    The type of the VirtualWAN.
    virtualWANName String
    The name of the VirtualWAN being created or updated.
    resourceGroupName string
    The resource group name of the VirtualWan.
    allowBranchToBranchTraffic boolean
    True if branch to branch traffic is allowed.
    allowVnetToVnetTraffic boolean
    True if Vnet to Vnet traffic is allowed.
    disableVpnEncryption boolean
    Vpn encryption to be disabled or not.
    id string
    Resource ID.
    location string
    Resource location.
    tags {[key: string]: string}
    Resource tags.
    type string
    The type of the VirtualWAN.
    virtualWANName string
    The name of the VirtualWAN being created or updated.
    resource_group_name str
    The resource group name of the VirtualWan.
    allow_branch_to_branch_traffic bool
    True if branch to branch traffic is allowed.
    allow_vnet_to_vnet_traffic bool
    True if Vnet to Vnet traffic is allowed.
    disable_vpn_encryption bool
    Vpn encryption to be disabled or not.
    id str
    Resource ID.
    location str
    Resource location.
    tags Mapping[str, str]
    Resource tags.
    type str
    The type of the VirtualWAN.
    virtual_wan_name str
    The name of the VirtualWAN being created or updated.
    resourceGroupName String
    The resource group name of the VirtualWan.
    allowBranchToBranchTraffic Boolean
    True if branch to branch traffic is allowed.
    allowVnetToVnetTraffic Boolean
    True if Vnet to Vnet traffic is allowed.
    disableVpnEncryption Boolean
    Vpn encryption to be disabled or not.
    id String
    Resource ID.
    location String
    Resource location.
    tags Map<String>
    Resource tags.
    type String
    The type of the VirtualWAN.
    virtualWANName String
    The name of the VirtualWAN being created or updated.

    Outputs

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

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    Office365LocalBreakoutCategory string
    The office local breakout category.
    ProvisioningState string
    The provisioning state of the virtual WAN resource.
    VirtualHubs List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
    List of VirtualHubs in the VirtualWAN.
    VpnSites List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
    List of VpnSites in the VirtualWAN.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    Office365LocalBreakoutCategory string
    The office local breakout category.
    ProvisioningState string
    The provisioning state of the virtual WAN resource.
    VirtualHubs []SubResourceResponse
    List of VirtualHubs in the VirtualWAN.
    VpnSites []SubResourceResponse
    List of VpnSites in the VirtualWAN.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    office365LocalBreakoutCategory String
    The office local breakout category.
    provisioningState String
    The provisioning state of the virtual WAN resource.
    virtualHubs List<SubResourceResponse>
    List of VirtualHubs in the VirtualWAN.
    vpnSites List<SubResourceResponse>
    List of VpnSites in the VirtualWAN.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name.
    office365LocalBreakoutCategory string
    The office local breakout category.
    provisioningState string
    The provisioning state of the virtual WAN resource.
    virtualHubs SubResourceResponse[]
    List of VirtualHubs in the VirtualWAN.
    vpnSites SubResourceResponse[]
    List of VpnSites in the VirtualWAN.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name.
    office365_local_breakout_category str
    The office local breakout category.
    provisioning_state str
    The provisioning state of the virtual WAN resource.
    virtual_hubs Sequence[SubResourceResponse]
    List of VirtualHubs in the VirtualWAN.
    vpn_sites Sequence[SubResourceResponse]
    List of VpnSites in the VirtualWAN.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    office365LocalBreakoutCategory String
    The office local breakout category.
    provisioningState String
    The provisioning state of the virtual WAN resource.
    virtualHubs List<Property Map>
    List of VirtualHubs in the VirtualWAN.
    vpnSites List<Property Map>
    List of VpnSites in the VirtualWAN.

    Supporting Types

    SubResourceResponse, SubResourceResponseArgs

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:network:VirtualWan wan1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi