VpnSiteLinkConnection Class

VpnSiteLinkConnection Resource.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.network.models._models_py3.SubResource
VpnSiteLinkConnection

Constructor

VpnSiteLinkConnection(*, id: str | None = None, name: str | None = None, vpn_site_link: _models.SubResource | None = None, routing_weight: int | None = None, vpn_link_connection_mode: str | _models.VpnLinkConnectionMode | None = None, vpn_connection_protocol_type: str | _models.VirtualNetworkGatewayConnectionProtocol | None = None, connection_bandwidth: int | None = None, shared_key: str | None = None, enable_bgp: bool | None = None, vpn_gateway_custom_bgp_addresses: List[_models.GatewayCustomBgpIpAddressIpConfiguration] | None = None, use_policy_based_traffic_selectors: bool | None = None, ipsec_policies: List[_models.IpsecPolicy] | None = None, enable_rate_limiting: bool | None = None, use_local_azure_ip_address: bool | None = None, ingress_nat_rules: List[_models.SubResource] | None = None, egress_nat_rules: List[_models.SubResource] | None = None, dpd_timeout_seconds: int | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
id
str

Resource ID.

name
str

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

vpn_site_link

Id of the connected vpn site link.

routing_weight
int

Routing weight for vpn connection.

vpn_link_connection_mode

Vpn link connection mode. Known values are: "Default", "ResponderOnly", and "InitiatorOnly".

vpn_connection_protocol_type

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

connection_bandwidth
int

Expected bandwidth in MBPS.

shared_key
str

SharedKey for the vpn connection.

enable_bgp

EnableBgp flag.

vpn_gateway_custom_bgp_addresses

vpnGatewayCustomBgpAddresses used by this connection.

use_policy_based_traffic_selectors

Enable policy-based traffic selectors.

ipsec_policies

The IPSec Policies to be considered by this connection.

enable_rate_limiting

EnableBgp flag.

use_local_azure_ip_address

Use local azure ip to initiate connection.

ingress_nat_rules

List of ingress NatRules.

egress_nat_rules

List of egress NatRules.

dpd_timeout_seconds
int

Dead Peer Detection timeout in seconds for VpnLink connection.

Variables

Name Description
id
str

Resource ID.

name
str

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

etag
str

A unique read-only string that changes whenever the resource is updated.

type
str

Resource type.

vpn_site_link

Id of the connected vpn site link.

routing_weight
int

Routing weight for vpn connection.

vpn_link_connection_mode

Vpn link connection mode. Known values are: "Default", "ResponderOnly", and "InitiatorOnly".

connection_status

The connection status. Known values are: "Unknown", "Connecting", "Connected", and "NotConnected".

vpn_connection_protocol_type

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 connection.

enable_bgp

EnableBgp flag.

vpn_gateway_custom_bgp_addresses

vpnGatewayCustomBgpAddresses used by this connection.

use_policy_based_traffic_selectors

Enable policy-based traffic selectors.

ipsec_policies

The IPSec Policies to be considered by this connection.

enable_rate_limiting

EnableBgp flag.

use_local_azure_ip_address

Use local azure ip to initiate connection.

provisioning_state

The provisioning state of the VPN site link connection resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed".

ingress_nat_rules

List of ingress NatRules.

egress_nat_rules

List of egress NatRules.

dpd_timeout_seconds
int

Dead Peer Detection timeout in seconds for VpnLink connection.