Share via

VpnConnectionsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:vpn_connections> attribute.

Inheritance
builtins.object
VpnConnectionsOperations

Constructor

VpnConnectionsOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.
begin_delete

Deletes a vpn connection.
begin_start_packet_capture

Starts packet capture on Vpn connection in the specified resource group.
begin_stop_packet_capture

Stops packet capture on Vpn connection in the specified resource group.
get

Retrieves the details of a vpn connection.
list_by_vpn_gateway

Retrieves all vpn connections for a particular virtual wan vpn gateway.

begin_create_or_update

Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.

begin_create_or_update(resource_group_name: str, gateway_name: str, connection_name: str, vpn_connection_parameters: _models.VpnConnection, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VpnConnection]

Parameters

Name Description
resource_group_name
Required
str

The resource group name of the VpnGateway. Required.
gateway_name
Required
str

The name of the gateway. Required.
connection_name
Required
str

The name of the connection. Required.
vpn_connection_parameters
Required
VpnConnection or IO[bytes]

Parameters supplied to create or Update a VPN Connection. Is either a VpnConnection type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[VpnConnection]

An instance of LROPoller that returns either VpnConnection or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes a vpn connection.

begin_delete(resource_group_name: str, gateway_name: str, connection_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The resource group name of the VpnGateway. Required.
gateway_name
Required
str

The name of the gateway. Required.
connection_name
Required
str

The name of the connection. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_start_packet_capture

Starts packet capture on Vpn connection in the specified resource group.

begin_start_packet_capture(resource_group_name: str, gateway_name: str, vpn_connection_name: str, parameters: _models.VpnConnectionPacketCaptureStartParameters | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[str]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
gateway_name
Required
str

The name of the gateway. Required.
vpn_connection_name
Required
str

The name of the vpn connection. Required.
parameters
Required
VpnConnectionPacketCaptureStartParameters or IO[bytes]

Vpn Connection packet capture parameters supplied to start packet capture on gateway connection. Is either a VpnConnectionPacketCaptureStartParameters type or a IO[bytes] type. Default value is None.

Returns

Type Description
LROPoller[str]

An instance of LROPoller that returns either str or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_stop_packet_capture

Stops packet capture on Vpn connection in the specified resource group.

begin_stop_packet_capture(resource_group_name: str, gateway_name: str, vpn_connection_name: str, parameters: _models.VpnConnectionPacketCaptureStopParameters | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[str]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
gateway_name
Required
str

The name of the gateway. Required.
vpn_connection_name
Required
str

The name of the vpn connection. Required.
parameters
Required
VpnConnectionPacketCaptureStopParameters or IO[bytes]

Vpn Connection packet capture parameters supplied to stop packet capture on gateway connection. Is either a VpnConnectionPacketCaptureStopParameters type or a IO[bytes] type. Default value is None.

Returns

Type Description
LROPoller[str]

An instance of LROPoller that returns either str or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Retrieves the details of a vpn connection.

get(resource_group_name: str, gateway_name: str, connection_name: str, **kwargs: Any) -> VpnConnection

Parameters

Name Description
resource_group_name
Required
str

The resource group name of the VpnGateway. Required.
gateway_name
Required
str

The name of the gateway. Required.
connection_name
Required
str

The name of the vpn connection. Required.

Returns

Type Description
VpnConnection

VpnConnection or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_vpn_gateway

Retrieves all vpn connections for a particular virtual wan vpn gateway.

list_by_vpn_gateway(resource_group_name: str, gateway_name: str, **kwargs: Any) -> Iterable[VpnConnection]

Parameters

Name Description
resource_group_name
Required
str

The resource group name of the VpnGateway. Required.
gateway_name
Required
str

The name of the gateway. Required.

Returns

Type Description
ItemPaged[VpnConnection]

An iterator like instance of either VpnConnection or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.network.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>