VpnConnectionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:vpn_connections> attribute.

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 name of the resource group. The name is case insensitive. Required.
gateway_name Required	str The name of the vpn gateway. Required.
connection_name Required	str The name of the vpn connection. Required.
vpn_connection_parameters Required	VpnConnection or <xref:JSON> or IO[bytes] Parameters supplied to create or Update a VPN Connection. Is one of the following types: VpnConnection, JSON, IO[bytes] Required.

Returns

Type	Description
LROPoller[VpnConnection]	An instance of LROPoller that returns VpnConnection. The VpnConnection is compatible with MutableMapping

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 name of the resource group. The name is case insensitive. Required.
gateway_name Required	str The name of the vpn gateway. Required.
connection_name Required	str The name of the vpn connection. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

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. The name is case insensitive. Required.
gateway_name Required	str The name of the vpn gateway. Required.
vpn_connection_name Required	str The name of the vpn connection. Required.
parameters	VpnConnectionPacketCaptureStartParameters or <xref:JSON> or IO[bytes] Vpn Connection packet capture parameters supplied to start packet capture on gateway connection. Is one of the following types: VpnConnectionPacketCaptureStartParameters, JSON, IO[bytes] Default value is None. Default value: None

Returns

Type	Description
LROPoller[str]	An instance of LROPoller that returns str

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. The name is case insensitive. Required.
gateway_name Required	str The name of the vpn gateway. Required.
vpn_connection_name Required	str The name of the vpn connection. Required.
parameters	VpnConnectionPacketCaptureStopParameters or <xref:JSON> or IO[bytes] Vpn Connection packet capture parameters supplied to stop packet capture on gateway connection. Is one of the following types: VpnConnectionPacketCaptureStopParameters, JSON, IO[bytes] Default value is None. Default value: None

Returns

Type	Description
LROPoller[str]	An instance of LROPoller that returns str

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 name of the resource group. The name is case insensitive. Required.
gateway_name Required	str The name of the vpn gateway. Required.
connection_name Required	str The name of the vpn connection. Required.

Returns

Type	Description
VpnConnection	VpnConnection. The VpnConnection is compatible with MutableMapping

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) -> ItemPaged[VpnConnection]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
gateway_name Required	str The name of the gateway. Required.

Returns

Type	Description
ItemPaged[VpnConnection]	An iterator like instance of VpnConnection

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?