VirtualNetworkGatewaysOperations Class

Reference

VirtualNetworkGatewaysOperations 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

VirtualNetworkGatewaysOperations

Constructor

VirtualNetworkGatewaysOperations(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 in the specified resource group.
begin_delete	Deletes the specified virtual network gateway.
begin_generate_vpn_profile	Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.
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_get_vpn_profile_package_url	Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.
begin_get_vpnclient_ipsec_parameters	The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.
begin_reset	Resets the primary of the virtual network gateway in the specified resource group.
begin_set_vpnclient_ipsec_parameters	The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.
begin_update_tags	Updates a virtual network gateway tags.
get	Gets the specified virtual network gateway by resource group.
list	Gets all virtual network gateways by resource group.
list_connections	Gets all the connections in a virtual network gateway.
supported_vpn_devices	Gets a xml format representation for supported vpn devices.
vpn_device_configuration_script	Gets a xml format representation for vpn device configuration script.

begin_create_or_update

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

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

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

Return type

AsyncLROPoller[VirtualNetworkGateway]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes the specified virtual network gateway.

begin_delete(resource_group_name: str, virtual_network_gateway_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_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 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_generate_vpn_profile

Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.

begin_generate_vpn_profile(resource_group_name: str, virtual_network_gateway_name: str, parameters: azure.mgmt.network.v2018_04_01.models._models_py3.VpnClientParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[str]

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

Return type

AsyncLROPoller[str]

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: str, virtual_network_gateway_name: str, parameters: azure.mgmt.network.v2018_04_01.models._models_py3.VpnClientParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[str]

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

Return type

AsyncLROPoller[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: str, virtual_network_gateway_name: str, peer: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.GatewayRouteListResult')]

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

Return type

AsyncLROPoller[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: str, virtual_network_gateway_name: str, peer: typing.Union[str, NoneType] = None, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.BgpPeerStatusListResult')]

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

Return type

AsyncLROPoller[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: str, virtual_network_gateway_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.GatewayRouteListResult')]

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

Return type

AsyncLROPoller[GatewayRouteListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_get_vpn_profile_package_url

Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.

begin_get_vpn_profile_package_url(resource_group_name: str, virtual_network_gateway_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[str]

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

Return type

AsyncLROPoller[str]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_get_vpnclient_ipsec_parameters

The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.

begin_get_vpnclient_ipsec_parameters(resource_group_name: str, virtual_network_gateway_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.VpnClientIPsecParameters')]

Parameters

resource_group_name: str

Required

The name of the resource group.

virtual_network_gateway_name: str

Required

The virtual network gateway name.

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

Return type

AsyncLROPoller[VpnClientIPsecParameters]

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: str, virtual_network_gateway_name: str, gateway_vip: typing.Union[str, NoneType] = None, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.VirtualNetworkGateway')]

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

Required

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

Return type

AsyncLROPoller[VirtualNetworkGateway]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_set_vpnclient_ipsec_parameters

The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.

begin_set_vpnclient_ipsec_parameters(resource_group_name: str, virtual_network_gateway_name: str, vpnclient_ipsec_params: azure.mgmt.network.v2018_04_01.models._models_py3.VpnClientIPsecParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.VpnClientIPsecParameters')]

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.

vpnclient_ipsec_params: VpnClientIPsecParameters

Required

Parameters supplied to the Begin Set vpnclient ipsec parameters of Virtual Network Gateway P2S client 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 VpnClientIPsecParameters or the result of cls(response)

Return type

AsyncLROPoller[VpnClientIPsecParameters]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_update_tags

Updates a virtual network gateway tags.

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

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: TagsObject

Required

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

Return type

AsyncLROPoller[VirtualNetworkGateway]

Exceptions

~azure.core.exceptions.HttpResponseError

get

Gets the specified virtual network gateway by resource group.

get(resource_group_name: str, virtual_network_gateway_name: str, **kwargs) -> azure.mgmt.network.v2018_04_01.models._models_py3.VirtualNetworkGateway

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: str, **kwargs) -> typing.AsyncIterable[_ForwardRef('models.VirtualNetworkGatewayListResult')]

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

AsyncItemPaged[VirtualNetworkGatewayListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_connections

Gets all the connections in a virtual network gateway.

list_connections(resource_group_name: str, virtual_network_gateway_name: str, **kwargs) -> typing.AsyncIterable[_ForwardRef('models.VirtualNetworkGatewayListConnectionsResult')]

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

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

Return type

AsyncItemPaged[VirtualNetworkGatewayListConnectionsResult]

Exceptions

~azure.core.exceptions.HttpResponseError

supported_vpn_devices

Gets a xml format representation for supported vpn devices.

supported_vpn_devices(resource_group_name: str, virtual_network_gateway_name: str, **kwargs) -> str

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

str, or the result of cls(response)

Return type

str

Exceptions

~azure.core.exceptions.HttpResponseError

vpn_device_configuration_script

Gets a xml format representation for vpn device configuration script.

vpn_device_configuration_script(resource_group_name: str, virtual_network_gateway_connection_name: str, parameters: azure.mgmt.network.v2018_04_01.models._models_py3.VpnDeviceScriptParameters, **kwargs) -> str

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 for which the configuration script is generated.

parameters: VpnDeviceScriptParameters

Required

Parameters supplied to the generate vpn device script operation.

cls: callable

Required

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

Returns

str, or the result of cls(response)

Return type

str

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

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