VirtualNetworkGatewayConnectionPropertiesFormat interface

Package:

@azure/arm-network

VirtualNetworkGatewayConnection properties.

Properties

authenticationType	Gateway connection authentication type.
authorizationKey	The authorizationKey.
certificateAuthentication	Certificate Authentication information for a certificate based authentication connection.
connectionMode	The connection mode for this connection.
connectionProtocol	Connection protocol used for this connection.
connectionStatus	Virtual Network Gateway connection status.
connectionType	Gateway connection type.
dpdTimeoutSeconds	The dead peer detection timeout of this connection in seconds.
egressBytesTransferred	The egress bytes transferred in this connection.
egressNatRules	List of egress NatRules.
enableBgp	EnableBgp flag.
enablePrivateLinkFastPath	Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
expressRouteGatewayBypass	Bypass ExpressRoute Gateway for data forwarding.
gatewayCustomBgpIpAddresses	GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.
ingressBytesTransferred	The ingress bytes transferred in this connection.
ingressNatRules	List of ingress NatRules.
ipsecPolicies	The IPSec Policies to be considered by this connection.
localNetworkGateway2	The reference to local network gateway resource.
peer	The reference to peerings resource.
provisioningState	The provisioning state of the virtual network gateway connection resource.
resourceGuid	The resource GUID property of the virtual network gateway connection resource.
routingConfiguration	The routing configuration indicating the associated and propagated route tables for this connection.
routingWeight	The routing weight.
sharedKey	The IPSec shared key.
trafficSelectorPolicies	The Traffic Selector Policies to be considered by this connection.
tunnelConnectionStatus	Collection of all tunnels' connection health status.
tunnelProperties	Tunnel properties for virtual network gateway connection
useLocalAzureIpAddress	Use private local Azure IP for the connection.
usePolicyBasedTrafficSelectors	Enable policy-based traffic selectors.
virtualNetworkGateway1	The reference to virtual network gateway resource.
virtualNetworkGateway2	The reference to virtual network gateway resource.

Property Details

authenticationType

Gateway connection authentication type.

authenticationType?: string

Property Value

string

authorizationKey

The authorizationKey.

authorizationKey?: string

Property Value

string

certificateAuthentication

Certificate Authentication information for a certificate based authentication connection.

certificateAuthentication?: CertificateAuthentication

Property Value

CertificateAuthentication

connectionMode

The connection mode for this connection.

connectionMode?: string

Property Value

string

connectionProtocol

Connection protocol used for this connection.

connectionProtocol?: string

Property Value

string

connectionStatus

Virtual Network Gateway connection status.

connectionStatus?: string

Property Value

string

connectionType

Gateway connection type.

connectionType: string

Property Value

string

dpdTimeoutSeconds

The dead peer detection timeout of this connection in seconds.

dpdTimeoutSeconds?: number

Property Value

number

egressBytesTransferred

The egress bytes transferred in this connection.

egressBytesTransferred?: number

Property Value

number

egressNatRules

List of egress NatRules.

egressNatRules?: SubResource[]

Property Value

SubResource[]

enableBgp

EnableBgp flag.

enableBgp?: boolean

Property Value

boolean

enablePrivateLinkFastPath

Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.

enablePrivateLinkFastPath?: boolean

Property Value

boolean

expressRouteGatewayBypass

Bypass ExpressRoute Gateway for data forwarding.

expressRouteGatewayBypass?: boolean

Property Value

boolean

gatewayCustomBgpIpAddresses

GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.

gatewayCustomBgpIpAddresses?: GatewayCustomBgpIpAddressIpConfiguration[]

Property Value

GatewayCustomBgpIpAddressIpConfiguration[]

ingressBytesTransferred

The ingress bytes transferred in this connection.

ingressBytesTransferred?: number

Property Value

number

ingressNatRules

List of ingress NatRules.

ingressNatRules?: SubResource[]

Property Value

SubResource[]

ipsecPolicies

The IPSec Policies to be considered by this connection.

ipsecPolicies?: IpsecPolicy[]

Property Value

IpsecPolicy[]

localNetworkGateway2

The reference to local network gateway resource.

localNetworkGateway2?: LocalNetworkGateway

Property Value

LocalNetworkGateway

peer

The reference to peerings resource.

peer?: SubResource

Property Value

SubResource

provisioningState

The provisioning state of the virtual network gateway connection resource.

provisioningState?: string

Property Value

string

resourceGuid

The resource GUID property of the virtual network gateway connection resource.

resourceGuid?: string

Property Value

string

routingConfiguration

The routing configuration indicating the associated and propagated route tables for this connection.

routingConfiguration?: RoutingConfiguration

Property Value

RoutingConfiguration

routingWeight

The routing weight.

routingWeight?: number

Property Value

number

sharedKey

The IPSec shared key.

sharedKey?: string

Property Value

string

trafficSelectorPolicies

The Traffic Selector Policies to be considered by this connection.

trafficSelectorPolicies?: TrafficSelectorPolicy[]

Property Value

TrafficSelectorPolicy[]

tunnelConnectionStatus

Collection of all tunnels' connection health status.

tunnelConnectionStatus?: TunnelConnectionHealth[]

Property Value

TunnelConnectionHealth[]

tunnelProperties

Tunnel properties for virtual network gateway connection

tunnelProperties?: VirtualNetworkGatewayConnectionTunnelProperties[]

Property Value

VirtualNetworkGatewayConnectionTunnelProperties[]

useLocalAzureIpAddress

Use private local Azure IP for the connection.

useLocalAzureIpAddress?: boolean

Property Value

boolean

usePolicyBasedTrafficSelectors

Enable policy-based traffic selectors.

usePolicyBasedTrafficSelectors?: boolean

Property Value

boolean

virtualNetworkGateway1

The reference to virtual network gateway resource.

virtualNetworkGateway1: VirtualNetworkGateway

Property Value

VirtualNetworkGateway

virtualNetworkGateway2

The reference to virtual network gateway resource.

virtualNetworkGateway2?: VirtualNetworkGateway

Property Value

VirtualNetworkGateway