Class VirtualNetworkGatewayConnectionArgs

Inheritance
System.Object
InputArgs
ResourceArgs
VirtualNetworkGatewayConnectionArgs
Inherited Members
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 sealed class VirtualNetworkGatewayConnectionArgs : ResourceArgs

Constructors

View Source

VirtualNetworkGatewayConnectionArgs()

Declaration
public VirtualNetworkGatewayConnectionArgs()

Properties

View Source

AuthorizationKey

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

Declaration
public Input<string> AuthorizationKey { get; set; }
Property Value
Type Description
Input<System.String>
View Source

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 Input<string> ConnectionProtocol { get; set; }
Property Value
Type Description
Input<System.String>
View Source

EnableBgp

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

Declaration
public Input<bool> EnableBgp { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

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 Input<string> ExpressRouteCircuitId { get; set; }
Property Value
Type Description
Input<System.String>
View Source

ExpressRouteGatewayBypass

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

Declaration
public Input<bool> ExpressRouteGatewayBypass { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

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 Input<VirtualNetworkGatewayConnectionIpsecPolicyArgs> IpsecPolicy { get; set; }
Property Value
Type Description
Input<VirtualNetworkGatewayConnectionIpsecPolicyArgs>
View Source

LocalNetworkGatewayId

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

Declaration
public Input<string> LocalNetworkGatewayId { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Location

The location/region where the connection is located. Changing this forces a new resource to be created.

Declaration
public Input<string> Location { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Name

The name of the connection. Changing the name forces a new resource to be created.

Declaration
public Input<string> Name { get; set; }
Property Value
Type Description
Input<System.String>
View Source

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 Input<string> PeerVirtualNetworkGatewayId { get; set; }
Property Value
Type Description
Input<System.String>
View Source

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 Input<string> ResourceGroupName { get; set; }
Property Value
Type Description
Input<System.String>
View Source

RoutingWeight

The routing weight. Defaults to 10.

Declaration
public Input<int> RoutingWeight { get; set; }
Property Value
Type Description
Input<System.Int32>
View Source

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 Input<string> SharedKey { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Tags

A mapping of tags to assign to the resource.

Declaration
public InputMap<string> Tags { get; set; }
Property Value
Type Description
InputMap<System.String>
View Source

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 Input<string> Type { get; set; }
Property Value
Type Description
Input<System.String>
View Source

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 Input<bool> UsePolicyBasedTrafficSelectors { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

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 Input<string> VirtualNetworkGatewayId { get; set; }
Property Value
Type Description
Input<System.String>