Share via

VirtualNetworkGatewayConnection interface

Package:
@azure/arm-network-profile-2020-09-01-hybrid

A common class for general resource information

Extends
Resource

Properties

authorizationKey

The authorizationKey.
connectionProtocol

Connection protocol used for this connection
connectionStatus

Virtual network Gateway connection status. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'. NOTE: This property will not be serialized. It can only be populated by the server.
connectionType

Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.
egressBytesTransferred

The egress bytes transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server.
enableBgp

EnableBgp flag
etag

Gets a unique read-only string that changes whenever the resource is updated.
expressRouteGatewayBypass

Bypass ExpressRoute Gateway for data forwarding
ingressBytesTransferred

The ingress bytes transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server.
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 VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.
resourceGuid

The resource GUID property of the VirtualNetworkGatewayConnection resource.
routingWeight

The routing weight.
sharedKey

The IPSec shared key.
tunnelConnectionStatus

Collection of all tunnels' connection health status. NOTE: This property will not be serialized. It can only be populated by the server.
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

connectionProtocol

Connection protocol used for this connection

connectionProtocol?: string

Property Value

string

connectionStatus

Virtual network Gateway connection status. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'. NOTE: This property will not be serialized. It can only be populated by the server.

connectionStatus?: string

Property Value

string

connectionType

Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.

connectionType: string

Property Value

string

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

enableBgp

EnableBgp flag

enableBgp?: boolean

Property Value

boolean

etag

Gets a unique read-only string that changes whenever the resource is updated.

etag?: string

Property Value

string

expressRouteGatewayBypass

Bypass ExpressRoute Gateway for data forwarding

expressRouteGatewayBypass?: boolean

Property Value

boolean

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

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 VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. 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 VirtualNetworkGatewayConnection resource.

resourceGuid?: string

Property Value

string

routingWeight

The routing weight.

routingWeight?: number

Property Value

number

sharedKey

The IPSec shared key.

sharedKey?: string

Property Value

string

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[]

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