VpnConnection Class

VpnConnection Resource.

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

Inheritance
azure.mgmt.network.v2018_11_01.models._models_py3.SubResource
VpnConnection

Constructor

VpnConnection(*, id: typing.Union[str, NoneType] = None, name: typing.Union[str, NoneType] = None, remote_vpn_site: typing.Union[_ForwardRef('SubResource'), NoneType] = None, routing_weight: typing.Union[int, NoneType] = None, vpn_connection_protocol_type: typing.Union[str, _ForwardRef('VirtualNetworkGatewayConnectionProtocol'), NoneType] = None, connection_bandwidth: typing.Union[int, NoneType] = None, shared_key: typing.Union[str, NoneType] = None, enable_bgp: typing.Union[bool, NoneType] = None, ipsec_policies: typing.Union[typing.List[_ForwardRef('IpsecPolicy')], NoneType] = None, enable_rate_limiting: typing.Union[bool, NoneType] = None, enable_internet_security: typing.Union[bool, NoneType] = None, provisioning_state: typing.Union[str, _ForwardRef('ProvisioningState'), NoneType] = None, **kwargs)

Parameters

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.

remote_vpn_site
SubResource

Id of the connected vpn site.

routing_weight
int

routing weight for vpn connection.

vpn_connection_protocol_type
str or VirtualNetworkGatewayConnectionProtocol

Connection protocol used for this connection. Possible values include: "IKEv2", "IKEv1".

connection_bandwidth
int

Expected bandwidth in MBPS.

shared_key
str

SharedKey for the vpn connection.

enable_bgp
bool

EnableBgp flag.

ipsec_policies
list[IpsecPolicy]

The IPSec Policies to be considered by this connection.

enable_rate_limiting
bool

EnableBgp flag.

enable_internet_security
bool

Enable internet security.

provisioning_state
str or ProvisioningState

The provisioning state of the resource. Possible values include: "Succeeded", "Updating", "Deleting", "Failed".

Variables

etag
str

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

connection_status
str or VpnConnectionStatus

The connection status. Possible values include: "Unknown", "Connecting", "Connected", "NotConnected".

ingress_bytes_transferred
<xref:long>

Ingress bytes transferred.

egress_bytes_transferred
<xref:long>

Egress bytes transferred.