Class VirtualNetworkGatewayConnection

Manages a connection in an existing Virtual Network Gateway.

Inheritance

System.Object

Resource

CustomResource

VirtualNetworkGatewayConnection

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

Constructors

VirtualNetworkGatewayConnection(String, VirtualNetworkGatewayConnectionArgs, CustomResourceOptions)

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

Declaration

public VirtualNetworkGatewayConnection(string name, VirtualNetworkGatewayConnectionArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

AuthorizationKey

The authorization key associated with the Express Route Circuit. This field is required only if the type is an ExpressRoute connection.

Declaration

public Output<string> AuthorizationKey { get; }

Property Value

Type	Description
Output<System.String>

ConnectionProtocol

The IKE protocol version to use. Possible values are IKEv1 and IKEv2. Defaults to IKEv2. Changing this value will force a resource to be created.

Note: Only valid for IPSec connections on virtual network gateways with SKU VpnGw1, VpnGw2, VpnGw3, VpnGw1AZ, VpnGw2AZ or VpnGw3AZ.

Declaration

public Output<string> ConnectionProtocol { get; }

Property Value

Type	Description
Output<System.String>

EnableBgp

If true, BGP (Border Gateway Protocol) is enabled for this connection. Defaults to false.

Declaration

public Output<bool> EnableBgp { get; }

Property Value

Type	Description
Output<System.Boolean>

ExpressRouteCircuitId

The ID of the Express Route Circuit when creating an ExpressRoute connection (i.e. when type is ExpressRoute). The Express Route Circuit can be in the same or in a different subscription.

Declaration

public Output<string> ExpressRouteCircuitId { get; }

Property Value

Type	Description
Output<System.String>

ExpressRouteGatewayBypass

If true, data packets will bypass ExpressRoute Gateway for data forwarding This is only valid for ExpressRoute connections.

Declaration

public Output<bool> ExpressRouteGatewayBypass { get; }

Property Value

Type	Description
Output<System.Boolean>

IpsecPolicy

A ipsec_policy block which is documented below. Only a single policy can be defined for a connection. For details on custom policies refer to the relevant section in the Azure documentation.

Declaration

public Output<VirtualNetworkGatewayConnectionIpsecPolicy> IpsecPolicy { get; }

Property Value

Type	Description
Output<VirtualNetworkGatewayConnectionIpsecPolicy>

LocalNetworkGatewayId

The ID of the local network gateway when creating Site-to-Site connection (i.e. when type is IPsec).

Declaration

public Output<string> LocalNetworkGatewayId { get; }

Property Value

Type	Description
Output<System.String>

Location

The location/region where the connection is located. 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 of the connection. Changing the name forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

PeerVirtualNetworkGatewayId

The ID of the peer virtual network gateway when creating a VNet-to-VNet connection (i.e. when type is Vnet2Vnet). The peer Virtual Network Gateway can be in the same or in a different subscription.

Declaration

public Output<string> PeerVirtualNetworkGatewayId { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

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

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

RoutingWeight

The routing weight. Defaults to 10.

Declaration

public Output<int> RoutingWeight { get; }

Property Value

Type	Description
Output<System.Int32>

SharedKey

The shared IPSec key. A key could be provided if a Site-to-Site, VNet-to-VNet or ExpressRoute connection is created.

Declaration

public Output<string> SharedKey { 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 connection. Valid options are IPsec (Site-to-Site), ExpressRoute (ExpressRoute), and Vnet2Vnet (VNet-to-VNet). Each connection type requires different mandatory arguments (refer to the examples above). Changing the connection type will force a new connection to be created.

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

UsePolicyBasedTrafficSelectors

If true, policy-based traffic selectors are enabled for this connection. Enabling policy-based traffic selectors requires an ipsec_policy block. Defaults to false.

Declaration

public Output<bool> UsePolicyBasedTrafficSelectors { get; }

Property Value

Type	Description
Output<System.Boolean>

VirtualNetworkGatewayId

The ID of the Virtual Network Gateway in which the connection will be created. Changing the gateway forces a new resource to be created.

Declaration

public Output<string> VirtualNetworkGatewayId { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

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

Returns

Type	Description
VirtualNetworkGatewayConnection