VpnSiteLinkConnectionProperties Class

Parameters for VpnConnection.

Constructor

VpnSiteLinkConnectionProperties(*args: Any, **kwargs: Any)

Variables

Name Description
vpn_site_link
SubResource

Id of the connected vpn site link.
routing_weight
int

Routing weight for vpn connection.
vpn_link_connection_mode
str or VpnLinkConnectionMode

Vpn link connection mode. Known values are: "Default", "ResponderOnly", and "InitiatorOnly".
connection_status
str or VpnConnectionStatus

The connection status. Known values are: "Unknown", "Connecting", "Connected", and "NotConnected".
vpn_connection_protocol_type
str or VirtualNetworkGatewayConnectionProtocol

Connection protocol used for this connection. Known values are: "IKEv2" and "IKEv1".
ingress_bytes_transferred
int

Ingress bytes transferred.
egress_bytes_transferred
int

Egress bytes transferred.
connection_bandwidth
int

Expected bandwidth in MBPS.
shared_key
str

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.
enable_bgp
bool

EnableBgp flag.
vpn_gateway_custom_bgp_addresses
list[GatewayCustomBgpIpAddressIpConfiguration]

vpnGatewayCustomBgpAddresses used by this connection.
use_policy_based_traffic_selectors
bool

Enable policy-based traffic selectors.
ipsec_policies
list[IpsecPolicy]

The IPSec Policies to be considered by this connection.
enable_rate_limiting
bool

EnableBgp flag.
use_local_azure_ip_address
bool

Use local azure ip to initiate connection.
provisioning_state
str or ProvisioningState

The provisioning state of the VPN site link connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".
ingress_nat_rules
list[SubResource]

List of ingress NatRules.
egress_nat_rules
list[SubResource]

List of egress NatRules.
dpd_timeout_seconds
int

Dead Peer Detection timeout in seconds for VpnLink connection.

Attributes

connection_bandwidth

Expected bandwidth in MBPS.

connection_bandwidth: int | None

connection_status

"Unknown", "Connecting", "Connected", and "NotConnected".

connection_status: str | _models.VpnConnectionStatus | None

dpd_timeout_seconds

Dead Peer Detection timeout in seconds for VpnLink connection.

dpd_timeout_seconds: int | None

egress_bytes_transferred

Egress bytes transferred.

egress_bytes_transferred: int | None

egress_nat_rules

List of egress NatRules.

egress_nat_rules: list['_models.SubResource'] | None

enable_bgp

EnableBgp flag.

enable_bgp: bool | None

enable_rate_limiting

EnableBgp flag.

enable_rate_limiting: bool | None

ingress_bytes_transferred

Ingress bytes transferred.

ingress_bytes_transferred: int | None

ingress_nat_rules

List of ingress NatRules.

ingress_nat_rules: list['_models.SubResource'] | None

ipsec_policies

The IPSec Policies to be considered by this connection.

ipsec_policies: list['_models.IpsecPolicy'] | None

provisioning_state

"Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".

provisioning_state: str | _models.ProvisioningState | None

routing_weight

Routing weight for vpn connection.

routing_weight: int | None

shared_key

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.

shared_key: str | None

use_local_azure_ip_address

Use local azure ip to initiate connection.

use_local_azure_ip_address: bool | None

use_policy_based_traffic_selectors

Enable policy-based traffic selectors.

use_policy_based_traffic_selectors: bool | None

vpn_connection_protocol_type

"IKEv2" and "IKEv1".

vpn_connection_protocol_type: str | _models.VirtualNetworkGatewayConnectionProtocol | None

vpn_gateway_custom_bgp_addresses

vpnGatewayCustomBgpAddresses used by this connection.

vpn_gateway_custom_bgp_addresses: list['_models.GatewayCustomBgpIpAddressIpConfiguration'] | None

"Default", "ResponderOnly", and "InitiatorOnly".

vpn_link_connection_mode: str | _models.VpnLinkConnectionMode | None

Id of the connected vpn site link.

vpn_site_link: _models.SubResource | None