How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure VpnGateways API

The VpnGateways API from Microsoft Azure — 4 operation(s) for vpngateways.

Microsoft Azure VpnGateways API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include VpnGateways. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 4 operations across 4 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

4 operations 4 paths 19 schemas 1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

VpnGateways 4
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname
microsoftAzureVpngatewaysUpdatetags 4 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/reset
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Reset
microsoftAzureVpngatewaysReset 5 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/startpacketcapture
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Startpacketcapture
microsoftAzureVpngatewaysStartpacketcapture 4 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/stoppacketcapture
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Stoppacketcapture
microsoftAzureVpngatewaysStoppacketcapture 4 params body → 200202default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are VpnConnectionProperties (19 properties), VpnSiteLinkConnectionProperties (19 properties), VpnGatewayProperties (9 properties), VpnGatewayNatRuleProperties (8 properties). Each schema is shown below with its type and property counts.

RoutingConfiguration
object
Routing Configuration indicating the associated and propagated route tables for this connection.
5 properties
VpnGatewayPacketCaptureStartParameters
object
Start packet capture parameters.
1 property
VpnGatewayNatRuleProperties
object
Parameters for VpnGatewayNatRule.
8 properties
VpnConnectionStatus
string
The current state of the vpn connection.
VpnConnectionProperties
object
Parameters for VpnConnection.
19 properties
VpnGatewayNatRule
object
VpnGatewayNatRule Resource.
4 properties
VpnNatRuleMapping
object
Vpn NatRule mapping.
2 properties
VpnSiteLinkConnection
object
VpnSiteLinkConnection Resource.
4 properties
VpnSiteLinkConnectionProperties
object
Parameters for VpnConnection.
19 properties
VpnGatewayProperties
object
Parameters for VpnGateway.
9 properties
VpnGatewayPacketCaptureStopParameters
object
Stop packet capture parameters.
1 property
VpnGateway
object
VpnGateway Resource.
2 properties 1 required
VpnConnection
object
VpnConnection Resource.
3 properties
VnetLocalRouteOverrideCriteria
string
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke vnet.
StaticRoute
object
List of all Static Routes.
3 properties
PropagatedRouteTable
object
The list of RouteTables to advertise the routes to.
2 properties
VnetRoute
object
List of routes that control routing from VirtualHub into a virtual network connection.
3 properties
StaticRoutesConfig
object
Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection.
2 properties
VpnGatewayIpConfiguration
object
IP Configuration of a VPN Gateway Resource.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-vpngateways-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure VpnGateways API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.