VpnGatewaysOperations Class

VpnGatewaysOperations 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

VpnGatewaysOperations

Constructor

VpnGatewaysOperations(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 vpn gateway if it doesn't exist else updates the existing gateway.
begin_delete	Deletes a virtual wan vpn gateway.
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: azure.mgmt.network.v2018_08_01.models._models_py3.VpnGateway, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.VpnGateway')]

Parameters

resource_group_name

str

Required

The resource group name of the VpnGateway.

gateway_name

str

Required

The name of the gateway.

vpn_gateway_parameters

VpnGateway

Required

Parameters supplied to create or Update a virtual wan 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 VpnGateway or the result of cls(response)

Return type

AsyncLROPoller[VpnGateway]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes a virtual wan 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 VpnGateway.

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_update_tags

Updates virtual wan vpn gateway tags.

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

Parameters

resource_group_name

str

Required

The resource group name of the VpnGateway.

gateway_name

str

Required

The name of the gateway.

vpn_gateway_parameters

TagsObject

Required

Parameters supplied to update a virtual wan 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 VpnGateway or the result of cls(response)

Return type

AsyncLROPoller[VpnGateway]

Exceptions

~azure.core.exceptions.HttpResponseError

get

Retrieves the details of a virtual wan vpn gateway.

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

Parameters

resource_group_name

str

Required

The resource group name of the VpnGateway.

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

VpnGateway, or the result of cls(response)

Return type

VpnGateway

Exceptions

~azure.core.exceptions.HttpResponseError

list

Lists all the VpnGateways in a subscription.

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

Parameters

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[ListVpnGatewaysResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_by_resource_group

Lists all the VpnGateways in a resource group.

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

Parameters

resource_group_name

str

Required

The resource group name of the VpnGateway.

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[ListVpnGatewaysResult]

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

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