VpnConnectionPropertiesOutput interface

Package:

@azure-rest/arm-network

Parameters for VpnConnection.

Properties

connectionBandwidth	Expected bandwidth in MBPS.
connectionStatus	The connection status.
dpdTimeoutSeconds	DPD timeout in seconds for vpn connection.
egressBytesTransferred	Egress bytes transferred.
enableBgp	EnableBgp flag.
enableInternetSecurity	Enable internet security.
enableRateLimiting	EnableBgp flag.
ingressBytesTransferred	Ingress bytes transferred.
ipsecPolicies	The IPSec Policies to be considered by this connection.
provisioningState	The provisioning state of the VPN connection resource.
remoteVpnSite	Id of the connected vpn site.
routingConfiguration	The Routing Configuration indicating the associated and propagated route tables on this connection.
routingWeight	Routing weight for vpn connection.
sharedKey	SharedKey for the vpn connection.
trafficSelectorPolicies	The Traffic Selector Policies to be considered by this connection.
useLocalAzureIpAddress	Use local azure ip to initiate connection.
usePolicyBasedTrafficSelectors	Enable policy-based traffic selectors.
vpnConnectionProtocolType	Connection protocol used for this connection.
vpnLinkConnections	List of all vpn site link connections to the gateway.

Property Details

connectionBandwidth

Expected bandwidth in MBPS.

connectionBandwidth?: number

Property Value

number

connectionStatus

The connection status.

connectionStatus?: "Connected" | "Unknown" | "Connecting" | "NotConnected"

Property Value

"Connected" | "Unknown" | "Connecting" | "NotConnected"

dpdTimeoutSeconds

DPD timeout in seconds for vpn connection.

dpdTimeoutSeconds?: number

Property Value

number

egressBytesTransferred

Egress bytes transferred.

egressBytesTransferred?: number

Property Value

number

enableBgp

EnableBgp flag.

enableBgp?: boolean

Property Value

boolean

enableInternetSecurity

Enable internet security.

enableInternetSecurity?: boolean

Property Value

boolean

enableRateLimiting

EnableBgp flag.

enableRateLimiting?: boolean

Property Value

boolean

ingressBytesTransferred

Ingress bytes transferred.

ingressBytesTransferred?: number

Property Value

number

ipsecPolicies

The IPSec Policies to be considered by this connection.

ipsecPolicies?: IpsecPolicyOutput[]

Property Value

IpsecPolicyOutput[]

provisioningState

The provisioning state of the VPN connection resource.

provisioningState?: "Succeeded" | "Updating" | "Deleting" | "Failed"

Property Value

"Succeeded" | "Updating" | "Deleting" | "Failed"

remoteVpnSite

Id of the connected vpn site.

remoteVpnSite?: SubResourceOutput

Property Value

SubResourceOutput

routingConfiguration

The Routing Configuration indicating the associated and propagated route tables on this connection.

routingConfiguration?: RoutingConfigurationOutput

Property Value

RoutingConfigurationOutput

routingWeight

Routing weight for vpn connection.

routingWeight?: number

Property Value

number

sharedKey

SharedKey for the vpn connection.

sharedKey?: string

Property Value

string

trafficSelectorPolicies

The Traffic Selector Policies to be considered by this connection.

trafficSelectorPolicies?: TrafficSelectorPolicyOutput[]

Property Value

TrafficSelectorPolicyOutput[]

useLocalAzureIpAddress

Use local azure ip to initiate connection.

useLocalAzureIpAddress?: boolean

Property Value

boolean

usePolicyBasedTrafficSelectors

Enable policy-based traffic selectors.

usePolicyBasedTrafficSelectors?: boolean

Property Value

boolean

vpnConnectionProtocolType

Connection protocol used for this connection.

vpnConnectionProtocolType?: "IKEv2" | "IKEv1"

Property Value

"IKEv2" | "IKEv1"

vpnLinkConnections

List of all vpn site link connections to the gateway.

vpnLinkConnections?: VpnSiteLinkConnectionOutput[]

Property Value

VpnSiteLinkConnectionOutput[]