VirtualNetworkGatewaysOperations Class

VirtualNetworkGatewaysOperations 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

VirtualNetworkGatewaysOperations

Constructor

VirtualNetworkGatewaysOperations(client, config, serializer, deserializer)

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 in the specified resource group.
begin_delete	Deletes the specified virtual network gateway.
begin_generatevpnclientpackage	Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.
begin_get_advertised_routes	This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.
begin_get_bgp_peer_status	The GetBgpPeerStatus operation retrieves the status of all BGP peers.
begin_get_learned_routes	This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.
begin_reset	Resets the primary of the virtual network gateway in the specified resource group.
get	Gets the specified virtual network gateway by resource group.
list	Gets all virtual network gateways by resource group.

begin_create_or_update

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

begin_create_or_update(resource_group_name, virtual_network_gateway_name, parameters, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_gateway_name

str

Required

The name of the virtual network gateway.

parameters

VirtualNetworkGateway

Required

Parameters supplied to create or update virtual network gateway 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 PollingMethod

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 LROPoller that returns either VirtualNetworkGateway or the result of cls(response)

Return type

LROPoller[VirtualNetworkGateway]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes the specified virtual network gateway.

begin_delete(resource_group_name, virtual_network_gateway_name, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_gateway_name

str

Required

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

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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_generatevpnclientpackage

Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.

begin_generatevpnclientpackage(resource_group_name, virtual_network_gateway_name, parameters, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_gateway_name

str

Required

The name of the virtual network gateway.

parameters

VpnClientParameters

Required

Parameters supplied to the generate virtual network gateway VPN client package 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 PollingMethod

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 LROPoller that returns either str or the result of cls(response)

Return type

LROPoller[str]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_get_advertised_routes

This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.

begin_get_advertised_routes(resource_group_name, virtual_network_gateway_name, peer, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_gateway_name

str

Required

The name of the virtual network gateway.

peer

str

Required

The IP address of the peer.

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 PollingMethod

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 LROPoller that returns either GatewayRouteListResult or the result of cls(response)

Return type

LROPoller[GatewayRouteListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_get_bgp_peer_status

The GetBgpPeerStatus operation retrieves the status of all BGP peers.

begin_get_bgp_peer_status(resource_group_name, virtual_network_gateway_name, peer=None, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_gateway_name

str

Required

The name of the virtual network gateway.

peer

str

default value: None

The IP address of the peer to retrieve the status of.

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 PollingMethod

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 LROPoller that returns either BgpPeerStatusListResult or the result of cls(response)

Return type

LROPoller[BgpPeerStatusListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_get_learned_routes

This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.

begin_get_learned_routes(resource_group_name, virtual_network_gateway_name, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_gateway_name

str

Required

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

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 LROPoller that returns either GatewayRouteListResult or the result of cls(response)

Return type

LROPoller[GatewayRouteListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_reset

Resets the primary of the virtual network gateway in the specified resource group.

begin_reset(resource_group_name, virtual_network_gateway_name, gateway_vip=None, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_gateway_name

str

Required

The name of the virtual network gateway.

gateway_vip

str

default value: None

Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled 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 PollingMethod

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 LROPoller that returns either VirtualNetworkGateway or the result of cls(response)

Return type

LROPoller[VirtualNetworkGateway]

Exceptions

~azure.core.exceptions.HttpResponseError

get

Gets the specified virtual network gateway by resource group.

get(resource_group_name, virtual_network_gateway_name, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_gateway_name

str

Required

The name of the virtual network gateway.

cls

callable

Required

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

Returns

VirtualNetworkGateway, or the result of cls(response)

Return type

VirtualNetworkGateway

Exceptions

~azure.core.exceptions.HttpResponseError

list

Gets all virtual network gateways by resource group.

list(resource_group_name, **kwargs)

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

Return type

ItemPaged[VirtualNetworkGatewayListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

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