VpnGatewaysOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:vpn_gateways> attribute.

Inheritance

builtins.object

VpnGatewaysOperations

Constructor

VpnGatewaysOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.
begin_delete	Deletes a virtual wan vpn gateway.
begin_reset	Resets the primary of the vpn gateway in the specified resource group.
begin_start_packet_capture	Starts packet capture on vpn gateway in the specified resource group.
begin_stop_packet_capture	Stops packet capture on vpn gateway in the specified resource group.
begin_update_tags	Updates virtual wan vpn gateway tags.
get	Retrieves the details of a virtual wan vpn gateway.
list	Lists all the VpnGateways in a subscription.
list_by_resource_group	Lists all the VpnGateways in a resource group.

begin_create_or_update

Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.

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

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.
vpn_gateway_parameters Required	VpnGateway or IO[bytes] Parameters supplied to create or Update a virtual wan vpn gateway. Is either a VpnGateway type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[VpnGateway]	An instance of LROPoller that returns either VpnGateway or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a virtual wan vpn gateway.

begin_delete(resource_group_name: str, gateway_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.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_reset

Resets the primary of the vpn gateway in the specified resource group.

begin_reset(resource_group_name: str, gateway_name: str, *, ip_configuration_id: str | None = None, **kwargs: Any) -> LROPoller[VpnGateway]

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.

Keyword-Only Parameters

Name	Description
ip_configuration_id	str VpnGateway ipConfigurationId to specify the gateway instance. Default value is None.

Returns

Type	Description
LROPoller[VpnGateway]	An instance of LROPoller that returns either VpnGateway or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_start_packet_capture

Starts packet capture on vpn gateway in the specified resource group.

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

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.
parameters Required	VpnGatewayPacketCaptureStartParameters or IO[bytes] Vpn gateway packet capture parameters supplied to start packet capture on vpn gateway. Is either a VpnGatewayPacketCaptureStartParameters 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 gateway in the specified resource group.

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

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.
parameters Required	VpnGatewayPacketCaptureStopParameters or IO[bytes] Vpn gateway packet capture parameters supplied to stop packet capture on vpn gateway. Is either a VpnGatewayPacketCaptureStopParameters 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_update_tags

Updates virtual wan vpn gateway tags.

begin_update_tags(resource_group_name: str, gateway_name: str, vpn_gateway_parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VpnGateway]

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.
vpn_gateway_parameters Required	TagsObject or IO[bytes] Parameters supplied to update a virtual wan vpn gateway tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[VpnGateway]	An instance of LROPoller that returns either VpnGateway or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Retrieves the details of a virtual wan vpn gateway.

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

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
VpnGateway	VpnGateway or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Lists all the VpnGateways in a subscription.

list(**kwargs: Any) -> Iterable[VpnGateway]

Returns

Type	Description
ItemPaged[VpnGateway]	An iterator like instance of either VpnGateway or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Lists all the VpnGateways in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[VpnGateway]

Parameters

Name	Description
resource_group_name Required	str The resource group name of the VpnGateway. Required.

Returns

Type	Description
ItemPaged[VpnGateway]	An iterator like instance of either VpnGateway 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'>