VpnConnection interface

Package:

@azure/arm-network

VpnConnection Resource.

Extends

SubResource

Properties

connectionBandwidth	Expected bandwidth in MBPS.
connectionStatus	The connection status. NOTE: This property will not be serialized. It can only be populated by the server.
dpdTimeoutSeconds	DPD timeout in seconds for vpn connection.
egressBytesTransferred	Egress bytes transferred. NOTE: This property will not be serialized. It can only be populated by the server.
enableBgp	EnableBgp flag.
enableInternetSecurity	Enable internet security.
enableRateLimiting	EnableBgp flag.
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.
ingressBytesTransferred	Ingress bytes transferred. 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.
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.
provisioningState	The provisioning state of the VPN connection resource. NOTE: This property will not be serialized. It can only be populated by the server.
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.

Inherited Properties

id	Resource ID.

Property Details

connectionBandwidth

Expected bandwidth in MBPS.

connectionBandwidth?: number

Property Value

number

connectionStatus

The connection status. NOTE: This property will not be serialized. It can only be populated by the server.

connectionStatus?: string

Property Value

string

dpdTimeoutSeconds

DPD timeout in seconds for vpn connection.

dpdTimeoutSeconds?: number

Property Value

number

egressBytesTransferred

Egress bytes transferred. 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

enableInternetSecurity

Enable internet security.

enableInternetSecurity?: boolean

Property Value

boolean

enableRateLimiting

EnableBgp flag.

enableRateLimiting?: 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

ingressBytesTransferred

Ingress bytes transferred. 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[]

name

The name of the resource that is unique within a resource group. This name can be used to access the resource.

name?: string

Property Value

string

provisioningState

The provisioning state of the VPN connection resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

remoteVpnSite

Id of the connected vpn site.

remoteVpnSite?: SubResource

Property Value

SubResource

routingConfiguration

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

routingConfiguration?: RoutingConfiguration

Property Value

RoutingConfiguration

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?: TrafficSelectorPolicy[]

Property Value

TrafficSelectorPolicy[]

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?: string

Property Value

string

vpnLinkConnections

List of all vpn site link connections to the gateway.

vpnLinkConnections?: VpnSiteLinkConnection[]

Property Value

VpnSiteLinkConnection[]

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From SubResource.id