VirtualNetworkGatewayConnectionPropertiesFormat interface
VirtualNetworkGatewayConnection properties.
Properties
| authorization |
The authorizationKey. |
| connection |
The connection mode for this connection. |
| connection |
Connection protocol used for this connection. |
| connection |
Gateway connection type. |
| dpd |
The dead peer detection timeout of this connection in seconds. |
| egress |
List of egress NatRules. |
| enable |
EnableBgp flag. |
| enable |
Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled. |
| express |
Bypass ExpressRoute Gateway for data forwarding. |
| gateway |
GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection. |
| ingress |
List of ingress NatRules. |
| ipsec |
The IPSec Policies to be considered by this connection. |
| local |
The reference to local network gateway resource. |
| peer | The reference to peerings resource. |
| routing |
The routing weight. |
| shared |
The IPSec shared key. |
| traffic |
The Traffic Selector Policies to be considered by this connection. |
| use |
Use private local Azure IP for the connection. |
| use |
Enable policy-based traffic selectors. |
| virtual |
The reference to virtual network gateway resource. |
| virtual |
The reference to virtual network gateway resource. |
Property Details
authorizationKey
The authorizationKey.
authorizationKey?: string
Property Value
string
connectionMode
The connection mode for this connection.
connectionMode?: "Default" | "ResponderOnly" | "InitiatorOnly"
Property Value
"Default" | "ResponderOnly" | "InitiatorOnly"
connectionProtocol
Connection protocol used for this connection.
connectionProtocol?: "IKEv2" | "IKEv1"
Property Value
"IKEv2" | "IKEv1"
connectionType
Gateway connection type.
connectionType: "ExpressRoute" | "IPsec" | "Vnet2Vnet" | "VPNClient"
Property Value
"ExpressRoute" | "IPsec" | "Vnet2Vnet" | "VPNClient"
dpdTimeoutSeconds
The dead peer detection timeout of this connection in seconds.
dpdTimeoutSeconds?: number
Property Value
number
egressNatRules
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
ingressNatRules
ipsecPolicies
The IPSec Policies to be considered by this connection.
ipsecPolicies?: IpsecPolicy[]
Property Value
localNetworkGateway2
The reference to local network gateway resource.
localNetworkGateway2?: LocalNetworkGateway
Property Value
peer
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
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
virtualNetworkGateway2
The reference to virtual network gateway resource.
virtualNetworkGateway2?: VirtualNetworkGateway