Virtual Wans - Get

Service:

Virtual WAN

API Version:

2026-01-01

Retrieves the details of a VirtualWAN.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}?api-version=2026-01-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
VirtualWANName	path	True	string	The name of the VirtualWAN being retrieved.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	VirtualWAN	Azure operation completed successfully.
Other Status Codes	CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

VirtualWANGet

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/wan1?api-version=2026-01-01

Java

/**
 * Samples for VirtualWans GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-01-01/VirtualWANGet.json
     */
    /**
     * Sample code: VirtualWANGet.
     * 
     * @param manager Entry point to NetworkManager.
     */
    public static void virtualWANGet(com.azure.resourcemanager.network.NetworkManager manager) {
        manager.serviceClient().getVirtualWans().getByResourceGroupWithResponse("rg1", "wan1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python virtual_wan_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.virtual_wans.get(
        resource_group_name="rg1",
        virtual_wan_name="wan1",
    )
    print(response)


# x-ms-original-file: 2026-01-01/VirtualWANGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v12"
)

// Generated from example definition: 2026-01-01/VirtualWANGet.json
func ExampleVirtualWansClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualWansClient().Get(ctx, "rg1", "wan1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armnetwork.VirtualWansClientGetResponse{
	// 	VirtualWAN: armnetwork.VirtualWAN{
	// 		Name: to.Ptr("wan1"),
	// 		Type: to.Ptr("Microsoft.Network/virtualWANs"),
	// 		Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"),
	// 		Location: to.Ptr("West US"),
	// 		Properties: &armnetwork.VirtualWanProperties{
	// 			Type: to.Ptr("Basic"),
	// 			DisableVPNEncryption: to.Ptr(false),
	// 			ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 			VirtualHubs: []*armnetwork.SubResource{
	// 				{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1"),
	// 				},
	// 				{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2"),
	// 				},
	// 			},
	// 			VPNSites: []*armnetwork.SubResource{
	// 				{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"),
	// 				},
	// 				{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2"),
	// 				},
	// 			},
	// 		},
	// 		Tags: map[string]*string{
	// 			"key1": to.Ptr("value1"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to retrieves the details of a VirtualWAN.
 *
 * @summary retrieves the details of a VirtualWAN.
 * x-ms-original-file: 2026-01-01/VirtualWANGet.json
 */
async function virtualWANGet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualWans.get("rg1", "wan1");
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "name": "wan1",
  "type": "Microsoft.Network/virtualWANs",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
  "location": "West US",
  "properties": {
    "type": "Basic",
    "disableVpnEncryption": false,
    "provisioningState": "Succeeded",
    "virtualHubs": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1"
      },
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2"
      }
    ],
    "vpnSites": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
      },
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2"
      }
    ]
  },
  "tags": {
    "key1": "value1"
  }
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
OfficeTrafficCategory	The office traffic category.
ProvisioningState	Provisioning states of a resource.
SubResource	Reference to another subresource.
VirtualWAN	VirtualWAN Resource.

CloudError

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

Object

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

OfficeTrafficCategory

Enumeration

The office traffic category.

Value	Description
Optimize	Optimize
OptimizeAndAllow	OptimizeAndAllow
All	All
None	None

ProvisioningState

Enumeration

Provisioning states of a resource.

Value	Description
Failed	Failed
Succeeded	Succeeded
Canceled	Canceled
Creating	Creating
Updating	Updating
Deleting	Deleting

SubResource

Object

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.

VirtualWAN

Object

VirtualWAN Resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.allowBranchToBranchTraffic	boolean	True if branch to branch traffic is allowed.
properties.allowVnetToVnetTraffic	boolean	True if Vnet to Vnet traffic is allowed.
properties.disableVpnEncryption	boolean	Vpn encryption to be disabled or not.
properties.office365LocalBreakoutCategory	OfficeTrafficCategory	The office local breakout category.
properties.provisioningState	ProvisioningState	The provisioning state of the virtual WAN resource.
properties.type	string	The type of the VirtualWAN.
properties.virtualHubs	SubResource[]	List of VirtualHubs in the VirtualWAN.
properties.vpnSites	SubResource[]	List of VpnSites in the VirtualWAN.
tags	object	Resource tags.
type	string	Resource type.