Microsoft Azure

Azure Network: Virtual Network Gateway

The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.

Endpoints 54

VirtualNetworkGateways

  • GETVirtualNetworkGateways_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayNameGets the specified virtual network gateway by resource group.
  • PUTVirtualNetworkGateways_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayNameCreates or updates a virtual network gateway in the specified resource group.
  • DELETEVirtualNetworkGateways_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayNameDeletes the specified virtual network gateway.
  • PATCHVirtualNetworkGateways_UpdateTags/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayNameUpdates a virtual network gateway tags.
  • GETVirtualNetworkGateways_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGatewaysGets all virtual network gateways by resource group.
  • GETVirtualNetworkGateways_ListConnections/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/connectionsGets all the connections in a virtual network gateway.
  • POSTVirtualNetworkGateways_Reset/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/reset?gatewayVip=stringResets the primary of the virtual network gateway in the specified resource group.
  • POSTVirtualNetworkGateways_ResetVpnClientSharedKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/resetvpnclientsharedkeyResets the VPN client shared key of the virtual network gateway in the specified resource group.
  • POSTVirtualNetworkGateways_Generatevpnclientpackage/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/generatevpnclientpackageGenerates VPN client package for P2S client of the virtual network gateway in the specified resource group.
  • POSTVirtualNetworkGateways_GenerateVpnProfile/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/generatevpnprofileGenerates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.
  • POSTVirtualNetworkGateways_GetVpnProfilePackageUrl/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/getvpnprofilepackageurlGets 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…
  • POSTVirtualNetworkGateways_GetBgpPeerStatus/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/getBgpPeerStatus?peer=stringThe GetBgpPeerStatus operation retrieves the status of all BGP peers.
  • POSTVirtualNetworkGateways_SupportedVpnDevices/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/supportedvpndevicesGets a xml format representation for supported vpn devices.
  • POSTVirtualNetworkGateways_ListRadiusSecrets/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/listRadiusSecretsList all Radius servers with respective radius secrets from virtual network gateway VpnClientConfiguration.
  • POSTVirtualNetworkGateways_GetLearnedRoutes/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/getLearnedRoutesThis operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.
  • POSTVirtualNetworkGateways_GetAdvertisedRoutes/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/getAdvertisedRoutes?peer=stringThis operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.
  • POSTVirtualNetworkGateways_GetResiliencyInformation/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/getResiliencyInformation?attemptRefresh=trueThis operation retrieves the resiliency information for an Express Route Gateway, including the gateway's current resiliency score and recommendations to…
  • POSTVirtualNetworkGateways_GetRoutesInformation/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/getRoutesInformation?attemptRefresh=trueThis operation retrieves the route set information for an Express Route Gateway based on their resiliency
  • POSTVirtualNetworkGateways_SetVpnclientIpsecParameters/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/setvpnclientipsecparametersThe Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through…
  • POSTVirtualNetworkGateways_GetVpnclientIpsecParameters/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/getvpnclientipsecparametersThe Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified…
  • POSTVirtualNetworkGateways_VpnDeviceConfigurationScript/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connections/:virtualNetworkGatewayConnectionName/vpndeviceconfigurationscriptGets a xml format representation for vpn device configuration script.
  • POSTVirtualNetworkGateways_StartPacketCapture/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/startPacketCaptureStarts packet capture on virtual network gateway in the specified resource group.
  • POSTVirtualNetworkGateways_StopPacketCapture/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/stopPacketCaptureStops packet capture on virtual network gateway in the specified resource group.
  • POSTVirtualNetworkGateways_GetFailoverAllTestDetails/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/getFailoverAllTestsDetails?type=string&fetchLatest=trueThis operation retrieves the details of all the failover tests performed on the gateway for different peering locations
  • POSTVirtualNetworkGateways_GetFailoverSingleTestDetails/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/getFailoverSingleTestDetails?peeringLocation=string&failoverTestId=stringThis operation retrieves the details of a particular failover test performed on the gateway based on the test Guid
  • POSTVirtualNetworkGateways_StartExpressRouteSiteFailoverSimulation/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/startSiteFailoverTest?peeringLocation=stringThis operation starts failover simulation on the gateway for the specified peering location
  • POSTVirtualNetworkGateways_StopExpressRouteSiteFailoverSimulation/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/stopSiteFailoverTestThis operation stops failover simulation on the gateway for the specified peering location
  • POSTVirtualNetworkGateways_GetVpnclientConnectionHealth/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/getVpnClientConnectionHealthGet VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.
  • POSTVirtualNetworkGateways_DisconnectVirtualNetworkGatewayVpnConnections/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/disconnectVirtualNetworkGatewayVpnConnectionsDisconnect vpn connections of virtual network gateway in the specified resource group.

VirtualNetworkGatewayConnections

  • GETVirtualNetworkGatewayConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connections/:virtualNetworkGatewayConnectionNameGets the specified virtual network gateway connection by resource group.
  • PUTVirtualNetworkGatewayConnections_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connections/:virtualNetworkGatewayConnectionNameCreates or updates a virtual network gateway connection in the specified resource group.
  • DELETEVirtualNetworkGatewayConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connections/:virtualNetworkGatewayConnectionNameDeletes the specified virtual network Gateway connection.
  • PATCHVirtualNetworkGatewayConnections_UpdateTags/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connections/:virtualNetworkGatewayConnectionNameUpdates a virtual network gateway connection tags.
  • GETVirtualNetworkGatewayConnections_GetSharedKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connections/:virtualNetworkGatewayConnectionName/sharedkeyThe Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through…
  • PUTVirtualNetworkGatewayConnections_SetSharedKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connections/:virtualNetworkGatewayConnectionName/sharedkeyThe Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway…
  • GETVirtualNetworkGatewayConnections_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connectionsThe List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.
  • POSTVirtualNetworkGatewayConnections_ResetSharedKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connections/:virtualNetworkGatewayConnectionName/sharedkey/resetThe VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway…
  • POSTVirtualNetworkGatewayConnections_StartPacketCapture/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connections/:virtualNetworkGatewayConnectionName/startPacketCaptureStarts packet capture on virtual network gateway connection in the specified resource group.
  • POSTVirtualNetworkGatewayConnections_StopPacketCapture/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connections/:virtualNetworkGatewayConnectionName/stopPacketCaptureStops packet capture on virtual network gateway connection in the specified resource group.
  • POSTVirtualNetworkGatewayConnections_GetIkeSas/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connections/:virtualNetworkGatewayConnectionName/getikesasLists IKE Security Associations for the virtual network gateway connection in the specified resource group.
  • POSTVirtualNetworkGatewayConnections_ResetConnection/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connections/:virtualNetworkGatewayConnectionName/resetconnectionResets the virtual network gateway connection specified.

LocalNetworkGateways

  • GETLocalNetworkGateways_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/localNetworkGateways/:localNetworkGatewayNameGets the specified local network gateway in a resource group.
  • PUTLocalNetworkGateways_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/localNetworkGateways/:localNetworkGatewayNameCreates or updates a local network gateway in the specified resource group.
  • DELETELocalNetworkGateways_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/localNetworkGateways/:localNetworkGatewayNameDeletes the specified local network gateway.
  • PATCHLocalNetworkGateways_UpdateTags/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/localNetworkGateways/:localNetworkGatewayNameUpdates a local network gateway tags.
  • GETLocalNetworkGateways_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/localNetworkGatewaysGets all the local network gateways in a resource group.
  • GETVirtualNetworkGatewayNatRules_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/natRules/:natRuleNameRetrieves the details of a nat rule.
  • PUTVirtualNetworkGatewayNatRules_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/natRules/:natRuleNameCreates a nat rule to a scalable virtual network gateway if it doesn't exist else updates the existing nat rules.
  • DELETEVirtualNetworkGatewayNatRules_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/natRules/:natRuleNameDeletes a nat rule.
  • GETVirtualNetworkGatewayNatRules_ListByVirtualNetworkGateway/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/natRulesRetrieves all nat rules for a particular virtual network gateway.
  • POSTVirtualNetworkGateways_InvokePrepareMigration/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/prepareMigrationTrigger prepare migration for the virtual network gateway.
  • POSTVirtualNetworkGateways_InvokeExecuteMigration/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/executeMigrationTrigger execute migration for the virtual network gateway.
  • POSTVirtualNetworkGateways_InvokeCommitMigration/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/commitMigrationTrigger commit migration for the virtual network gateway.
  • POSTVirtualNetworkGateways_InvokeAbortMigration/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/abortMigrationTrigger abort migration for the virtual network gateway.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
54 operations on 42 pathsPOST 32GET 10PUT 5DELETE 4PATCH 3
Main resources
VirtualNetworkGateways 29VirtualNetworkGatewayConnections 12LocalNetworkGateways 5
Response formats
application/json
Description format
Swagger 2.0, API version 2025-03-01

How to test the Azure Network: Virtual Network Gateway in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Network: Virtual Network Gateway collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “VirtualNetworkGateways_Get” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Network: Virtual Network Gateway?

The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network… It is listed under Developer tools and has 54 endpoints.

Who publishes the Azure Network: Virtual Network Gateway?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Network: Virtual Network Gateway?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Network: Virtual Network Gateway?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Network: Virtual Network Gateway have?

54 operations on 42 paths (32 POST, 10 GET, 5 PUT, 4 DELETE, 3 PATCH). The largest groups are VirtualNetworkGateways, VirtualNetworkGatewayConnections, LocalNetworkGateways.

Is forking the Azure Network: Virtual Network Gateway free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.