Microsoft Azure

Azure Network: Network Gateway

APIs to manage Microsoft Azure network resources.

Developer tools#openapi

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

APIs to manage Microsoft Azure network resources.

Endpoints 61

VirtualNetworkGateways

  • POSTVirtualNetworkGateways_VpnDeviceConfigurationScript/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connections/:virtualNetworkGatewayConnectionName/vpndeviceconfigurationscriptGets a xml format representation for vpn device configuration script.
  • GETVirtualNetworkGateways_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGatewaysGets all virtual network gateways by resource group.
  • 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_ListConnections/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/connectionsGets all the connections in a virtual network gateway.
  • POSTVirtualNetworkGateways_DisconnectVirtualNetworkGatewayVpnConnections/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/disconnectVirtualNetworkGatewayVpnConnectionsDisconnect vpn connections of 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_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_GetBgpPeerStatus/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/getBgpPeerStatus?peer=stringThe GetBgpPeerStatus operation retrieves the status of all BGP peers.
  • POSTVirtualNetworkGateways_GetEffectiveRoutes/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/getEffectiveRoutesThis operation retrieves a list of effective routes for the virtual network gateway.
  • 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_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_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_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_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_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_ListRadiusSecrets/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/listRadiusSecretsList all Radius servers with respective radius secrets from virtual network gateway VpnClientConfiguration.
  • 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_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_StartPacketCapture/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/startPacketCaptureStarts packet capture on virtual network gateway in the specified resource group.
  • 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_StopPacketCapture/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/stopPacketCaptureStops packet capture on virtual network gateway in the specified resource group.
  • 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_SupportedVpnDevices/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/supportedvpndevicesGets a xml format representation for supported vpn devices.

VirtualNetworkGatewayConnections

  • GETVirtualNetworkGatewayConnections_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connectionsThe List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.
  • 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.
  • 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.
  • 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…
  • 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.

LocalNetworkGateways

  • GETLocalNetworkGateways_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/localNetworkGatewaysGets all the local network gateways in a resource group.
  • 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.

VirtualNetworkTap

  • GETVirtualNetworkTaps_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkTaps/:tapNameGet a VirtualNetworkTap
  • PUTVirtualNetworkTaps_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkTaps/:tapNameCreate a VirtualNetworkTap
  • DELETEVirtualNetworkTaps_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkTaps/:tapNameDelete a VirtualNetworkTap
  • PATCHVirtualNetworkTaps_UpdateTags/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkTaps/:tapNameUpdate a VirtualNetworkTap

VirtualNetworkTaps

  • GETVirtualNetworkTaps_ListAll/subscriptions/:subscriptionId/providers/Microsoft.Network/virtualNetworkTapsGets all the VirtualNetworkTaps in a subscription.
  • GETVirtualNetworkTaps_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkTapsGets all the VirtualNetworkTaps in a subscription.
  • POSTVirtualNetworkGateways_InvokeAbortMigration/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/abortMigrationTrigger abort 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_InvokeExecuteMigration/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/executeMigrationTrigger execute migration for the virtual network gateway.
  • GETVirtualNetworkGatewayNatRules_ListByVirtualNetworkGateway/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/natRulesRetrieves all nat rules for a particular virtual network gateway.
  • 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.
  • POSTVirtualNetworkGateways_InvokePrepareMigration/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/virtualNetworkGateways/:virtualNetworkGatewayName/prepareMigrationTrigger prepare migration for the virtual network gateway.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
61 operations on 46 pathsPOST 33GET 13PUT 6DELETE 5PATCH 4
Main resources
VirtualNetworkGateways 30VirtualNetworkGatewayConnections 12LocalNetworkGateways 5VirtualNetworkTap 4VirtualNetworkTaps 2
Response formats
application/json
Description format
Swagger 2.0, API version 2026-03-01

How to test the Azure Network: 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: 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_VpnDeviceConfigurationScript” (POST /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Network/connections/:virtualNetworkGatewayConnectionName/vpndeviceconfigurationscript), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Network: Network Gateway?

APIs to manage Microsoft Azure network resources. It is listed under Developer tools and has 61 endpoints.

Who publishes the Azure Network: 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: 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: Network Gateway?

With OAuth 2.0 (implicit flow) with 1 scope.

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

61 operations on 46 paths (33 POST, 13 GET, 6 PUT, 5 DELETE, 4 PATCH). The largest groups are VirtualNetworkGateways, VirtualNetworkGatewayConnections, LocalNetworkGateways, VirtualNetworkTap.

Is forking the Azure Network: 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.