1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. VpnSite

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

azure.network.VpnSite

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Manages a VPN Site.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-rg",
        location: "West Europe",
    });
    const exampleVirtualWan = new azure.network.VirtualWan("example", {
        name: "example-vwan",
        resourceGroupName: example.name,
        location: example.location,
    });
    const exampleVpnSite = new azure.network.VpnSite("example", {
        name: "site1",
        resourceGroupName: example.name,
        location: example.location,
        virtualWanId: exampleVirtualWan.id,
        addressCidrs: ["10.0.0.0/24"],
        links: [{
            name: "link1",
            ipAddress: "10.0.0.1",
        }],
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-rg",
        location="West Europe")
    example_virtual_wan = azure.network.VirtualWan("example",
        name="example-vwan",
        resource_group_name=example.name,
        location=example.location)
    example_vpn_site = azure.network.VpnSite("example",
        name="site1",
        resource_group_name=example.name,
        location=example.location,
        virtual_wan_id=example_virtual_wan.id,
        address_cidrs=["10.0.0.0/24"],
        links=[{
            "name": "link1",
            "ipAddress": "10.0.0.1",
        }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/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-rg"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleVirtualWan, err := network.NewVirtualWan(ctx, "example", &network.VirtualWanArgs{
    			Name:              pulumi.String("example-vwan"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = network.NewVpnSite(ctx, "example", &network.VpnSiteArgs{
    			Name:              pulumi.String("site1"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    			VirtualWanId:      exampleVirtualWan.ID(),
    			AddressCidrs: pulumi.StringArray{
    				pulumi.String("10.0.0.0/24"),
    			},
    			Links: network.VpnSiteLinkArray{
    				&network.VpnSiteLinkArgs{
    					Name:      pulumi.String("link1"),
    					IpAddress: pulumi.String("10.0.0.1"),
    				},
    			},
    		})
    		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-rg",
            Location = "West Europe",
        });
    
        var exampleVirtualWan = new Azure.Network.VirtualWan("example", new()
        {
            Name = "example-vwan",
            ResourceGroupName = example.Name,
            Location = example.Location,
        });
    
        var exampleVpnSite = new Azure.Network.VpnSite("example", new()
        {
            Name = "site1",
            ResourceGroupName = example.Name,
            Location = example.Location,
            VirtualWanId = exampleVirtualWan.Id,
            AddressCidrs = new[]
            {
                "10.0.0.0/24",
            },
            Links = new[]
            {
                new Azure.Network.Inputs.VpnSiteLinkArgs
                {
                    Name = "link1",
                    IpAddress = "10.0.0.1",
                },
            },
        });
    
    });
    
    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 com.pulumi.azure.network.VpnSite;
    import com.pulumi.azure.network.VpnSiteArgs;
    import com.pulumi.azure.network.inputs.VpnSiteLinkArgs;
    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-rg")
                .location("West Europe")
                .build());
    
            var exampleVirtualWan = new VirtualWan("exampleVirtualWan", VirtualWanArgs.builder()
                .name("example-vwan")
                .resourceGroupName(example.name())
                .location(example.location())
                .build());
    
            var exampleVpnSite = new VpnSite("exampleVpnSite", VpnSiteArgs.builder()
                .name("site1")
                .resourceGroupName(example.name())
                .location(example.location())
                .virtualWanId(exampleVirtualWan.id())
                .addressCidrs("10.0.0.0/24")
                .links(VpnSiteLinkArgs.builder()
                    .name("link1")
                    .ipAddress("10.0.0.1")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-rg
          location: West Europe
      exampleVirtualWan:
        type: azure:network:VirtualWan
        name: example
        properties:
          name: example-vwan
          resourceGroupName: ${example.name}
          location: ${example.location}
      exampleVpnSite:
        type: azure:network:VpnSite
        name: example
        properties:
          name: site1
          resourceGroupName: ${example.name}
          location: ${example.location}
          virtualWanId: ${exampleVirtualWan.id}
          addressCidrs:
            - 10.0.0.0/24
          links:
            - name: link1
              ipAddress: 10.0.0.1
    

    Create VpnSite Resource

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

    Constructor syntax

    new VpnSite(name: string, args: VpnSiteArgs, opts?: CustomResourceOptions);
    @overload
    def VpnSite(resource_name: str,
                args: VpnSiteArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def VpnSite(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                resource_group_name: Optional[str] = None,
                virtual_wan_id: Optional[str] = None,
                address_cidrs: Optional[Sequence[str]] = None,
                device_model: Optional[str] = None,
                device_vendor: Optional[str] = None,
                links: Optional[Sequence[VpnSiteLinkArgs]] = None,
                location: Optional[str] = None,
                name: Optional[str] = None,
                o365_policy: Optional[VpnSiteO365PolicyArgs] = None,
                tags: Optional[Mapping[str, str]] = None)
    func NewVpnSite(ctx *Context, name string, args VpnSiteArgs, opts ...ResourceOption) (*VpnSite, error)
    public VpnSite(string name, VpnSiteArgs args, CustomResourceOptions? opts = null)
    public VpnSite(String name, VpnSiteArgs args)
    public VpnSite(String name, VpnSiteArgs args, CustomResourceOptions options)
    
    type: azure:network:VpnSite
    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 VpnSiteArgs
    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 VpnSiteArgs
    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 VpnSiteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpnSiteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpnSiteArgs
    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 vpnSiteResource = new Azure.Network.VpnSite("vpnSiteResource", new()
    {
        ResourceGroupName = "string",
        VirtualWanId = "string",
        AddressCidrs = new[]
        {
            "string",
        },
        DeviceModel = "string",
        DeviceVendor = "string",
        Links = new[]
        {
            new Azure.Network.Inputs.VpnSiteLinkArgs
            {
                Name = "string",
                Bgp = new Azure.Network.Inputs.VpnSiteLinkBgpArgs
                {
                    Asn = 0,
                    PeeringAddress = "string",
                },
                Fqdn = "string",
                Id = "string",
                IpAddress = "string",
                ProviderName = "string",
                SpeedInMbps = 0,
            },
        },
        Location = "string",
        Name = "string",
        O365Policy = new Azure.Network.Inputs.VpnSiteO365PolicyArgs
        {
            TrafficCategory = new Azure.Network.Inputs.VpnSiteO365PolicyTrafficCategoryArgs
            {
                AllowEndpointEnabled = false,
                DefaultEndpointEnabled = false,
                OptimizeEndpointEnabled = false,
            },
        },
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := network.NewVpnSite(ctx, "vpnSiteResource", &network.VpnSiteArgs{
    	ResourceGroupName: pulumi.String("string"),
    	VirtualWanId:      pulumi.String("string"),
    	AddressCidrs: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DeviceModel:  pulumi.String("string"),
    	DeviceVendor: pulumi.String("string"),
    	Links: network.VpnSiteLinkArray{
    		&network.VpnSiteLinkArgs{
    			Name: pulumi.String("string"),
    			Bgp: &network.VpnSiteLinkBgpArgs{
    				Asn:            pulumi.Int(0),
    				PeeringAddress: pulumi.String("string"),
    			},
    			Fqdn:         pulumi.String("string"),
    			Id:           pulumi.String("string"),
    			IpAddress:    pulumi.String("string"),
    			ProviderName: pulumi.String("string"),
    			SpeedInMbps:  pulumi.Int(0),
    		},
    	},
    	Location: pulumi.String("string"),
    	Name:     pulumi.String("string"),
    	O365Policy: &network.VpnSiteO365PolicyArgs{
    		TrafficCategory: &network.VpnSiteO365PolicyTrafficCategoryArgs{
    			AllowEndpointEnabled:    pulumi.Bool(false),
    			DefaultEndpointEnabled:  pulumi.Bool(false),
    			OptimizeEndpointEnabled: pulumi.Bool(false),
    		},
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var vpnSiteResource = new VpnSite("vpnSiteResource", VpnSiteArgs.builder()
        .resourceGroupName("string")
        .virtualWanId("string")
        .addressCidrs("string")
        .deviceModel("string")
        .deviceVendor("string")
        .links(VpnSiteLinkArgs.builder()
            .name("string")
            .bgp(VpnSiteLinkBgpArgs.builder()
                .asn(0)
                .peeringAddress("string")
                .build())
            .fqdn("string")
            .id("string")
            .ipAddress("string")
            .providerName("string")
            .speedInMbps(0)
            .build())
        .location("string")
        .name("string")
        .o365Policy(VpnSiteO365PolicyArgs.builder()
            .trafficCategory(VpnSiteO365PolicyTrafficCategoryArgs.builder()
                .allowEndpointEnabled(false)
                .defaultEndpointEnabled(false)
                .optimizeEndpointEnabled(false)
                .build())
            .build())
        .tags(Map.of("string", "string"))
        .build());
    
    vpn_site_resource = azure.network.VpnSite("vpnSiteResource",
        resource_group_name="string",
        virtual_wan_id="string",
        address_cidrs=["string"],
        device_model="string",
        device_vendor="string",
        links=[{
            "name": "string",
            "bgp": {
                "asn": 0,
                "peeringAddress": "string",
            },
            "fqdn": "string",
            "id": "string",
            "ipAddress": "string",
            "providerName": "string",
            "speedInMbps": 0,
        }],
        location="string",
        name="string",
        o365_policy={
            "trafficCategory": {
                "allowEndpointEnabled": False,
                "defaultEndpointEnabled": False,
                "optimizeEndpointEnabled": False,
            },
        },
        tags={
            "string": "string",
        })
    
    const vpnSiteResource = new azure.network.VpnSite("vpnSiteResource", {
        resourceGroupName: "string",
        virtualWanId: "string",
        addressCidrs: ["string"],
        deviceModel: "string",
        deviceVendor: "string",
        links: [{
            name: "string",
            bgp: {
                asn: 0,
                peeringAddress: "string",
            },
            fqdn: "string",
            id: "string",
            ipAddress: "string",
            providerName: "string",
            speedInMbps: 0,
        }],
        location: "string",
        name: "string",
        o365Policy: {
            trafficCategory: {
                allowEndpointEnabled: false,
                defaultEndpointEnabled: false,
                optimizeEndpointEnabled: false,
            },
        },
        tags: {
            string: "string",
        },
    });
    
    type: azure:network:VpnSite
    properties:
        addressCidrs:
            - string
        deviceModel: string
        deviceVendor: string
        links:
            - bgp:
                asn: 0
                peeringAddress: string
              fqdn: string
              id: string
              ipAddress: string
              name: string
              providerName: string
              speedInMbps: 0
        location: string
        name: string
        o365Policy:
            trafficCategory:
                allowEndpointEnabled: false
                defaultEndpointEnabled: false
                optimizeEndpointEnabled: false
        resourceGroupName: string
        tags:
            string: string
        virtualWanId: string
    

    VpnSite 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 VpnSite resource accepts the following input properties:

    ResourceGroupName string
    The name of the Resource Group where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    VirtualWanId string
    The ID of the Virtual Wan where this VPN site resides in. Changing this forces a new VPN Site to be created.
    AddressCidrs List<string>

    Specifies a list of IP address CIDRs that are located on your on-premises site. Traffic destined for these address spaces is routed to your local site.

    NOTE: The address_cidrs has to be set when the link.bgp isn't specified.

    DeviceModel string
    The model of the VPN device.
    DeviceVendor string
    The name of the VPN device vendor.
    Links List<VpnSiteLink>
    One or more link blocks as defined below.
    Location string
    The Azure Region where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    Name string
    The name which should be used for this VPN Site. Changing this forces a new VPN Site to be created.
    O365Policy VpnSiteO365Policy
    An o365_policy block as defined below.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the VPN Site.
    ResourceGroupName string
    The name of the Resource Group where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    VirtualWanId string
    The ID of the Virtual Wan where this VPN site resides in. Changing this forces a new VPN Site to be created.
    AddressCidrs []string

    Specifies a list of IP address CIDRs that are located on your on-premises site. Traffic destined for these address spaces is routed to your local site.

    NOTE: The address_cidrs has to be set when the link.bgp isn't specified.

    DeviceModel string
    The model of the VPN device.
    DeviceVendor string
    The name of the VPN device vendor.
    Links []VpnSiteLinkArgs
    One or more link blocks as defined below.
    Location string
    The Azure Region where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    Name string
    The name which should be used for this VPN Site. Changing this forces a new VPN Site to be created.
    O365Policy VpnSiteO365PolicyArgs
    An o365_policy block as defined below.
    Tags map[string]string
    A mapping of tags which should be assigned to the VPN Site.
    resourceGroupName String
    The name of the Resource Group where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    virtualWanId String
    The ID of the Virtual Wan where this VPN site resides in. Changing this forces a new VPN Site to be created.
    addressCidrs List<String>

    Specifies a list of IP address CIDRs that are located on your on-premises site. Traffic destined for these address spaces is routed to your local site.

    NOTE: The address_cidrs has to be set when the link.bgp isn't specified.

    deviceModel String
    The model of the VPN device.
    deviceVendor String
    The name of the VPN device vendor.
    links List<VpnSiteLink>
    One or more link blocks as defined below.
    location String
    The Azure Region where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    name String
    The name which should be used for this VPN Site. Changing this forces a new VPN Site to be created.
    o365Policy VpnSiteO365Policy
    An o365_policy block as defined below.
    tags Map<String,String>
    A mapping of tags which should be assigned to the VPN Site.
    resourceGroupName string
    The name of the Resource Group where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    virtualWanId string
    The ID of the Virtual Wan where this VPN site resides in. Changing this forces a new VPN Site to be created.
    addressCidrs string[]

    Specifies a list of IP address CIDRs that are located on your on-premises site. Traffic destined for these address spaces is routed to your local site.

    NOTE: The address_cidrs has to be set when the link.bgp isn't specified.

    deviceModel string
    The model of the VPN device.
    deviceVendor string
    The name of the VPN device vendor.
    links VpnSiteLink[]
    One or more link blocks as defined below.
    location string
    The Azure Region where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    name string
    The name which should be used for this VPN Site. Changing this forces a new VPN Site to be created.
    o365Policy VpnSiteO365Policy
    An o365_policy block as defined below.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the VPN Site.
    resource_group_name str
    The name of the Resource Group where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    virtual_wan_id str
    The ID of the Virtual Wan where this VPN site resides in. Changing this forces a new VPN Site to be created.
    address_cidrs Sequence[str]

    Specifies a list of IP address CIDRs that are located on your on-premises site. Traffic destined for these address spaces is routed to your local site.

    NOTE: The address_cidrs has to be set when the link.bgp isn't specified.

    device_model str
    The model of the VPN device.
    device_vendor str
    The name of the VPN device vendor.
    links Sequence[VpnSiteLinkArgs]
    One or more link blocks as defined below.
    location str
    The Azure Region where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    name str
    The name which should be used for this VPN Site. Changing this forces a new VPN Site to be created.
    o365_policy VpnSiteO365PolicyArgs
    An o365_policy block as defined below.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the VPN Site.
    resourceGroupName String
    The name of the Resource Group where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    virtualWanId String
    The ID of the Virtual Wan where this VPN site resides in. Changing this forces a new VPN Site to be created.
    addressCidrs List<String>

    Specifies a list of IP address CIDRs that are located on your on-premises site. Traffic destined for these address spaces is routed to your local site.

    NOTE: The address_cidrs has to be set when the link.bgp isn't specified.

    deviceModel String
    The model of the VPN device.
    deviceVendor String
    The name of the VPN device vendor.
    links List<Property Map>
    One or more link blocks as defined below.
    location String
    The Azure Region where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    name String
    The name which should be used for this VPN Site. Changing this forces a new VPN Site to be created.
    o365Policy Property Map
    An o365_policy block as defined below.
    tags Map<String>
    A mapping of tags which should be assigned to the VPN Site.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VpnSite 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 VpnSite Resource

    Get an existing VpnSite 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?: VpnSiteState, opts?: CustomResourceOptions): VpnSite
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address_cidrs: Optional[Sequence[str]] = None,
            device_model: Optional[str] = None,
            device_vendor: Optional[str] = None,
            links: Optional[Sequence[VpnSiteLinkArgs]] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            o365_policy: Optional[VpnSiteO365PolicyArgs] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            virtual_wan_id: Optional[str] = None) -> VpnSite
    func GetVpnSite(ctx *Context, name string, id IDInput, state *VpnSiteState, opts ...ResourceOption) (*VpnSite, error)
    public static VpnSite Get(string name, Input<string> id, VpnSiteState? state, CustomResourceOptions? opts = null)
    public static VpnSite get(String name, Output<String> id, VpnSiteState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AddressCidrs List<string>

    Specifies a list of IP address CIDRs that are located on your on-premises site. Traffic destined for these address spaces is routed to your local site.

    NOTE: The address_cidrs has to be set when the link.bgp isn't specified.

    DeviceModel string
    The model of the VPN device.
    DeviceVendor string
    The name of the VPN device vendor.
    Links List<VpnSiteLink>
    One or more link blocks as defined below.
    Location string
    The Azure Region where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    Name string
    The name which should be used for this VPN Site. Changing this forces a new VPN Site to be created.
    O365Policy VpnSiteO365Policy
    An o365_policy block as defined below.
    ResourceGroupName string
    The name of the Resource Group where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the VPN Site.
    VirtualWanId string
    The ID of the Virtual Wan where this VPN site resides in. Changing this forces a new VPN Site to be created.
    AddressCidrs []string

    Specifies a list of IP address CIDRs that are located on your on-premises site. Traffic destined for these address spaces is routed to your local site.

    NOTE: The address_cidrs has to be set when the link.bgp isn't specified.

    DeviceModel string
    The model of the VPN device.
    DeviceVendor string
    The name of the VPN device vendor.
    Links []VpnSiteLinkArgs
    One or more link blocks as defined below.
    Location string
    The Azure Region where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    Name string
    The name which should be used for this VPN Site. Changing this forces a new VPN Site to be created.
    O365Policy VpnSiteO365PolicyArgs
    An o365_policy block as defined below.
    ResourceGroupName string
    The name of the Resource Group where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the VPN Site.
    VirtualWanId string
    The ID of the Virtual Wan where this VPN site resides in. Changing this forces a new VPN Site to be created.
    addressCidrs List<String>

    Specifies a list of IP address CIDRs that are located on your on-premises site. Traffic destined for these address spaces is routed to your local site.

    NOTE: The address_cidrs has to be set when the link.bgp isn't specified.

    deviceModel String
    The model of the VPN device.
    deviceVendor String
    The name of the VPN device vendor.
    links List<VpnSiteLink>
    One or more link blocks as defined below.
    location String
    The Azure Region where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    name String
    The name which should be used for this VPN Site. Changing this forces a new VPN Site to be created.
    o365Policy VpnSiteO365Policy
    An o365_policy block as defined below.
    resourceGroupName String
    The name of the Resource Group where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the VPN Site.
    virtualWanId String
    The ID of the Virtual Wan where this VPN site resides in. Changing this forces a new VPN Site to be created.
    addressCidrs string[]

    Specifies a list of IP address CIDRs that are located on your on-premises site. Traffic destined for these address spaces is routed to your local site.

    NOTE: The address_cidrs has to be set when the link.bgp isn't specified.

    deviceModel string
    The model of the VPN device.
    deviceVendor string
    The name of the VPN device vendor.
    links VpnSiteLink[]
    One or more link blocks as defined below.
    location string
    The Azure Region where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    name string
    The name which should be used for this VPN Site. Changing this forces a new VPN Site to be created.
    o365Policy VpnSiteO365Policy
    An o365_policy block as defined below.
    resourceGroupName string
    The name of the Resource Group where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the VPN Site.
    virtualWanId string
    The ID of the Virtual Wan where this VPN site resides in. Changing this forces a new VPN Site to be created.
    address_cidrs Sequence[str]

    Specifies a list of IP address CIDRs that are located on your on-premises site. Traffic destined for these address spaces is routed to your local site.

    NOTE: The address_cidrs has to be set when the link.bgp isn't specified.

    device_model str
    The model of the VPN device.
    device_vendor str
    The name of the VPN device vendor.
    links Sequence[VpnSiteLinkArgs]
    One or more link blocks as defined below.
    location str
    The Azure Region where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    name str
    The name which should be used for this VPN Site. Changing this forces a new VPN Site to be created.
    o365_policy VpnSiteO365PolicyArgs
    An o365_policy block as defined below.
    resource_group_name str
    The name of the Resource Group where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the VPN Site.
    virtual_wan_id str
    The ID of the Virtual Wan where this VPN site resides in. Changing this forces a new VPN Site to be created.
    addressCidrs List<String>

    Specifies a list of IP address CIDRs that are located on your on-premises site. Traffic destined for these address spaces is routed to your local site.

    NOTE: The address_cidrs has to be set when the link.bgp isn't specified.

    deviceModel String
    The model of the VPN device.
    deviceVendor String
    The name of the VPN device vendor.
    links List<Property Map>
    One or more link blocks as defined below.
    location String
    The Azure Region where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    name String
    The name which should be used for this VPN Site. Changing this forces a new VPN Site to be created.
    o365Policy Property Map
    An o365_policy block as defined below.
    resourceGroupName String
    The name of the Resource Group where the VPN Site should exist. Changing this forces a new VPN Site to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the VPN Site.
    virtualWanId String
    The ID of the Virtual Wan where this VPN site resides in. Changing this forces a new VPN Site to be created.

    Supporting Types

    Name string
    The name which should be used for this VPN Site Link.
    Bgp VpnSiteLinkBgp

    A bgp block as defined above.

    NOTE: The link.bgp has to be set when the address_cidrs isn't specified.

    Fqdn string
    The FQDN of this VPN Site Link.
    Id string
    The ID of the VPN Site Link.
    IpAddress string

    The IP address of this VPN Site Link.

    NOTE: Either fqdn or ip_address should be specified.

    ProviderName string
    The name of the physical link at the VPN Site. Example: ATT, Verizon.
    SpeedInMbps int
    The speed of the VPN device at the branch location in unit of mbps. Defaults to 0.
    Name string
    The name which should be used for this VPN Site Link.
    Bgp VpnSiteLinkBgp

    A bgp block as defined above.

    NOTE: The link.bgp has to be set when the address_cidrs isn't specified.

    Fqdn string
    The FQDN of this VPN Site Link.
    Id string
    The ID of the VPN Site Link.
    IpAddress string

    The IP address of this VPN Site Link.

    NOTE: Either fqdn or ip_address should be specified.

    ProviderName string
    The name of the physical link at the VPN Site. Example: ATT, Verizon.
    SpeedInMbps int
    The speed of the VPN device at the branch location in unit of mbps. Defaults to 0.
    name String
    The name which should be used for this VPN Site Link.
    bgp VpnSiteLinkBgp

    A bgp block as defined above.

    NOTE: The link.bgp has to be set when the address_cidrs isn't specified.

    fqdn String
    The FQDN of this VPN Site Link.
    id String
    The ID of the VPN Site Link.
    ipAddress String

    The IP address of this VPN Site Link.

    NOTE: Either fqdn or ip_address should be specified.

    providerName String
    The name of the physical link at the VPN Site. Example: ATT, Verizon.
    speedInMbps Integer
    The speed of the VPN device at the branch location in unit of mbps. Defaults to 0.
    name string
    The name which should be used for this VPN Site Link.
    bgp VpnSiteLinkBgp

    A bgp block as defined above.

    NOTE: The link.bgp has to be set when the address_cidrs isn't specified.

    fqdn string
    The FQDN of this VPN Site Link.
    id string
    The ID of the VPN Site Link.
    ipAddress string

    The IP address of this VPN Site Link.

    NOTE: Either fqdn or ip_address should be specified.

    providerName string
    The name of the physical link at the VPN Site. Example: ATT, Verizon.
    speedInMbps number
    The speed of the VPN device at the branch location in unit of mbps. Defaults to 0.
    name str
    The name which should be used for this VPN Site Link.
    bgp VpnSiteLinkBgp

    A bgp block as defined above.

    NOTE: The link.bgp has to be set when the address_cidrs isn't specified.

    fqdn str
    The FQDN of this VPN Site Link.
    id str
    The ID of the VPN Site Link.
    ip_address str

    The IP address of this VPN Site Link.

    NOTE: Either fqdn or ip_address should be specified.

    provider_name str
    The name of the physical link at the VPN Site. Example: ATT, Verizon.
    speed_in_mbps int
    The speed of the VPN device at the branch location in unit of mbps. Defaults to 0.
    name String
    The name which should be used for this VPN Site Link.
    bgp Property Map

    A bgp block as defined above.

    NOTE: The link.bgp has to be set when the address_cidrs isn't specified.

    fqdn String
    The FQDN of this VPN Site Link.
    id String
    The ID of the VPN Site Link.
    ipAddress String

    The IP address of this VPN Site Link.

    NOTE: Either fqdn or ip_address should be specified.

    providerName String
    The name of the physical link at the VPN Site. Example: ATT, Verizon.
    speedInMbps Number
    The speed of the VPN device at the branch location in unit of mbps. Defaults to 0.

    VpnSiteLinkBgp, VpnSiteLinkBgpArgs

    Asn int
    The BGP speaker's ASN.
    PeeringAddress string
    The BGP peering IP address.
    Asn int
    The BGP speaker's ASN.
    PeeringAddress string
    The BGP peering IP address.
    asn Integer
    The BGP speaker's ASN.
    peeringAddress String
    The BGP peering IP address.
    asn number
    The BGP speaker's ASN.
    peeringAddress string
    The BGP peering IP address.
    asn int
    The BGP speaker's ASN.
    peering_address str
    The BGP peering IP address.
    asn Number
    The BGP speaker's ASN.
    peeringAddress String
    The BGP peering IP address.

    VpnSiteO365Policy, VpnSiteO365PolicyArgs

    TrafficCategory VpnSiteO365PolicyTrafficCategory
    A traffic_category block as defined above.
    TrafficCategory VpnSiteO365PolicyTrafficCategory
    A traffic_category block as defined above.
    trafficCategory VpnSiteO365PolicyTrafficCategory
    A traffic_category block as defined above.
    trafficCategory VpnSiteO365PolicyTrafficCategory
    A traffic_category block as defined above.
    traffic_category VpnSiteO365PolicyTrafficCategory
    A traffic_category block as defined above.
    trafficCategory Property Map
    A traffic_category block as defined above.

    VpnSiteO365PolicyTrafficCategory, VpnSiteO365PolicyTrafficCategoryArgs

    AllowEndpointEnabled bool
    Is allow endpoint enabled? The Allow endpoint is required for connectivity to specific O365 services and features, but are not as sensitive to network performance and latency as other endpoint types. Defaults to false.
    DefaultEndpointEnabled bool
    Is default endpoint enabled? The Default endpoint represents O365 services and dependencies that do not require any optimization, and can be treated by customer networks as normal Internet bound traffic. Defaults to false.
    OptimizeEndpointEnabled bool
    Is optimize endpoint enabled? The Optimize endpoint is required for connectivity to every O365 service and represents the O365 scenario that is the most sensitive to network performance, latency, and availability. Defaults to false.
    AllowEndpointEnabled bool
    Is allow endpoint enabled? The Allow endpoint is required for connectivity to specific O365 services and features, but are not as sensitive to network performance and latency as other endpoint types. Defaults to false.
    DefaultEndpointEnabled bool
    Is default endpoint enabled? The Default endpoint represents O365 services and dependencies that do not require any optimization, and can be treated by customer networks as normal Internet bound traffic. Defaults to false.
    OptimizeEndpointEnabled bool
    Is optimize endpoint enabled? The Optimize endpoint is required for connectivity to every O365 service and represents the O365 scenario that is the most sensitive to network performance, latency, and availability. Defaults to false.
    allowEndpointEnabled Boolean
    Is allow endpoint enabled? The Allow endpoint is required for connectivity to specific O365 services and features, but are not as sensitive to network performance and latency as other endpoint types. Defaults to false.
    defaultEndpointEnabled Boolean
    Is default endpoint enabled? The Default endpoint represents O365 services and dependencies that do not require any optimization, and can be treated by customer networks as normal Internet bound traffic. Defaults to false.
    optimizeEndpointEnabled Boolean
    Is optimize endpoint enabled? The Optimize endpoint is required for connectivity to every O365 service and represents the O365 scenario that is the most sensitive to network performance, latency, and availability. Defaults to false.
    allowEndpointEnabled boolean
    Is allow endpoint enabled? The Allow endpoint is required for connectivity to specific O365 services and features, but are not as sensitive to network performance and latency as other endpoint types. Defaults to false.
    defaultEndpointEnabled boolean
    Is default endpoint enabled? The Default endpoint represents O365 services and dependencies that do not require any optimization, and can be treated by customer networks as normal Internet bound traffic. Defaults to false.
    optimizeEndpointEnabled boolean
    Is optimize endpoint enabled? The Optimize endpoint is required for connectivity to every O365 service and represents the O365 scenario that is the most sensitive to network performance, latency, and availability. Defaults to false.
    allow_endpoint_enabled bool
    Is allow endpoint enabled? The Allow endpoint is required for connectivity to specific O365 services and features, but are not as sensitive to network performance and latency as other endpoint types. Defaults to false.
    default_endpoint_enabled bool
    Is default endpoint enabled? The Default endpoint represents O365 services and dependencies that do not require any optimization, and can be treated by customer networks as normal Internet bound traffic. Defaults to false.
    optimize_endpoint_enabled bool
    Is optimize endpoint enabled? The Optimize endpoint is required for connectivity to every O365 service and represents the O365 scenario that is the most sensitive to network performance, latency, and availability. Defaults to false.
    allowEndpointEnabled Boolean
    Is allow endpoint enabled? The Allow endpoint is required for connectivity to specific O365 services and features, but are not as sensitive to network performance and latency as other endpoint types. Defaults to false.
    defaultEndpointEnabled Boolean
    Is default endpoint enabled? The Default endpoint represents O365 services and dependencies that do not require any optimization, and can be treated by customer networks as normal Internet bound traffic. Defaults to false.
    optimizeEndpointEnabled Boolean
    Is optimize endpoint enabled? The Optimize endpoint is required for connectivity to every O365 service and represents the O365 scenario that is the most sensitive to network performance, latency, and availability. Defaults to false.

    Import

    VPN Sites can be imported using the resource id, e.g.

    $ pulumi import azure:network/vpnSite:VpnSite example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/vpnSites/site1
    

    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 Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi