VirtualNetworkGatewayConnectionsOperations Class

Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:virtual_network_gateway_connections> attribute.

Inheritance: builtins.object

VirtualNetworkGatewayConnectionsOperations

Constructor

VirtualNetworkGatewayConnectionsOperations(*args, **kwargs)

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_get_ike_sas	Lists IKE Security Associations for the virtual network gateway connection in the specified resource group.
begin_reset_connection	Resets the virtual network gateway connection specified.
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_start_packet_capture	Starts packet capture on virtual network gateway connection in the specified resource group.
begin_stop_packet_capture	Stops packet capture on virtual network gateway connection in the specified resource group.
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: _models.VirtualNetworkGatewayConnection, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualNetworkGatewayConnection]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_connection_name Required	str The name of the virtual network gateway connection. Required.
parameters Required	VirtualNetworkGatewayConnection or IO[bytes] Parameters supplied to the create or update virtual network gateway connection operation. Is either a VirtualNetworkGatewayConnection type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[VirtualNetworkGatewayConnection]	An instance of LROPoller that returns either VirtualNetworkGatewayConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified virtual network Gateway connection.

begin_delete(resource_group_name: str, virtual_network_gateway_connection_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_connection_name Required	str The name of the virtual network gateway connection. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_get_ike_sas

Lists IKE Security Associations for the virtual network gateway connection in the specified resource group.

begin_get_ike_sas(resource_group_name: str, virtual_network_gateway_connection_name: str, **kwargs: Any) -> LROPoller[str]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_connection_name Required	str The name of the virtual network gateway Connection. Required.

Returns

Type	Description
LROPoller[str]	An instance of LROPoller that returns either str or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_reset_connection

Resets the virtual network gateway connection specified.

begin_reset_connection(resource_group_name: str, virtual_network_gateway_connection_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_connection_name Required	str The name of the virtual network gateway Connection. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
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: _models.ConnectionResetSharedKey, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ConnectionResetSharedKey]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_connection_name Required	str The virtual network gateway connection reset shared key Name. Required.
parameters Required	ConnectionResetSharedKey or IO[bytes] Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider. Is either a ConnectionResetSharedKey type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[ConnectionResetSharedKey]	An instance of LROPoller that returns either ConnectionResetSharedKey or the result of cls(response)

Exceptions

Type	Description
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: _models.ConnectionSharedKey, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ConnectionSharedKey]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_connection_name Required	str The virtual network gateway connection name. Required.
parameters Required	ConnectionSharedKey or IO[bytes] Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider. Is either a ConnectionSharedKey type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[ConnectionSharedKey]	An instance of LROPoller that returns either ConnectionSharedKey or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_start_packet_capture

Starts packet capture on virtual network gateway connection in the specified resource group.

begin_start_packet_capture(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: _models.VpnPacketCaptureStartParameters | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[str]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_connection_name Required	str The name of the virtual network gateway connection. Required.
parameters Required	VpnPacketCaptureStartParameters or IO[bytes] Virtual network gateway packet capture parameters supplied to start packet capture on gateway connection. Is either a VpnPacketCaptureStartParameters type or a IO[bytes] type. Default value is None.

Returns

Type	Description
LROPoller[str]	An instance of LROPoller that returns either str or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_stop_packet_capture

Stops packet capture on virtual network gateway connection in the specified resource group.

begin_stop_packet_capture(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: _models.VpnPacketCaptureStopParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[str]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_connection_name Required	str The name of the virtual network gateway Connection. Required.
parameters Required	VpnPacketCaptureStopParameters or IO[bytes] Virtual network gateway packet capture parameters supplied to stop packet capture on gateway connection. Is either a VpnPacketCaptureStopParameters type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[str]	An instance of LROPoller that returns either str or the result of cls(response)

Exceptions

Type	Description
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: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualNetworkGatewayConnection]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_connection_name Required	str The name of the virtual network gateway connection. Required.
parameters Required	TagsObject or IO[bytes] Parameters supplied to update virtual network gateway connection tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[VirtualNetworkGatewayConnection]	An instance of LROPoller that returns either VirtualNetworkGatewayConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets the specified virtual network gateway connection by resource group.

get(resource_group_name: str, virtual_network_gateway_connection_name: str, **kwargs: Any) -> VirtualNetworkGatewayConnection

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_connection_name Required	str The name of the virtual network gateway connection. Required.

Returns

Type	Description
VirtualNetworkGatewayConnection	VirtualNetworkGatewayConnection or the result of cls(response)

Exceptions

Type	Description
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: Any) -> ConnectionSharedKey

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_connection_name Required	str The virtual network gateway connection shared key name. Required.

Returns

Type	Description
ConnectionSharedKey	ConnectionSharedKey or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

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

list(resource_group_name: str, **kwargs: Any) -> Iterable[VirtualNetworkGatewayConnection]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.

Returns

Type	Description
ItemPaged[VirtualNetworkGatewayConnection]	An iterator like instance of either VirtualNetworkGatewayConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>

Share via

VirtualNetworkGatewayConnectionsOperations Class

Constructor

Methods

begin_create_or_update

Parameters

Returns

Exceptions

begin_delete

Parameters

Returns

Exceptions

begin_get_ike_sas

Parameters

Returns

Exceptions

begin_reset_connection

Parameters

Returns

Exceptions

begin_reset_shared_key

Parameters

Returns

Exceptions

begin_set_shared_key

Parameters

Returns

Exceptions

begin_start_packet_capture

Parameters

Returns

Exceptions

begin_stop_packet_capture

Parameters

Returns

Exceptions

begin_update_tags

Parameters

Returns

Exceptions

get

Parameters

Returns

Exceptions

get_shared_key

Parameters

Returns

Exceptions

list

Parameters

Returns

Exceptions

Attributes

models

Additional resources