canonical: https://jentic.com/apis/azure.com/virtualwanasaservicemanagementclient

# Microsoft Azure VirtualWANAsAServiceManagementClient

Jentic publishes the only available OpenAPI specification for VirtualWANAsAServiceManagementClient, keeping it validated and agent-ready. The Azure Virtual WAN management client lets agents create and operate the building blocks of a global Virtual WAN: virtualWans themselves, virtualHubs in each region, hubVirtualNetworkConnections, vpnGateways and their vpnConnections (with link-level vpnLinkConnections for resilience), point-to-site p2sVpnGateways with associated p2sVpnServerConfigurations, and vpnSites describing on-premises endpoints. Operators also pull P2S connection health, supported security providers, and downloadable VPN configuration. Authentication uses Azure Active Directory OAuth 2.0.

## For AI agents

Provisions and manages Azure Virtual WAN - virtual hubs, VPN gateways, point-to-site gateways, branch sites, and the vpnConnections that knit them into a global SD-WAN.

## Scope

Does not run BGP route servers, terminate ExpressRoute circuits, or operate firewalls - use Network Management, ExpressRoute, and Azure Firewall APIs for those; this client only manages the Virtual WAN resource family.

## Capabilities

- Create and manage virtualWans, virtualHubs, and the hub-to-VNet connections that form a global Virtual WAN topology
- Stand up site-to-site vpnGateways, define vpnConnections to on-premises vpnSites, and add per-link vpnLinkConnections for redundant tunnels
- Provision point-to-site p2sVpnGateways, attach p2sVpnServerConfigurations, and generate downloadable client VPN profiles
- Pull P2S VPN connection health on a gateway to monitor remote-user connectivity and feed it into observability tooling
- Generate or download the vpnConfiguration for a Virtual WAN to share with on-premises VPN device configuration scripts
- List supported security providers in a Virtual WAN region so an agent can chain a third-party security service into the hub
- Reset a misbehaving vpnGateway to clear stuck tunnels without recreating the gateway

## Use cases

### Global SD-WAN bring-up across regions

An infrastructure team rolling out an Azure-native global SD-WAN needs a Virtual WAN with hubs in three regions, each connected to local VNets and to remote branch sites over IPsec. The agent creates the virtualWan, then creates a virtualHub in each region, attaches hubVirtualNetworkConnections to the regional VNets, provisions a vpnGateway per hub, and creates vpnConnections to vpnSite resources representing the branches. The same template scales to dozens of branches by repeating the vpnSite/vpnConnection step.

Example prompt: Create virtualWan 'global-wan' in resource group 'wan-rg', then PUT a virtualHub in westeurope with addressPrefix 10.10.0.0/24, PUT a vpnGateway in that hub, then PUT a vpnSite for the London branch and a vpnConnection linking site to gateway.

### Remote-worker point-to-site VPN

Enabling remote-worker VPN access to a Virtual WAN requires a p2sVpnGateway in the relevant hub plus a p2sVpnServerConfiguration (auth type, address pool, certs). The agent creates the configuration, attaches it to a p2sVpnGateway, and exports the client VPN profile via generatevpnprofile. Connection health is then monitored via getP2sVpnConnectionHealth so support teams can see when sessions drop.

Example prompt: PUT p2sVpnServerConfiguration 'p2s-config' on virtualWan 'global-wan', PUT p2sVpnGateway 'p2s-gw' in resource group 'wan-rg' referencing that config, then POST generatevpnprofile and store the returned profile URL.

### Branch resilience with link-level connections

Branches with two ISPs need active-active redundancy. The agent creates a vpnSite with two vpnSiteLinks (one per ISP), then a vpnConnection with two vpnLinkConnections - one to each link. Azure Virtual WAN distributes traffic across both tunnels and fails over automatically. The same model applies at scale by repeating per-branch with a templated payload.

Example prompt: PUT vpnSite 'london-branch' with two vpnSiteLinks (isp-a, isp-b), then PUT vpnConnection 'london' on the gateway with vpnLinkConnections referencing both links.

### Agent-driven WAN troubleshooting via Jentic

An ops agent fielding a 'branch is down' alert can call the Virtual WAN client through Jentic to read connection health, reset the gateway, and pull the latest vpnConfiguration to confirm policy. Jentic exposes each operation with its input schema and handles AAD bearer tokens from the vault, so the agent only needs to compose the action sequence.

