P2SVpnGatewaysOperations Class

P2SVpnGatewaysOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

P2SVpnGatewaysOperations

Constructor

P2SVpnGatewaysOperations(client, config, serializer, deserializer) -> None

Parameters

client

Client for service requests.

config

Configuration of service client.

serializer

An object model serializer.

deserializer

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create_or_update	Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.
begin_delete	Deletes a virtual wan p2s vpn gateway.
begin_generate_vpn_profile	Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.
begin_get_p2_s_vpn_connection_health	Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.
begin_update_tags	Updates virtual wan p2s vpn gateway tags.
get	Retrieves the details of a virtual wan p2s vpn gateway.
list	Lists all the P2SVpnGateways in a subscription.
list_by_resource_group	Lists all the P2SVpnGateways in a resource group.

begin_create_or_update

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

begin_create_or_update(resource_group_name: str, gateway_name: str, p2_s_vpn_gateway_parameters: azure.mgmt.network.v2019_06_01.models._models_py3.P2SVpnGateway, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.P2SVpnGateway')]

Parameters

resource_group_name

str

Required

The resource group name of the P2SVpnGateway.

gateway_name

str

Required

The name of the gateway.

p2_s_vpn_gateway_parameters

P2SVpnGateway

Required

Parameters supplied to create or Update a virtual wan p2s vpn gateway.

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either P2SVpnGateway or the result of cls(response)

Return type

AsyncLROPoller[P2SVpnGateway]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes a virtual wan p2s vpn gateway.

begin_delete(resource_group_name: str, gateway_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name

str

Required

The resource group name of the P2SVpnGateway.

gateway_name

str

Required

The name of the gateway.

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[None]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_generate_vpn_profile

Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.

begin_generate_vpn_profile(resource_group_name: str, gateway_name: str, parameters: azure.mgmt.network.v2019_06_01.models._models_py3.P2SVpnProfileParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.VpnProfileResponse')]

Parameters

resource_group_name

str

Required

The name of the resource group.

gateway_name

str

Required

The name of the P2SVpnGateway.

parameters

P2SVpnProfileParameters

Required

Parameters supplied to the generate P2SVpnGateway VPN client package operation.

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either VpnProfileResponse or the result of cls(response)

Return type

AsyncLROPoller[VpnProfileResponse]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_get_p2_s_vpn_connection_health

Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.

begin_get_p2_s_vpn_connection_health(resource_group_name: str, gateway_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.P2SVpnGateway')]

Parameters

resource_group_name

str

Required

The name of the resource group.

gateway_name

str

Required

The name of the P2SVpnGateway.

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either P2SVpnGateway or the result of cls(response)

Return type

AsyncLROPoller[P2SVpnGateway]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_update_tags

Updates virtual wan p2s vpn gateway tags.

begin_update_tags(resource_group_name: str, gateway_name: str, p2_s_vpn_gateway_parameters: azure.mgmt.network.v2019_06_01.models._models_py3.TagsObject, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.P2SVpnGateway')]

Parameters

resource_group_name

str

Required

The resource group name of the P2SVpnGateway.

gateway_name

str

Required

The name of the gateway.

p2_s_vpn_gateway_parameters

TagsObject

Required

Parameters supplied to update a virtual wan p2s vpn gateway tags.

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either P2SVpnGateway or the result of cls(response)

Return type

AsyncLROPoller[P2SVpnGateway]

Exceptions

~azure.core.exceptions.HttpResponseError

get

Retrieves the details of a virtual wan p2s vpn gateway.

get(resource_group_name: str, gateway_name: str, **kwargs) -> azure.mgmt.network.v2019_06_01.models._models_py3.P2SVpnGateway

Parameters

resource_group_name

str

Required

The resource group name of the P2SVpnGateway.

gateway_name

str

Required

The name of the gateway.

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

P2SVpnGateway, or the result of cls(response)

Return type

P2SVpnGateway

Exceptions

~azure.core.exceptions.HttpResponseError

list

Lists all the P2SVpnGateways in a subscription.

list(**kwargs) -> typing.AsyncIterable[_ForwardRef('models.ListP2SVpnGatewaysResult')]

Parameters

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[ListP2SVpnGatewaysResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_by_resource_group

Lists all the P2SVpnGateways in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs) -> typing.AsyncIterable[_ForwardRef('models.ListP2SVpnGatewaysResult')]

Parameters

resource_group_name

str

Required

The resource group name of the P2SVpnGateway.

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[ListP2SVpnGatewaysResult]

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.v2019_06_01.models' from 'c:\\repo\\venv\\lib\\site-packages\\azure\\mgmt\\network\\v2019_06_01\\models\\__init__.py'>