VpnConnectionsOperations Class

VpnConnectionsOperations 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
VpnConnectionsOperations

Constructor

VpnConnectionsOperations(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 vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.

begin_delete

Deletes a vpn connection.

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: azure.mgmt.network.v2019_04_01.models._models_py3.VpnConnection, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.VpnConnection')]

Parameters

resource_group_name
str
Required

The resource group name of the VpnGateway.

gateway_name
str
Required

The name of the gateway.

connection_name
str
Required

The name of the connection.

vpn_connection_parameters
VpnConnection
Required

Parameters supplied to create or Update a VPN Connection.

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

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes a vpn connection.

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

connection_name
str
Required

The name of the connection.

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

Exceptions

~azure.core.exceptions.HttpResponseError

get

Retrieves the details of a vpn connection.

get(resource_group_name: str, gateway_name: str, connection_name: str, **kwargs) -> azure.mgmt.network.v2019_04_01.models._models_py3.VpnConnection

Parameters

resource_group_name
str
Required

The resource group name of the VpnGateway.

gateway_name
str
Required

The name of the gateway.

connection_name
str
Required

The name of the vpn connection.

cls
callable
Required

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

Returns

VpnConnection, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.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) -> typing.AsyncIterable[_ForwardRef('models.ListVpnConnectionsResult')]

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

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

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

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