VpnConnection Class

Reference

VpnConnection Resource.

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

Constructor

VpnConnection(*, id: str | None = None, name: str | None = None, remote_vpn_site: _models.SubResource | None = None, routing_weight: int | None = None, dpd_timeout_seconds: int | 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, use_policy_based_traffic_selectors: bool | None = None, ipsec_policies: List[_models.IpsecPolicy] | None = None, traffic_selector_policies: List[_models.TrafficSelectorPolicy] | None = None, enable_rate_limiting: bool | None = None, enable_internet_security: bool | None = None, use_local_azure_ip_address: bool | None = None, vpn_link_connections: List[_models.VpnSiteLinkConnection] | None = None, routing_configuration: _models.RoutingConfiguration | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
id	str Resource ID. Default value: None
name	str The name of the resource that is unique within a resource group. This name can be used to access the resource. Default value: None
remote_vpn_site	SubResource Id of the connected vpn site. Default value: None
routing_weight	int Routing weight for vpn connection. Default value: None
dpd_timeout_seconds	int DPD timeout in seconds for vpn connection. Default value: None
vpn_connection_protocol_type	str or VirtualNetworkGatewayConnectionProtocol Connection protocol used for this connection. Known values are: "IKEv2" and "IKEv1". Default value: None
connection_bandwidth	int Expected bandwidth in MBPS. Default value: None
shared_key	str SharedKey for the vpn connection. Default value: None
enable_bgp	bool EnableBgp flag. Default value: None
use_policy_based_traffic_selectors	bool Enable policy-based traffic selectors. Default value: None
ipsec_policies	list[IpsecPolicy] The IPSec Policies to be considered by this connection. Default value: None
traffic_selector_policies	list[TrafficSelectorPolicy] The Traffic Selector Policies to be considered by this connection. Default value: None
enable_rate_limiting	bool EnableBgp flag. Default value: None
enable_internet_security	bool Enable internet security. Default value: None
use_local_azure_ip_address	bool Use local azure ip to initiate connection. Default value: None
vpn_link_connections	list[VpnSiteLinkConnection] List of all vpn site link connections to the gateway. Default value: None
routing_configuration	RoutingConfiguration The Routing Configuration indicating the associated and propagated route tables on this connection. Default value: None

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.
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 SharedKey for the vpn connection.
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.

Share via

VpnConnection Class

Constructor

Keyword-Only Parameters

Variables