Class VirtualNetworkGateway

Manages a Virtual Network Gateway to establish secure, cross-premises connectivity.

Note: Please be aware that provisioning a Virtual Network Gateway takes a long time (between 30 minutes and 1 hour)

Inheritance

System.Object

Resource

CustomResource

VirtualNetworkGateway

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 VirtualNetworkGateway : CustomResource

Constructors

VirtualNetworkGateway(String, VirtualNetworkGatewayArgs, CustomResourceOptions)

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

Declaration

public VirtualNetworkGateway(string name, VirtualNetworkGatewayArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

ActiveActive

If true, an active-active Virtual Network Gateway will be created. An active-active gateway requires a HighPerformance or an UltraPerformance sku. If false, an active-standby gateway will be created. Defaults to false.

Declaration

public Output<bool> ActiveActive { get; }

Property Value

Type	Description
Output<System.Boolean>

BgpSettings

Declaration

public Output<VirtualNetworkGatewayBgpSettings> BgpSettings { get; }

Property Value

Type	Description
Output<VirtualNetworkGatewayBgpSettings>

DefaultLocalNetworkGatewayId

The ID of the local network gateway through which outbound Internet traffic from the virtual network in which the gateway is created will be routed (forced tunnelling). Refer to the Azure documentation on forced tunnelling. If not specified, forced tunnelling is disabled.

Declaration

public Output<string> DefaultLocalNetworkGatewayId { get; }

Property Value

Type	Description
Output<System.String>

EnableBgp

If true, BGP (Border Gateway Protocol) will be enabled for this Virtual Network Gateway. Defaults to false.

Declaration

public Output<bool> EnableBgp { get; }

Property Value

Type	Description
Output<System.Boolean>

Generation

The Generation of the Virtual Network gateway. Possible values include Generation1, Generation2 or None.

Declaration

public Output<string> Generation { get; }

Property Value

Type	Description
Output<System.String>

IpConfigurations

One or two ip_configuration blocks documented below. An active-standby gateway requires exactly one ip_configuration block whereas an active-active gateway requires exactly two ip_configuration blocks.

Declaration

public Output<ImmutableArray<VirtualNetworkGatewayIpConfiguration>> IpConfigurations { get; }

Property Value

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

Location

The location/region where the Virtual Network Gateway is located. Changing the location/region forces a new resource to be created.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Name

A user-defined name of the revoked certificate.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The name of the resource group in which to create the Virtual Network Gateway. Changing the resource group name forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Sku

Configuration of the size and capacity of the virtual network gateway. Valid options are Basic, Standard, HighPerformance, UltraPerformance, ErGw1AZ, ErGw2AZ, ErGw3AZ, VpnGw1, VpnGw2, VpnGw3, VpnGw4,VpnGw5, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ,VpnGw4AZ and VpnGw5AZ and depend on the type, vpn_type and generation arguments. A PolicyBased gateway only supports the Basic sku. Further, the UltraPerformance sku is only supported by an ExpressRoute gateway.

Declaration

public Output<string> Sku { get; }

Property Value

Type	Description
Output<System.String>

Tags

A mapping of tags to assign to the resource.

Declaration

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

Property Value

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

Type

The type of the Virtual Network Gateway. Valid options are Vpn or ExpressRoute. Changing the type forces a new resource to be created.

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

VpnClientConfiguration

A vpn_client_configuration block which is documented below. In this block the Virtual Network Gateway can be configured to accept IPSec point-to-site connections.

Declaration

public Output<VirtualNetworkGatewayVpnClientConfiguration> VpnClientConfiguration { get; }

Property Value

Type	Description
Output<VirtualNetworkGatewayVpnClientConfiguration>

VpnType

The routing type of the Virtual Network Gateway. Valid options are RouteBased or PolicyBased. Defaults to RouteBased.

Declaration

public Output<string> VpnType { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

public static VirtualNetworkGateway Get(string name, Input<string> id, VirtualNetworkGatewayState 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.
VirtualNetworkGatewayState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
VirtualNetworkGateway