Share via

VpnSiteLinkConnection interface

Package:
@azure/arm-network

VpnSiteLinkConnection 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

Dead Peer Detection timeout in seconds for VpnLink connection.
egressBytesTransferred

Egress bytes transferred. NOTE: This property will not be serialized. It can only be populated by the server.
egressNatRules

List of egress NatRules.
enableBgp

EnableBgp flag.
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.
ingressNatRules

List of ingress NatRules.
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 site link connection resource. NOTE: This property will not be serialized. It can only be populated by the server.
routingWeight

Routing weight for vpn connection.
sharedKey

SharedKey for the vpn link connection. We will no longer return sharedKey in any Create/Update/Get/List/UpdateTags VpnGateway/VpnConnection/VpnLinkConnection APIs response. Please use 'Vpn Link Connections - List Default Shared Key' API to fetch Vpn link connection sharedKey.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.
useLocalAzureIpAddress

Use local azure ip to initiate connection.
usePolicyBasedTrafficSelectors

Enable policy-based traffic selectors.
vpnConnectionProtocolType

Connection protocol used for this connection.
vpnGatewayCustomBgpAddresses

vpnGatewayCustomBgpAddresses used by this connection.
vpnLinkConnectionMode

Vpn link connection mode.
vpnSiteLink

Id of the connected vpn site link.

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

Dead Peer Detection timeout in seconds for VpnLink 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

egressNatRules

List of egress NatRules.

egressNatRules?: SubResource[]

Property Value

SubResource[]

enableBgp

EnableBgp flag.

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

ingressNatRules

List of ingress NatRules.

ingressNatRules?: SubResource[]

Property Value

SubResource[]

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 site link connection resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

routingWeight

Routing weight for vpn connection.

routingWeight?: number

Property Value

number

sharedKey

SharedKey for the vpn link connection. We will no longer return sharedKey in any Create/Update/Get/List/UpdateTags VpnGateway/VpnConnection/VpnLinkConnection APIs response. Please use 'Vpn Link Connections - List Default Shared Key' API to fetch Vpn link connection sharedKey.

sharedKey?: string

Property Value

string

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

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

vpnGatewayCustomBgpAddresses

vpnGatewayCustomBgpAddresses used by this connection.

vpnGatewayCustomBgpAddresses?: GatewayCustomBgpIpAddressIpConfiguration[]

Property Value

GatewayCustomBgpIpAddressIpConfiguration[]

vpnLinkConnectionMode

Vpn link connection mode.

vpnLinkConnectionMode?: string

Property Value

string

Id of the connected vpn site link.

vpnSiteLink?: SubResource

Property Value

SubResource

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From SubResource.id