VpnSitesOperations Class

VpnSitesOperations 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

VpnSitesOperations

Constructor

VpnSitesOperations(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 VpnSite resource if it doesn't exist else updates the existing VpnSite.
begin_delete	Deletes a VpnSite.
begin_update_tags	Updates VpnSite tags.
get	Retrieves the details of a VPN site.
list	Lists all the VpnSites in a subscription.
list_by_resource_group	Lists all the vpnSites in a resource group.

begin_create_or_update

Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.

begin_create_or_update(resource_group_name: str, vpn_site_name: str, vpn_site_parameters: azure.mgmt.network.v2019_02_01.models._models_py3.VpnSite, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.VpnSite')]

Parameters

resource_group_name

str

Required

The resource group name of the VpnSite.

vpn_site_name

str

Required

The name of the VpnSite being created or updated.

vpn_site_parameters

VpnSite

Required

Parameters supplied to create or update VpnSite.

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

Return type

AsyncLROPoller[VpnSite]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes a VpnSite.

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

Parameters

resource_group_name

str

Required

The resource group name of the VpnSite.

vpn_site_name

str

Required

The name of the VpnSite being deleted.

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 VpnSite tags.

begin_update_tags(resource_group_name: str, vpn_site_name: str, vpn_site_parameters: azure.mgmt.network.v2019_02_01.models._models_py3.TagsObject, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.VpnSite')]

Parameters

resource_group_name

str

Required

The resource group name of the VpnSite.

vpn_site_name

str

Required

The name of the VpnSite being updated.

vpn_site_parameters

TagsObject

Required

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

Return type

AsyncLROPoller[VpnSite]

Exceptions

~azure.core.exceptions.HttpResponseError

get

Retrieves the details of a VPN site.

get(resource_group_name: str, vpn_site_name: str, **kwargs) -> azure.mgmt.network.v2019_02_01.models._models_py3.VpnSite

Parameters

resource_group_name

str

Required

The resource group name of the VpnSite.

vpn_site_name

str

Required

The name of the VpnSite being retrieved.

cls

callable

Required

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

Returns

VpnSite, or the result of cls(response)

Return type

VpnSite

Exceptions

~azure.core.exceptions.HttpResponseError

list

Lists all the VpnSites in a subscription.

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

Parameters

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[ListVpnSitesResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_by_resource_group

Lists all the vpnSites in a resource group.

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

Parameters

resource_group_name

str

Required

The resource group name of the VpnSite.

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[ListVpnSitesResult]

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

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