VirtualNetworkGatewayConnection interface

Package:

@azure/arm-network

A common class for general resource information.

Extends

Resource

Properties

authorizationKey	The authorizationKey.
connectionMode	The connection mode for this connection.
connectionProtocol	Connection protocol used for this connection.
connectionStatus	Virtual Network Gateway connection status. NOTE: This property will not be serialized. It can only be populated by the server.
connectionType	Gateway connection type.
dpdTimeoutSeconds	The dead peer detection timeout of this connection in seconds.
egressBytesTransferred	The egress bytes transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server.
egressNatRules	List of egress NatRules.
enableBgp	EnableBgp flag.
enablePrivateLinkFastPath	Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
etag	A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
resourceGuid	The resource GUID property of the virtual network gateway connection resource. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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.

Inherited Properties

id	Resource ID.
location	Resource location.
name	Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

authorizationKey

The authorizationKey.

authorizationKey?: string

Property Value

string

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. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

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

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

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. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

resourceGuid

The resource GUID property of the virtual network gateway connection resource. NOTE: This property will not be serialized. It can only be populated by the server.

resourceGuid?: string

Property Value

string

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. NOTE: This property will not be serialized. It can only be populated by the server.

tunnelConnectionStatus?: TunnelConnectionHealth[]

Property Value

TunnelConnectionHealth[]

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

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location.

location?: string

Property Value

string

Inherited From Resource.location

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type