VirtualNetworkGatewaysOperations Class

Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:virtual_network_gateways> attribute.

Inheritance: builtins.object

VirtualNetworkGatewaysOperations

Constructor

VirtualNetworkGatewaysOperations(*args, **kwargs)

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_disconnect_virtual_network_gateway_vpn_connections	Disconnect vpn connections of virtual network gateway in the specified resource group.
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_failover_all_test_details	This operation retrieves the details of all the failover tests performed on the gateway for different peering locations.
begin_get_failover_single_test_details	This operation retrieves the details of a particular failover test performed on the gateway based on the test Guid.
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_connection_health	Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.
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_reset_vpn_client_shared_key	Resets the VPN client shared key 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_start_express_route_site_failover_simulation	This operation starts failover simulation on the gateway for the specified peering location.
begin_start_packet_capture	Starts packet capture on virtual network gateway in the specified resource group.
begin_stop_express_route_site_failover_simulation	This operation stops failover simulation on the gateway for the specified peering location.
begin_stop_packet_capture	Stops packet capture on virtual network gateway in the specified resource group.
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: _models.VirtualNetworkGateway, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualNetworkGateway]

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified virtual network gateway.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_name Required	str The name of the virtual network gateway. 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_disconnect_virtual_network_gateway_vpn_connections

Disconnect vpn connections of virtual network gateway in the specified resource group.

begin_disconnect_virtual_network_gateway_vpn_connections(resource_group_name: str, virtual_network_gateway_name: str, request: _models.P2SVpnConnectionRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_name Required	str The name of the virtual network gateway. Required.
request Required	P2SVpnConnectionRequest or IO[bytes] The parameters are supplied to disconnect vpn connections. Is either a P2SVpnConnectionRequest type or a IO[bytes] type. 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_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: _models.VpnClientParameters, *, 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_name Required	str The name of the virtual network gateway. Required.
parameters Required	VpnClientParameters or IO[bytes] Parameters supplied to the generate virtual network gateway VPN client package operation. Is either a VpnClientParameters 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_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: _models.VpnClientParameters, *, 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_name Required	str The name of the virtual network gateway. Required.
parameters Required	VpnClientParameters or IO[bytes] Parameters supplied to the generate virtual network gateway VPN client package operation. Is either a VpnClientParameters 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_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: Any) -> LROPoller[GatewayRouteListResult]

Parameters

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

Keyword-Only Parameters

Name	Description
peer	str The IP address of the peer. Required.

Returns

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

Exceptions

Type	Description
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: str | None = None, **kwargs: Any) -> LROPoller[BgpPeerStatusListResult]

Parameters

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

Keyword-Only Parameters

Name	Description
peer	str The IP address of the peer to retrieve the status of. Default value is None.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_get_failover_all_test_details

This operation retrieves the details of all the failover tests performed on the gateway for different peering locations.

begin_get_failover_all_test_details(resource_group_name: str, virtual_network_gateway_name: str, *, type: str, fetch_latest: bool, **kwargs: Any) -> LROPoller[List[ExpressRouteFailoverTestDetails]]

Parameters

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

Keyword-Only Parameters

Name	Description
type	str The type of failover test. Required.
fetch_latest	bool Fetch only the latest tests for each peering location. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_get_failover_single_test_details

This operation retrieves the details of a particular failover test performed on the gateway based on the test Guid.

begin_get_failover_single_test_details(resource_group_name: str, virtual_network_gateway_name: str, *, peering_location: str, failover_test_id: str, **kwargs: Any) -> LROPoller[List[ExpressRouteFailoverSingleTestDetails]]

Parameters

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

Keyword-Only Parameters

Name	Description
peering_location	str Peering location of the test. Required.
failover_test_id	str The unique Guid value which identifies the test. Required.

Returns

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

Exceptions

Type	Description
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: Any) -> LROPoller[GatewayRouteListResult]

Parameters

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

Returns

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

Exceptions

Type	Description
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: Any) -> LROPoller[str]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_name Required	str The name of the virtual network gateway. 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_get_vpnclient_connection_health

Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.

begin_get_vpnclient_connection_health(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) -> LROPoller[VpnClientConnectionHealthDetailListResult]

Parameters

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

Returns

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

Exceptions

Type	Description
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: Any) -> LROPoller[VpnClientIPsecParameters]

Parameters

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

Returns

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

Exceptions

Type	Description
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: str | None = None, **kwargs: Any) -> LROPoller[VirtualNetworkGateway]

