1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. VpnSite
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.33.0 published on Friday, Mar 22, 2024 by Pulumi

azure-native.network.VpnSite

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.33.0 published on Friday, Mar 22, 2024 by Pulumi

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

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

    Example Usage

    VpnSiteCreate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var vpnSite = new AzureNative.Network.VpnSite("vpnSite", new()
        {
            AddressSpace = new AzureNative.Network.Inputs.AddressSpaceArgs
            {
                AddressPrefixes = new[]
                {
                    "10.0.0.0/16",
                },
            },
            IsSecuritySite = false,
            Location = "West US",
            O365Policy = new AzureNative.Network.Inputs.O365PolicyPropertiesArgs
            {
                BreakOutCategories = new AzureNative.Network.Inputs.O365BreakOutCategoryPoliciesArgs
                {
                    Allow = true,
                    Default = false,
                    Optimize = true,
                },
            },
            ResourceGroupName = "rg1",
            Tags = 
            {
                { "key1", "value1" },
            },
            VirtualWan = new AzureNative.Network.Inputs.SubResourceArgs
            {
                Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
            },
            VpnSiteLinks = new[]
            {
                new AzureNative.Network.Inputs.VpnSiteLinkArgs
                {
                    BgpProperties = new AzureNative.Network.Inputs.VpnLinkBgpSettingsArgs
                    {
                        Asn = 1234,
                        BgpPeeringAddress = "192.168.0.0",
                    },
                    Fqdn = "link1.vpnsite1.contoso.com",
                    IpAddress = "50.50.50.56",
                    LinkProperties = new AzureNative.Network.Inputs.VpnLinkProviderPropertiesArgs
                    {
                        LinkProviderName = "vendor1",
                        LinkSpeedInMbps = 0,
                    },
                    Name = "vpnSiteLink1",
                },
            },
            VpnSiteName = "vpnSite1",
        });
    
    });
    
    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.NewVpnSite(ctx, "vpnSite", &network.VpnSiteArgs{
    			AddressSpace: &network.AddressSpaceArgs{
    				AddressPrefixes: pulumi.StringArray{
    					pulumi.String("10.0.0.0/16"),
    				},
    			},
    			IsSecuritySite: pulumi.Bool(false),
    			Location:       pulumi.String("West US"),
    			O365Policy: &network.O365PolicyPropertiesArgs{
    				BreakOutCategories: &network.O365BreakOutCategoryPoliciesArgs{
    					Allow:    pulumi.Bool(true),
    					Default:  pulumi.Bool(false),
    					Optimize: pulumi.Bool(true),
    				},
    			},
    			ResourceGroupName: pulumi.String("rg1"),
    			Tags: pulumi.StringMap{
    				"key1": pulumi.String("value1"),
    			},
    			VirtualWan: &network.SubResourceArgs{
    				Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"),
    			},
    			VpnSiteLinks: network.VpnSiteLinkArray{
    				&network.VpnSiteLinkArgs{
    					BgpProperties: &network.VpnLinkBgpSettingsArgs{
    						Asn:               pulumi.Float64(1234),
    						BgpPeeringAddress: pulumi.String("192.168.0.0"),
    					},
    					Fqdn:      pulumi.String("link1.vpnsite1.contoso.com"),
    					IpAddress: pulumi.String("50.50.50.56"),
    					LinkProperties: &network.VpnLinkProviderPropertiesArgs{
    						LinkProviderName: pulumi.String("vendor1"),
    						LinkSpeedInMbps:  pulumi.Int(0),
    					},
    					Name: pulumi.String("vpnSiteLink1"),
    				},
    			},
    			VpnSiteName: pulumi.String("vpnSite1"),
    		})
    		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.VpnSite;
    import com.pulumi.azurenative.network.VpnSiteArgs;
    import com.pulumi.azurenative.network.inputs.AddressSpaceArgs;
    import com.pulumi.azurenative.network.inputs.O365PolicyPropertiesArgs;
    import com.pulumi.azurenative.network.inputs.O365BreakOutCategoryPoliciesArgs;
    import com.pulumi.azurenative.network.inputs.SubResourceArgs;
    import com.pulumi.azurenative.network.inputs.VpnSiteLinkArgs;
    import com.pulumi.azurenative.network.inputs.VpnLinkBgpSettingsArgs;
    import com.pulumi.azurenative.network.inputs.VpnLinkProviderPropertiesArgs;
    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 vpnSite = new VpnSite("vpnSite", VpnSiteArgs.builder()        
                .addressSpace(AddressSpaceArgs.builder()
                    .addressPrefixes("10.0.0.0/16")
                    .build())
                .isSecuritySite(false)
                .location("West US")
                .o365Policy(O365PolicyPropertiesArgs.builder()
                    .breakOutCategories(O365BreakOutCategoryPoliciesArgs.builder()
                        .allow(true)
                        .default_(false)
                        .optimize(true)
                        .build())
                    .build())
                .resourceGroupName("rg1")
                .tags(Map.of("key1", "value1"))
                .virtualWan(SubResourceArgs.builder()
                    .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1")
                    .build())
                .vpnSiteLinks(VpnSiteLinkArgs.builder()
                    .bgpProperties(VpnLinkBgpSettingsArgs.builder()
                        .asn(1234)
                        .bgpPeeringAddress("192.168.0.0")
                        .build())
                    .fqdn("link1.vpnsite1.contoso.com")
                    .ipAddress("50.50.50.56")
                    .linkProperties(VpnLinkProviderPropertiesArgs.builder()
                        .linkProviderName("vendor1")
                        .linkSpeedInMbps(0)
                        .build())
                    .name("vpnSiteLink1")
                    .build())
                .vpnSiteName("vpnSite1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    vpn_site = azure_native.network.VpnSite("vpnSite",
        address_space=azure_native.network.AddressSpaceArgs(
            address_prefixes=["10.0.0.0/16"],
        ),
        is_security_site=False,
        location="West US",
        o365_policy=azure_native.network.O365PolicyPropertiesArgs(
            break_out_categories=azure_native.network.O365BreakOutCategoryPoliciesArgs(
                allow=True,
                default=False,
                optimize=True,
            ),
        ),
        resource_group_name="rg1",
        tags={
            "key1": "value1",
        },
        virtual_wan=azure_native.network.SubResourceArgs(
            id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
        ),
        vpn_site_links=[azure_native.network.VpnSiteLinkArgs(
            bgp_properties=azure_native.network.VpnLinkBgpSettingsArgs(
                asn=1234,
                bgp_peering_address="192.168.0.0",
            ),
            fqdn="link1.vpnsite1.contoso.com",
            ip_address="50.50.50.56",
            link_properties=azure_native.network.VpnLinkProviderPropertiesArgs(
                link_provider_name="vendor1",
                link_speed_in_mbps=0,
            ),
            name="vpnSiteLink1",
        )],
        vpn_site_name="vpnSite1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const vpnSite = new azure_native.network.VpnSite("vpnSite", {
        addressSpace: {
            addressPrefixes: ["10.0.0.0/16"],
        },
        isSecuritySite: false,
        location: "West US",
        o365Policy: {
            breakOutCategories: {
                allow: true,
                "default": false,
                optimize: true,
            },
        },
        resourceGroupName: "rg1",
        tags: {
            key1: "value1",
        },
        virtualWan: {
            id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
        },
        vpnSiteLinks: [{
            bgpProperties: {
                asn: 1234,
                bgpPeeringAddress: "192.168.0.0",
            },
            fqdn: "link1.vpnsite1.contoso.com",
            ipAddress: "50.50.50.56",
            linkProperties: {
                linkProviderName: "vendor1",
                linkSpeedInMbps: 0,
            },
            name: "vpnSiteLink1",
        }],
        vpnSiteName: "vpnSite1",
    });
    
    resources:
      vpnSite:
        type: azure-native:network:VpnSite
        properties:
          addressSpace:
            addressPrefixes:
              - 10.0.0.0/16
          isSecuritySite: false
          location: West US
          o365Policy:
            breakOutCategories:
              allow: true
              default: false
              optimize: true
          resourceGroupName: rg1
          tags:
            key1: value1
          virtualWan:
            id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1
          vpnSiteLinks:
            - bgpProperties:
                asn: 1234
                bgpPeeringAddress: 192.168.0.0
              fqdn: link1.vpnsite1.contoso.com
              ipAddress: 50.50.50.56
              linkProperties:
                linkProviderName: vendor1
                linkSpeedInMbps: 0
              name: vpnSiteLink1
          vpnSiteName: vpnSite1
    

    Create VpnSite Resource

    new VpnSite(name: string, args: VpnSiteArgs, opts?: CustomResourceOptions);
    @overload
    def VpnSite(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                address_space: Optional[AddressSpaceArgs] = None,
                bgp_properties: Optional[BgpSettingsArgs] = None,
                device_properties: Optional[DevicePropertiesArgs] = None,
                id: Optional[str] = None,
                ip_address: Optional[str] = None,
                is_security_site: Optional[bool] = None,
                location: Optional[str] = None,
                o365_policy: Optional[O365PolicyPropertiesArgs] = None,
                resource_group_name: Optional[str] = None,
                site_key: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                virtual_wan: Optional[SubResourceArgs] = None,
                vpn_site_links: Optional[Sequence[VpnSiteLinkArgs]] = None,
                vpn_site_name: Optional[str] = None)
    @overload
    def VpnSite(resource_name: str,
                args: VpnSiteArgs,
                opts: Optional[ResourceOptions] = 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-native:network:VpnSite
    properties: # The arguments to resource properties.
    options: # 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.
    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.

    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 resource group name of the VpnSite.
    AddressSpace Pulumi.AzureNative.Network.Inputs.AddressSpace
    The AddressSpace that contains an array of IP address ranges.
    BgpProperties Pulumi.AzureNative.Network.Inputs.BgpSettings
    The set of bgp properties.
    DeviceProperties Pulumi.AzureNative.Network.Inputs.DeviceProperties
    The device properties.
    Id string
    Resource ID.
    IpAddress string
    The ip-address for the vpn-site.
    IsSecuritySite bool
    IsSecuritySite flag.
    Location string
    Resource location.
    O365Policy Pulumi.AzureNative.Network.Inputs.O365PolicyProperties
    Office365 Policy.
    SiteKey string
    The key for vpn-site that can be used for connections.
    Tags Dictionary<string, string>
    Resource tags.
    VirtualWan Pulumi.AzureNative.Network.Inputs.SubResource
    The VirtualWAN to which the vpnSite belongs.
    VpnSiteLinks List<Pulumi.AzureNative.Network.Inputs.VpnSiteLink>
    List of all vpn site links.
    VpnSiteName string
    The name of the VpnSite being created or updated.
    ResourceGroupName string
    The resource group name of the VpnSite.
    AddressSpace AddressSpaceArgs
    The AddressSpace that contains an array of IP address ranges.
    BgpProperties BgpSettingsArgs
    The set of bgp properties.
    DeviceProperties DevicePropertiesArgs
    The device properties.
    Id string
    Resource ID.
    IpAddress string
    The ip-address for the vpn-site.
    IsSecuritySite bool
    IsSecuritySite flag.
    Location string
    Resource location.
    O365Policy O365PolicyPropertiesArgs
    Office365 Policy.
    SiteKey string
    The key for vpn-site that can be used for connections.
    Tags map[string]string
    Resource tags.
    VirtualWan SubResourceArgs
    The VirtualWAN to which the vpnSite belongs.
    VpnSiteLinks []VpnSiteLinkArgs
    List of all vpn site links.
    VpnSiteName string
    The name of the VpnSite being created or updated.
    resourceGroupName String
    The resource group name of the VpnSite.
    addressSpace AddressSpace
    The AddressSpace that contains an array of IP address ranges.
    bgpProperties BgpSettings
    The set of bgp properties.
    deviceProperties DeviceProperties
    The device properties.
    id String
    Resource ID.
    ipAddress String
    The ip-address for the vpn-site.
    isSecuritySite Boolean
    IsSecuritySite flag.
    location String
    Resource location.
    o365Policy O365PolicyProperties
    Office365 Policy.
    siteKey String
    The key for vpn-site that can be used for connections.
    tags Map<String,String>
    Resource tags.
    virtualWan SubResource
    The VirtualWAN to which the vpnSite belongs.
    vpnSiteLinks List<VpnSiteLink>
    List of all vpn site links.
    vpnSiteName String
    The name of the VpnSite being created or updated.
    resourceGroupName string
    The resource group name of the VpnSite.
    addressSpace AddressSpace
    The AddressSpace that contains an array of IP address ranges.
    bgpProperties BgpSettings
    The set of bgp properties.
    deviceProperties DeviceProperties
    The device properties.
    id string
    Resource ID.
    ipAddress string
    The ip-address for the vpn-site.
    isSecuritySite boolean
    IsSecuritySite flag.
    location string
    Resource location.
    o365Policy O365PolicyProperties
    Office365 Policy.
    siteKey string
    The key for vpn-site that can be used for connections.
    tags {[key: string]: string}
    Resource tags.
    virtualWan SubResource
    The VirtualWAN to which the vpnSite belongs.
    vpnSiteLinks VpnSiteLink[]
    List of all vpn site links.
    vpnSiteName string
    The name of the VpnSite being created or updated.
    resource_group_name str
    The resource group name of the VpnSite.
    address_space AddressSpaceArgs
    The AddressSpace that contains an array of IP address ranges.
    bgp_properties BgpSettingsArgs
    The set of bgp properties.
    device_properties DevicePropertiesArgs
    The device properties.
    id str
    Resource ID.
    ip_address str
    The ip-address for the vpn-site.
    is_security_site bool
    IsSecuritySite flag.
    location str
    Resource location.
    o365_policy O365PolicyPropertiesArgs
    Office365 Policy.
    site_key str
    The key for vpn-site that can be used for connections.
    tags Mapping[str, str]
    Resource tags.
    virtual_wan SubResourceArgs
    The VirtualWAN to which the vpnSite belongs.
    vpn_site_links Sequence[VpnSiteLinkArgs]
    List of all vpn site links.
    vpn_site_name str
    The name of the VpnSite being created or updated.
    resourceGroupName String
    The resource group name of the VpnSite.
    addressSpace Property Map
    The AddressSpace that contains an array of IP address ranges.
    bgpProperties Property Map
    The set of bgp properties.
    deviceProperties Property Map
    The device properties.
    id String
    Resource ID.
    ipAddress String
    The ip-address for the vpn-site.
    isSecuritySite Boolean
    IsSecuritySite flag.
    location String
    Resource location.
    o365Policy Property Map
    Office365 Policy.
    siteKey String
    The key for vpn-site that can be used for connections.
    tags Map<String>
    Resource tags.
    virtualWan Property Map
    The VirtualWAN to which the vpnSite belongs.
    vpnSiteLinks List<Property Map>
    List of all vpn site links.
    vpnSiteName String
    The name of the VpnSite being created or updated.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VpnSite 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.
    ProvisioningState string
    The provisioning state of the VPN site resource.
    Type string
    Resource type.
    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.
    ProvisioningState string
    The provisioning state of the VPN site resource.
    Type string
    Resource type.
    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.
    provisioningState String
    The provisioning state of the VPN site resource.
    type String
    Resource type.
    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.
    provisioningState string
    The provisioning state of the VPN site resource.
    type string
    Resource type.
    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.
    provisioning_state str
    The provisioning state of the VPN site resource.
    type str
    Resource type.
    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.
    provisioningState String
    The provisioning state of the VPN site resource.
    type String
    Resource type.

    Supporting Types

    AddressSpace, AddressSpaceArgs

    AddressPrefixes List<string>
    A list of address blocks reserved for this virtual network in CIDR notation.
    AddressPrefixes []string
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes List<String>
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes string[]
    A list of address blocks reserved for this virtual network in CIDR notation.
    address_prefixes Sequence[str]
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes List<String>
    A list of address blocks reserved for this virtual network in CIDR notation.

    AddressSpaceResponse, AddressSpaceResponseArgs

    AddressPrefixes List<string>
    A list of address blocks reserved for this virtual network in CIDR notation.
    AddressPrefixes []string
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes List<String>
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes string[]
    A list of address blocks reserved for this virtual network in CIDR notation.
    address_prefixes Sequence[str]
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes List<String>
    A list of address blocks reserved for this virtual network in CIDR notation.

    BgpSettings, BgpSettingsArgs

    Asn double
    The BGP speaker's ASN.
    BgpPeeringAddress string
    The BGP peering address and BGP identifier of this BGP speaker.
    BgpPeeringAddresses List<Pulumi.AzureNative.Network.Inputs.IPConfigurationBgpPeeringAddress>
    BGP peering address with IP configuration ID for virtual network gateway.
    PeerWeight int
    The weight added to routes learned from this BGP speaker.
    Asn float64
    The BGP speaker's ASN.
    BgpPeeringAddress string
    The BGP peering address and BGP identifier of this BGP speaker.
    BgpPeeringAddresses []IPConfigurationBgpPeeringAddress
    BGP peering address with IP configuration ID for virtual network gateway.
    PeerWeight int
    The weight added to routes learned from this BGP speaker.
    asn Double
    The BGP speaker's ASN.
    bgpPeeringAddress String
    The BGP peering address and BGP identifier of this BGP speaker.
    bgpPeeringAddresses List<IPConfigurationBgpPeeringAddress>
    BGP peering address with IP configuration ID for virtual network gateway.
    peerWeight Integer
    The weight added to routes learned from this BGP speaker.
    asn number
    The BGP speaker's ASN.
    bgpPeeringAddress string
    The BGP peering address and BGP identifier of this BGP speaker.
    bgpPeeringAddresses IPConfigurationBgpPeeringAddress[]
    BGP peering address with IP configuration ID for virtual network gateway.
    peerWeight number
    The weight added to routes learned from this BGP speaker.
    asn float
    The BGP speaker's ASN.
    bgp_peering_address str
    The BGP peering address and BGP identifier of this BGP speaker.
    bgp_peering_addresses Sequence[IPConfigurationBgpPeeringAddress]
    BGP peering address with IP configuration ID for virtual network gateway.
    peer_weight int
    The weight added to routes learned from this BGP speaker.
    asn Number
    The BGP speaker's ASN.
    bgpPeeringAddress String
    The BGP peering address and BGP identifier of this BGP speaker.
    bgpPeeringAddresses List<Property Map>
    BGP peering address with IP configuration ID for virtual network gateway.
    peerWeight Number
    The weight added to routes learned from this BGP speaker.

    BgpSettingsResponse, BgpSettingsResponseArgs

    Asn double
    The BGP speaker's ASN.
    BgpPeeringAddress string
    The BGP peering address and BGP identifier of this BGP speaker.
    BgpPeeringAddresses List<Pulumi.AzureNative.Network.Inputs.IPConfigurationBgpPeeringAddressResponse>
    BGP peering address with IP configuration ID for virtual network gateway.
    PeerWeight int
    The weight added to routes learned from this BGP speaker.
    Asn float64
    The BGP speaker's ASN.
    BgpPeeringAddress string
    The BGP peering address and BGP identifier of this BGP speaker.
    BgpPeeringAddresses []IPConfigurationBgpPeeringAddressResponse
    BGP peering address with IP configuration ID for virtual network gateway.
    PeerWeight int
    The weight added to routes learned from this BGP speaker.
    asn Double
    The BGP speaker's ASN.
    bgpPeeringAddress String
    The BGP peering address and BGP identifier of this BGP speaker.
    bgpPeeringAddresses List<IPConfigurationBgpPeeringAddressResponse>
    BGP peering address with IP configuration ID for virtual network gateway.
    peerWeight Integer
    The weight added to routes learned from this BGP speaker.
    asn number
    The BGP speaker's ASN.
    bgpPeeringAddress string
    The BGP peering address and BGP identifier of this BGP speaker.
    bgpPeeringAddresses IPConfigurationBgpPeeringAddressResponse[]
    BGP peering address with IP configuration ID for virtual network gateway.
    peerWeight number
    The weight added to routes learned from this BGP speaker.
    asn float
    The BGP speaker's ASN.
    bgp_peering_address str
    The BGP peering address and BGP identifier of this BGP speaker.
    bgp_peering_addresses Sequence[IPConfigurationBgpPeeringAddressResponse]
    BGP peering address with IP configuration ID for virtual network gateway.
    peer_weight int
    The weight added to routes learned from this BGP speaker.
    asn Number
    The BGP speaker's ASN.
    bgpPeeringAddress String
    The BGP peering address and BGP identifier of this BGP speaker.
    bgpPeeringAddresses List<Property Map>
    BGP peering address with IP configuration ID for virtual network gateway.
    peerWeight Number
    The weight added to routes learned from this BGP speaker.

    DeviceProperties, DevicePropertiesArgs

    DeviceModel string
    Model of the device.
    DeviceVendor string
    Name of the device Vendor.
    LinkSpeedInMbps int
    Link speed.
    DeviceModel string
    Model of the device.
    DeviceVendor string
    Name of the device Vendor.
    LinkSpeedInMbps int
    Link speed.
    deviceModel String
    Model of the device.
    deviceVendor String
    Name of the device Vendor.
    linkSpeedInMbps Integer
    Link speed.
    deviceModel string
    Model of the device.
    deviceVendor string
    Name of the device Vendor.
    linkSpeedInMbps number
    Link speed.
    device_model str
    Model of the device.
    device_vendor str
    Name of the device Vendor.
    link_speed_in_mbps int
    Link speed.
    deviceModel String
    Model of the device.
    deviceVendor String
    Name of the device Vendor.
    linkSpeedInMbps Number
    Link speed.

    DevicePropertiesResponse, DevicePropertiesResponseArgs

    DeviceModel string
    Model of the device.
    DeviceVendor string
    Name of the device Vendor.
    LinkSpeedInMbps int
    Link speed.
    DeviceModel string
    Model of the device.
    DeviceVendor string
    Name of the device Vendor.
    LinkSpeedInMbps int
    Link speed.
    deviceModel String
    Model of the device.
    deviceVendor String
    Name of the device Vendor.
    linkSpeedInMbps Integer
    Link speed.
    deviceModel string
    Model of the device.
    deviceVendor string
    Name of the device Vendor.
    linkSpeedInMbps number
    Link speed.
    device_model str
    Model of the device.
    device_vendor str
    Name of the device Vendor.
    link_speed_in_mbps int
    Link speed.
    deviceModel String
    Model of the device.
    deviceVendor String
    Name of the device Vendor.
    linkSpeedInMbps Number
    Link speed.

    IPConfigurationBgpPeeringAddress, IPConfigurationBgpPeeringAddressArgs

    CustomBgpIpAddresses List<string>
    The list of custom BGP peering addresses which belong to IP configuration.
    IpconfigurationId string
    The ID of IP configuration which belongs to gateway.
    CustomBgpIpAddresses []string
    The list of custom BGP peering addresses which belong to IP configuration.
    IpconfigurationId string
    The ID of IP configuration which belongs to gateway.
    customBgpIpAddresses List<String>
    The list of custom BGP peering addresses which belong to IP configuration.
    ipconfigurationId String
    The ID of IP configuration which belongs to gateway.
    customBgpIpAddresses string[]
    The list of custom BGP peering addresses which belong to IP configuration.
    ipconfigurationId string
    The ID of IP configuration which belongs to gateway.
    custom_bgp_ip_addresses Sequence[str]
    The list of custom BGP peering addresses which belong to IP configuration.
    ipconfiguration_id str
    The ID of IP configuration which belongs to gateway.
    customBgpIpAddresses List<String>
    The list of custom BGP peering addresses which belong to IP configuration.
    ipconfigurationId String
    The ID of IP configuration which belongs to gateway.

    IPConfigurationBgpPeeringAddressResponse, IPConfigurationBgpPeeringAddressResponseArgs

    DefaultBgpIpAddresses List<string>
    The list of default BGP peering addresses which belong to IP configuration.
    TunnelIpAddresses List<string>
    The list of tunnel public IP addresses which belong to IP configuration.
    CustomBgpIpAddresses List<string>
    The list of custom BGP peering addresses which belong to IP configuration.
    IpconfigurationId string
    The ID of IP configuration which belongs to gateway.
    DefaultBgpIpAddresses []string
    The list of default BGP peering addresses which belong to IP configuration.
    TunnelIpAddresses []string
    The list of tunnel public IP addresses which belong to IP configuration.
    CustomBgpIpAddresses []string
    The list of custom BGP peering addresses which belong to IP configuration.
    IpconfigurationId string
    The ID of IP configuration which belongs to gateway.
    defaultBgpIpAddresses List<String>
    The list of default BGP peering addresses which belong to IP configuration.
    tunnelIpAddresses List<String>
    The list of tunnel public IP addresses which belong to IP configuration.
    customBgpIpAddresses List<String>
    The list of custom BGP peering addresses which belong to IP configuration.
    ipconfigurationId String
    The ID of IP configuration which belongs to gateway.
    defaultBgpIpAddresses string[]
    The list of default BGP peering addresses which belong to IP configuration.
    tunnelIpAddresses string[]
    The list of tunnel public IP addresses which belong to IP configuration.
    customBgpIpAddresses string[]
    The list of custom BGP peering addresses which belong to IP configuration.
    ipconfigurationId string
    The ID of IP configuration which belongs to gateway.
    default_bgp_ip_addresses Sequence[str]
    The list of default BGP peering addresses which belong to IP configuration.
    tunnel_ip_addresses Sequence[str]
    The list of tunnel public IP addresses which belong to IP configuration.
    custom_bgp_ip_addresses Sequence[str]
    The list of custom BGP peering addresses which belong to IP configuration.
    ipconfiguration_id str
    The ID of IP configuration which belongs to gateway.
    defaultBgpIpAddresses List<String>
    The list of default BGP peering addresses which belong to IP configuration.
    tunnelIpAddresses List<String>
    The list of tunnel public IP addresses which belong to IP configuration.
    customBgpIpAddresses List<String>
    The list of custom BGP peering addresses which belong to IP configuration.
    ipconfigurationId String
    The ID of IP configuration which belongs to gateway.

    O365BreakOutCategoryPolicies, O365BreakOutCategoryPoliciesArgs

    Allow bool
    Flag to control allow category.
    Default bool
    Flag to control default category.
    Optimize bool
    Flag to control optimize category.
    Allow bool
    Flag to control allow category.
    Default bool
    Flag to control default category.
    Optimize bool
    Flag to control optimize category.
    allow Boolean
    Flag to control allow category.
    default_ Boolean
    Flag to control default category.
    optimize Boolean
    Flag to control optimize category.
    allow boolean
    Flag to control allow category.
    default boolean
    Flag to control default category.
    optimize boolean
    Flag to control optimize category.
    allow bool
    Flag to control allow category.
    default bool
    Flag to control default category.
    optimize bool
    Flag to control optimize category.
    allow Boolean
    Flag to control allow category.
    default Boolean
    Flag to control default category.
    optimize Boolean
    Flag to control optimize category.

    O365BreakOutCategoryPoliciesResponse, O365BreakOutCategoryPoliciesResponseArgs

    Allow bool
    Flag to control allow category.
    Default bool
    Flag to control default category.
    Optimize bool
    Flag to control optimize category.
    Allow bool
    Flag to control allow category.
    Default bool
    Flag to control default category.
    Optimize bool
    Flag to control optimize category.
    allow Boolean
    Flag to control allow category.
    default_ Boolean
    Flag to control default category.
    optimize Boolean
    Flag to control optimize category.
    allow boolean
    Flag to control allow category.
    default boolean
    Flag to control default category.
    optimize boolean
    Flag to control optimize category.
    allow bool
    Flag to control allow category.
    default bool
    Flag to control default category.
    optimize bool
    Flag to control optimize category.
    allow Boolean
    Flag to control allow category.
    default Boolean
    Flag to control default category.
    optimize Boolean
    Flag to control optimize category.

    O365PolicyProperties, O365PolicyPropertiesArgs

    BreakOutCategories O365BreakOutCategoryPolicies
    Office365 breakout categories.
    breakOutCategories O365BreakOutCategoryPolicies
    Office365 breakout categories.
    breakOutCategories O365BreakOutCategoryPolicies
    Office365 breakout categories.
    breakOutCategories Property Map
    Office365 breakout categories.

    O365PolicyPropertiesResponse, O365PolicyPropertiesResponseArgs

    breakOutCategories Property Map
    Office365 breakout categories.

    SubResource, SubResourceArgs

    Id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    Id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id String
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id str
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id String
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.

    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.

    VpnLinkBgpSettings, VpnLinkBgpSettingsArgs

    Asn double
    The BGP speaker's ASN.
    BgpPeeringAddress string
    The BGP peering address and BGP identifier of this BGP speaker.
    Asn float64
    The BGP speaker's ASN.
    BgpPeeringAddress string
    The BGP peering address and BGP identifier of this BGP speaker.
    asn Double
    The BGP speaker's ASN.
    bgpPeeringAddress String
    The BGP peering address and BGP identifier of this BGP speaker.
    asn number
    The BGP speaker's ASN.
    bgpPeeringAddress string
    The BGP peering address and BGP identifier of this BGP speaker.
    asn float
    The BGP speaker's ASN.
    bgp_peering_address str
    The BGP peering address and BGP identifier of this BGP speaker.
    asn Number
    The BGP speaker's ASN.
    bgpPeeringAddress String
    The BGP peering address and BGP identifier of this BGP speaker.

    VpnLinkBgpSettingsResponse, VpnLinkBgpSettingsResponseArgs

    Asn double
    The BGP speaker's ASN.
    BgpPeeringAddress string
    The BGP peering address and BGP identifier of this BGP speaker.
    Asn float64
    The BGP speaker's ASN.
    BgpPeeringAddress string
    The BGP peering address and BGP identifier of this BGP speaker.
    asn Double
    The BGP speaker's ASN.
    bgpPeeringAddress String
    The BGP peering address and BGP identifier of this BGP speaker.
    asn number
    The BGP speaker's ASN.
    bgpPeeringAddress string
    The BGP peering address and BGP identifier of this BGP speaker.
    asn float
    The BGP speaker's ASN.
    bgp_peering_address str
    The BGP peering address and BGP identifier of this BGP speaker.
    asn Number
    The BGP speaker's ASN.
    bgpPeeringAddress String
    The BGP peering address and BGP identifier of this BGP speaker.

    VpnLinkProviderProperties, VpnLinkProviderPropertiesArgs

    LinkProviderName string
    Name of the link provider.
    LinkSpeedInMbps int
    Link speed.
    LinkProviderName string
    Name of the link provider.
    LinkSpeedInMbps int
    Link speed.
    linkProviderName String
    Name of the link provider.
    linkSpeedInMbps Integer
    Link speed.
    linkProviderName string
    Name of the link provider.
    linkSpeedInMbps number
    Link speed.
    link_provider_name str
    Name of the link provider.
    link_speed_in_mbps int
    Link speed.
    linkProviderName String
    Name of the link provider.
    linkSpeedInMbps Number
    Link speed.

    VpnLinkProviderPropertiesResponse, VpnLinkProviderPropertiesResponseArgs

    LinkProviderName string
    Name of the link provider.
    LinkSpeedInMbps int
    Link speed.
    LinkProviderName string
    Name of the link provider.
    LinkSpeedInMbps int
    Link speed.
    linkProviderName String
    Name of the link provider.
    linkSpeedInMbps Integer
    Link speed.
    linkProviderName string
    Name of the link provider.
    linkSpeedInMbps number
    Link speed.
    link_provider_name str
    Name of the link provider.
    link_speed_in_mbps int
    Link speed.
    linkProviderName String
    Name of the link provider.
    linkSpeedInMbps Number
    Link speed.
    BgpProperties Pulumi.AzureNative.Network.Inputs.VpnLinkBgpSettings
    The set of bgp properties.
    Fqdn string
    FQDN of vpn-site-link.
    Id string
    Resource ID.
    IpAddress string
    The ip-address for the vpn-site-link.
    LinkProperties Pulumi.AzureNative.Network.Inputs.VpnLinkProviderProperties
    The link provider properties.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    BgpProperties VpnLinkBgpSettings
    The set of bgp properties.
    Fqdn string
    FQDN of vpn-site-link.
    Id string
    Resource ID.
    IpAddress string
    The ip-address for the vpn-site-link.
    LinkProperties VpnLinkProviderProperties
    The link provider properties.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    bgpProperties VpnLinkBgpSettings
    The set of bgp properties.
    fqdn String
    FQDN of vpn-site-link.
    id String
    Resource ID.
    ipAddress String
    The ip-address for the vpn-site-link.
    linkProperties VpnLinkProviderProperties
    The link provider properties.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    bgpProperties VpnLinkBgpSettings
    The set of bgp properties.
    fqdn string
    FQDN of vpn-site-link.
    id string
    Resource ID.
    ipAddress string
    The ip-address for the vpn-site-link.
    linkProperties VpnLinkProviderProperties
    The link provider properties.
    name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    bgp_properties VpnLinkBgpSettings
    The set of bgp properties.
    fqdn str
    FQDN of vpn-site-link.
    id str
    Resource ID.
    ip_address str
    The ip-address for the vpn-site-link.
    link_properties VpnLinkProviderProperties
    The link provider properties.
    name str
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    bgpProperties Property Map
    The set of bgp properties.
    fqdn String
    FQDN of vpn-site-link.
    id String
    Resource ID.
    ipAddress String
    The ip-address for the vpn-site-link.
    linkProperties Property Map
    The link provider properties.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.

    VpnSiteLinkResponse, VpnSiteLinkResponseArgs

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the VPN site link resource.
    Type string
    Resource type.
    BgpProperties Pulumi.AzureNative.Network.Inputs.VpnLinkBgpSettingsResponse
    The set of bgp properties.
    Fqdn string
    FQDN of vpn-site-link.
    Id string
    Resource ID.
    IpAddress string
    The ip-address for the vpn-site-link.
    LinkProperties Pulumi.AzureNative.Network.Inputs.VpnLinkProviderPropertiesResponse
    The link provider properties.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the VPN site link resource.
    Type string
    Resource type.
    BgpProperties VpnLinkBgpSettingsResponse
    The set of bgp properties.
    Fqdn string
    FQDN of vpn-site-link.
    Id string
    Resource ID.
    IpAddress string
    The ip-address for the vpn-site-link.
    LinkProperties VpnLinkProviderPropertiesResponse
    The link provider properties.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the VPN site link resource.
    type String
    Resource type.
    bgpProperties VpnLinkBgpSettingsResponse
    The set of bgp properties.
    fqdn String
    FQDN of vpn-site-link.
    id String
    Resource ID.
    ipAddress String
    The ip-address for the vpn-site-link.
    linkProperties VpnLinkProviderPropertiesResponse
    The link provider properties.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    provisioningState string
    The provisioning state of the VPN site link resource.
    type string
    Resource type.
    bgpProperties VpnLinkBgpSettingsResponse
    The set of bgp properties.
    fqdn string
    FQDN of vpn-site-link.
    id string
    Resource ID.
    ipAddress string
    The ip-address for the vpn-site-link.
    linkProperties VpnLinkProviderPropertiesResponse
    The link provider properties.
    name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    provisioning_state str
    The provisioning state of the VPN site link resource.
    type str
    Resource type.
    bgp_properties VpnLinkBgpSettingsResponse
    The set of bgp properties.
    fqdn str
    FQDN of vpn-site-link.
    id str
    Resource ID.
    ip_address str
    The ip-address for the vpn-site-link.
    link_properties VpnLinkProviderPropertiesResponse
    The link provider properties.
    name str
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the VPN site link resource.
    type String
    Resource type.
    bgpProperties Property Map
    The set of bgp properties.
    fqdn String
    FQDN of vpn-site-link.
    id String
    Resource ID.
    ipAddress String
    The ip-address for the vpn-site-link.
    linkProperties Property Map
    The link provider properties.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.

    Import

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

    $ pulumi import azure-native:network:VpnSite vpnSite1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName} 
    

    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.33.0 published on Friday, Mar 22, 2024 by Pulumi