VirtualNetworkGatewayConnectionListEntity interface
A common class for general resource information.
- Extends
Properties
authorization |
The authorizationKey. |
connection |
The connection mode for this connection. |
connection |
Connection protocol used for this connection. |
connection |
Virtual Network Gateway connection status. NOTE: This property will not be serialized. It can only be populated by the server. |
connection |
Gateway connection type. |
egress |
The egress bytes transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server. |
enable |
EnableBgp flag. |
enable |
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. |
express |
Bypass ExpressRoute Gateway for data forwarding. |
gateway |
GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection. |
ingress |
The ingress bytes transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server. |
ipsec |
The IPSec Policies to be considered by this connection. |
local |
The reference to local network gateway resource. |
peer | The reference to peerings resource. |
provisioning |
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. |
resource |
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. |
routing |
The routing weight. |
shared |
The IPSec shared key. |
traffic |
The Traffic Selector Policies to be considered by this connection. |
tunnel |
Collection of all tunnels' connection health status. NOTE: This property will not be serialized. It can only be populated by the server. |
use |
Enable policy-based traffic selectors. |
virtual |
The reference to virtual network gateway resource. |
virtual |
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
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
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
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
localNetworkGateway2
The reference to local network gateway resource.
localNetworkGateway2?: VirtualNetworkConnectionGatewayReference
Property Value
peer
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
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
usePolicyBasedTrafficSelectors
Enable policy-based traffic selectors.
usePolicyBasedTrafficSelectors?: boolean
Property Value
boolean
virtualNetworkGateway1
The reference to virtual network gateway resource.
virtualNetworkGateway1: VirtualNetworkConnectionGatewayReference
Property Value
virtualNetworkGateway2
The reference to virtual network gateway resource.
virtualNetworkGateway2?: VirtualNetworkConnectionGatewayReference
Property Value
Inherited Property Details
id
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