Example prompt: Search Jentic for 'reset azure vpn gateway', execute reset on vpnGateway 'wan-gw-eu' in resource group 'wan-rg', then GET the gateway and confirm provisioningState=Succeeded.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName} | Create or update a Virtual WAN |
| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName} | Create or update a virtual hub |
| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName} | Create or update a site-to-site VPN gateway |
| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName} | Create or update a VPN connection on a gateway |
| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/reset | Reset a VPN gateway |
| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/generatevpnprofile | Generate a downloadable client VPN profile |
| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealth | Read P2S VPN connection health |
| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnConfiguration | Generate the downloadable VPN configuration for a Virtual WAN |

## Key resources

- **virtualWans** — Top-level Virtual WAN container resource
- **virtualHubs** — Per-region routing hubs and their hubVirtualNetworkConnections to spoke VNets
- **vpnGateways** — Site-to-site VPN gateway and its vpnConnections / vpnLinkConnections
- **vpnSites** — On-premises branch endpoints with optional vpnSiteLinks for multi-ISP redundancy
- **p2sVpnGateways** — Point-to-site gateways with p2sVpnServerConfigurations and downloadable client profiles

## Why Jentic

- **Setup:** Wiring VirtualWANAsAServiceManagementClient by hand means setting up Azure AD OAuth 2.0 against management.azure.com, pinning the 2019-07-01 api-version, learning the nested vpnSiteLinks and vpnLinkConnections schemas, and polling long-running gateway and hub PUTs with ARM 429 back-off yourself. Through Jentic you install once, import VirtualWANAsAServiceManagementClient from the API Directory, store the Azure AD OAuth token once, and your agent calls it.
- **Permission scoping:** Subscription, resource group, and resource names such as VirtualWANName, virtualHubName, and gatewayName are URL path parameters (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/...), so a rule can pin your agent to Virtual WAN resources in one resource group. You choose the operations it may call, so disruptive ones like resetting a gateway or deleting a hub are not included unless you add them.
- **Credential handling:** Your Azure AD OAuth token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create an Azure Virtual WAN' or 'read point-to-site VPN connection health', and Jentic returns the matching Microsoft.Network operation with its input schema for sku, addressPrefix, and vpnConfiguration so the agent calls it without reading the ARM reference.

## Related APIs

- **NetworkManagementClient** — Manages the underlying VNets, subnets, and public IPs that Virtual WAN connects
- **TrafficManagerManagementClient** — Routes public DNS traffic to the regional endpoints fronting Virtual WAN-backed apps
- **ManagedNetworkManagementClient** — Higher-level managed network grouping that simplifies VNet topology rules

## FAQ

### Why is there no official OpenAPI spec for VirtualWANAsAServiceManagementClient?

Microsoft Azure does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call VirtualWANAsAServiceManagementClient via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer .

### What authentication does the VirtualWANAsAServiceManagementClient use?

Azure Active Directory OAuth 2.0 with the user_impersonation scope against https://login.microsoftonline.com/common/oauth2/authorize. Through Jentic the AAD client secret stays encrypted in the vault and the agent only sees a scoped bearer token at call time.

### Can I create a point-to-site VPN gateway with this API?

Yes. PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName} creates the gateway, and POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/generatevpnprofile produces a downloadable client profile.

### What are the rate limits for the VirtualWANAsAServiceManagementClient?

Calls go through Azure Resource Manager and are subject to standard ARM read and write throttling buckets per subscription. Long-running PUTs (gateway creation, hub provisioning) are tracked via the Location/Azure-AsyncOperation header rather than a per-second rate; respect Retry-After on a 429.

### How do I reset a VPN gateway through Jentic?

Run pip install jentic, then client.search('reset azure vpn gateway'), client.load on the returned POST /vpnGateways/{gatewayName}/reset, and client.execute with subscriptionId, resourceGroupName, and gatewayName. Jentic injects the AAD bearer token from the vault.

### How do I add a branch site with two ISPs to a Virtual WAN?

PUT a vpnSite with two entries in vpnSiteLinks (one per ISP), then PUT a vpnConnection on the gateway with vpnLinkConnections referencing each link. Azure Virtual WAN distributes traffic across both tunnels and fails over automatically.

### Can I limit what my agent is allowed to do with the Azure Virtual WAN API?

Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use. The subscription, resource group, and resource names like VirtualWANName, virtualHubName, and gatewayName are URL path parameters, so you can pin the agent to Virtual WAN resources in a single resource group. You also choose the operations it may call, so disruptive ones such as resetting a vpnGateway or deleting a virtualHub stay out of reach unless you add them.