Class VpnGateway

Manages a VPN Gateway within a Virtual Hub, which enables Site-to-Site communication.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
public MyStack()
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
    {
        Location = "West Europe",
    });
    var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("exampleVirtualNetwork", new Azure.Network.VirtualNetworkArgs
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        AddressSpaces = 
        {
            "10.0.0.0/16",
        },
    });
    var exampleVirtualWan = new Azure.Network.VirtualWan("exampleVirtualWan", new Azure.Network.VirtualWanArgs
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
    });
    var exampleVirtualHub = new Azure.Network.VirtualHub("exampleVirtualHub", new Azure.Network.VirtualHubArgs
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        VirtualWanId = exampleVirtualWan.Id,
        AddressPrefix = "10.0.1.0/24",
    });
    var exampleVpnGateway = new Azure.Network.VpnGateway("exampleVpnGateway", new Azure.Network.VpnGatewayArgs
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        VirtualHubId = exampleVirtualHub.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

VpnGateway

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Network

Assembly: Pulumi.Azure.dll

Syntax

public class VpnGateway : CustomResource

Constructors

VpnGateway(String, VpnGatewayArgs, CustomResourceOptions)

Create a VpnGateway resource with the given unique name, arguments, and options.

Declaration

public VpnGateway(string name, VpnGatewayArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
VpnGatewayArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

BgpSettings

A bgp_settings block as defined below.

Declaration

public Output<ImmutableArray<VpnGatewayBgpSetting>> BgpSettings { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<VpnGatewayBgpSetting>>

Location

The Azure location where this VPN Gateway should be created. Changing this forces a new resource to be created.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Name

The Name which should be used for this VPN Gateway. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The Name of the Resource Group in which this VPN Gateway should be created. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

ScaleUnit

The Scale Unit for this VPN Gateway. Defaults to 1.

Declaration

public Output<int?> ScaleUnit { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Tags

A mapping of tags to assign to the VPN Gateway.

Declaration

public Output<ImmutableDictionary<string, string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

VirtualHubId

The ID of the Virtual Hub within which this VPN Gateway should be created. Changing this forces a new resource to be created.

Declaration

public Output<string> VirtualHubId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, VpnGatewayState, CustomResourceOptions)

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

Declaration

public static VpnGateway Get(string name, Input<string> id, VpnGatewayState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
VpnGatewayState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
VpnGateway