VpnConnectionProperties Class

Parameters for VpnConnection.

Constructor

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

Variables

Name	Description
remote_vpn_site	SubResource Id of the connected vpn site.
routing_weight	int Routing weight for vpn connection.
dpd_timeout_seconds	int DPD timeout in seconds for vpn connection.
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 Deprecated: SharedKey for the vpn connection. This is no more used.
enable_bgp	bool EnableBgp flag.
use_policy_based_traffic_selectors	bool Enable policy-based traffic selectors.
ipsec_policies	list[IpsecPolicy] The IPSec Policies to be considered by this connection.
traffic_selector_policies	list[TrafficSelectorPolicy] The Traffic Selector Policies to be considered by this connection.
enable_rate_limiting	bool EnableBgp flag.
enable_internet_security	bool Enable internet security.
use_local_azure_ip_address	bool Use local azure ip to initiate connection.
provisioning_state	str or ProvisioningState The provisioning state of the VPN connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".
vpn_link_connections	list[VpnSiteLinkConnection] List of all vpn site link connections to the gateway.
routing_configuration	RoutingConfiguration The Routing Configuration indicating the associated and propagated route tables on this 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

DPD timeout in seconds for vpn connection.

dpd_timeout_seconds: int | None

egress_bytes_transferred

Egress bytes transferred.

egress_bytes_transferred: int | None

enable_bgp

EnableBgp flag.

enable_bgp: bool | None

enable_internet_security

Enable internet security.

enable_internet_security: bool | None

enable_rate_limiting

EnableBgp flag.

enable_rate_limiting: bool | None

ingress_bytes_transferred

Ingress bytes transferred.

ingress_bytes_transferred: int | 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

remote_vpn_site

Id of the connected vpn site.

remote_vpn_site: _models.SubResource | None

routing_configuration

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

routing_configuration: _models.RoutingConfiguration | None

routing_weight

Routing weight for vpn connection.

routing_weight: int | None

shared_key

SharedKey for the vpn connection. This is no more used.

shared_key: str | None

traffic_selector_policies

The Traffic Selector Policies to be considered by this connection.

traffic_selector_policies: list['_models.TrafficSelectorPolicy'] | 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_link_connections

List of all vpn site link connections to the gateway.

vpn_link_connections: list['_models.VpnSiteLinkConnection'] | None