VirtualNetworkGatewayConnectionsOperations Class

VirtualNetworkGatewayConnectionsOperations 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

VirtualNetworkGatewayConnectionsOperations

Constructor

VirtualNetworkGatewayConnectionsOperations(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 or updates a virtual network gateway connection in the specified resource group.
begin_delete	Deletes the specified virtual network Gateway connection.
begin_reset_shared_key	The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.
begin_set_shared_key	The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.
begin_update_tags	Updates a virtual network gateway connection tags.
get	Gets the specified virtual network gateway connection by resource group.
get_shared_key	The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.
list	The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.

begin_create_or_update

Creates or updates a virtual network gateway connection in the specified resource group.

begin_create_or_update(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: azure.mgmt.network.v2017_09_01.models._models_py3.VirtualNetworkGatewayConnection, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.VirtualNetworkGatewayConnection')]

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_gateway_connection_name

str

Required

The name of the virtual network gateway connection.

parameters

VirtualNetworkGatewayConnection

Required

Parameters supplied to the create or update virtual network gateway connection 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 VirtualNetworkGatewayConnection or the result of cls(response)

Return type

AsyncLROPoller[VirtualNetworkGatewayConnection]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes the specified virtual network Gateway connection.

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

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_gateway_connection_name

str

Required

The name of the virtual network gateway 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

AsyncLROPoller[None]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_reset_shared_key

The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

begin_reset_shared_key(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: azure.mgmt.network.v2017_09_01.models._models_py3.ConnectionResetSharedKey, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.ConnectionResetSharedKey')]

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_gateway_connection_name

str

Required

The virtual network gateway connection reset shared key Name.

parameters

ConnectionResetSharedKey

Required

Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider.

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

Return type

AsyncLROPoller[ConnectionResetSharedKey]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_set_shared_key

The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

begin_set_shared_key(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: azure.mgmt.network.v2017_09_01.models._models_py3.ConnectionSharedKey, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.ConnectionSharedKey')]

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_gateway_connection_name

str

Required

The virtual network gateway connection name.

parameters

ConnectionSharedKey

Required

Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider.

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

Return type

AsyncLROPoller[ConnectionSharedKey]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_update_tags

Updates a virtual network gateway connection tags.

begin_update_tags(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: azure.mgmt.network.v2017_09_01.models._models_py3.TagsObject, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.VirtualNetworkGatewayConnectionListEntity')]

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_gateway_connection_name

str

Required

The name of the virtual network gateway connection.

parameters

TagsObject

Required

Parameters supplied to update virtual network gateway connection 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 VirtualNetworkGatewayConnectionListEntity or the result of cls(response)

Return type

AsyncLROPoller[VirtualNetworkGatewayConnectionListEntity]

Exceptions

~azure.core.exceptions.HttpResponseError

get

Gets the specified virtual network gateway connection by resource group.

get(resource_group_name: str, virtual_network_gateway_connection_name: str, **kwargs) -> azure.mgmt.network.v2017_09_01.models._models_py3.VirtualNetworkGatewayConnection

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_gateway_connection_name

str

Required

The name of the virtual network gateway connection.

cls

callable

Required

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

Returns

VirtualNetworkGatewayConnection, or the result of cls(response)

Return type

VirtualNetworkGatewayConnection

Exceptions

~azure.core.exceptions.HttpResponseError

get_shared_key

The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.

get_shared_key(resource_group_name: str, virtual_network_gateway_connection_name: str, **kwargs) -> azure.mgmt.network.v2017_09_01.models._models_py3.ConnectionSharedKey

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_gateway_connection_name

str

Required

The virtual network gateway connection shared key name.

cls

callable

Required

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

Returns

ConnectionSharedKey, or the result of cls(response)

Return type

ConnectionSharedKey

Exceptions

~azure.core.exceptions.HttpResponseError

list

The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.

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

Parameters

resource_group_name

str

Required

The name of the resource group.

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[VirtualNetworkGatewayConnectionListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

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