Parameters

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

Keyword-Only Parameters

Name	Description
gateway_vip	str Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled gateway. Default value is None.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_reset_vpn_client_shared_key

Resets the VPN client shared key of the virtual network gateway in the specified resource group.

begin_reset_vpn_client_shared_key(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_name Required	str The name of the virtual network gateway. 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_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: _models.VpnClientIPsecParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VpnClientIPsecParameters]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_gateway_name Required	str The name of the virtual network gateway. Required.
vpnclient_ipsec_params Required	VpnClientIPsecParameters or IO[bytes] Parameters supplied to the Begin Set vpnclient ipsec parameters of Virtual Network Gateway P2S client operation through Network resource provider. Is either a VpnClientIPsecParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_start_express_route_site_failover_simulation

This operation starts failover simulation on the gateway for the specified peering location.

begin_start_express_route_site_failover_simulation(resource_group_name: str, virtual_network_gateway_name: str, *, peering_location: str, **kwargs: Any) -> LROPoller[str]

Parameters

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

Keyword-Only Parameters

Name	Description
peering_location	str Peering location of the test. 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_start_packet_capture

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

begin_start_packet_capture(resource_group_name: str, virtual_network_gateway_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_name Required	str The name of the virtual network gateway. Required.
parameters Required	VpnPacketCaptureStartParameters or IO[bytes] Virtual network gateway packet capture parameters supplied to start packet capture on gateway. 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_express_route_site_failover_simulation

This operation stops failover simulation on the gateway for the specified peering location.

begin_stop_express_route_site_failover_simulation(resource_group_name: str, virtual_network_gateway_name: str, stop_parameters: _models.ExpressRouteFailoverStopApiParameters, *, 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_name Required	str The name of the virtual network gateway. Required.
stop_parameters Required	ExpressRouteFailoverStopApiParameters or IO[bytes] Virtual network gateway stop simulation parameters supplied to stop failover simulation on gateway. Is either a ExpressRouteFailoverStopApiParameters 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_stop_packet_capture

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

begin_stop_packet_capture(resource_group_name: str, virtual_network_gateway_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_name Required	str The name of the virtual network gateway. Required.
parameters Required	VpnPacketCaptureStopParameters or IO[bytes] Virtual network gateway packet capture parameters supplied to stop packet capture on gateway. 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 tags.

begin_update_tags(resource_group_name: str, virtual_network_gateway_name: str, parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualNetworkGateway]

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets the specified virtual network gateway by resource group.

get(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) -> VirtualNetworkGateway

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list

Gets all virtual network gateways by resource group.

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

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_connections

Gets all the connections in a virtual network gateway.

list_connections(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) -> Iterable[VirtualNetworkGatewayConnectionListEntity]

Parameters

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

Returns

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

Exceptions

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

Parameters

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

Returns

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

Exceptions

Type	Description
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: _models.VpnDeviceScriptParameters, *, content_type: str = 'application/json', **kwargs: Any) -> 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 for which the configuration script is generated. Required.
parameters Required	VpnDeviceScriptParameters or IO[bytes] Parameters supplied to the generate vpn device script operation. Is either a VpnDeviceScriptParameters type or a IO[bytes] type. Required.

Returns

Type	Description
str	str 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'>

Partilhar via

VirtualNetworkGatewaysOperations Class

Constructor

Methods

begin_create_or_update

Parameters

Returns

Exceptions

begin_delete

Parameters

Returns

Exceptions

begin_disconnect_virtual_network_gateway_vpn_connections

Parameters

Returns

Exceptions

begin_generate_vpn_profile

Parameters

Returns

Exceptions

begin_generatevpnclientpackage

Parameters

Returns

Exceptions

begin_get_advertised_routes

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_get_bgp_peer_status

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_get_failover_all_test_details

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_get_failover_single_test_details

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_get_learned_routes

Parameters

Returns

Exceptions

begin_get_vpn_profile_package_url

Parameters

Returns

Exceptions

begin_get_vpnclient_connection_health

Parameters

Returns

Exceptions

begin_get_vpnclient_ipsec_parameters

Parameters

Returns

Exceptions

begin_reset

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_reset_vpn_client_shared_key

Parameters

Returns

Exceptions

begin_set_vpnclient_ipsec_parameters

Parameters

Returns

Exceptions

begin_start_express_route_site_failover_simulation

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_start_packet_capture

Parameters