Vpn Sites - List

Reference

Service:: Virtual WAN

API Version:: 2023-09-01

Lists all the VpnSites in a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnSites?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	ListVpnSitesResult	Request successful. Returns the details of all the VpnSites in the subscription.
Other Status Codes	CloudError	Error response describing why the operation failed.

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

VpnSiteList

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/vpnSites?api-version=2023-09-01


/**
 * Samples for VpnSites List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSiteList.json
     */
    /**
     * Sample code: VpnSiteList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnSiteList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnSites().list(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

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python vpn_site_list.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="subid",
    )

    response = client.vpn_sites.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSiteList.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

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSiteList.json
func ExampleVPNSitesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewVPNSitesClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ListVPNSitesResult = armnetwork.ListVPNSitesResult{
		// 	Value: []*armnetwork.VPNSite{
		// 		{
		// 			Name: to.Ptr("vpnSite1"),
		// 			Type: to.Ptr("Microsoft.Network/vpnSites"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"),
		// 			Location: to.Ptr("West US"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 			},
		// 			Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
		// 			Properties: &armnetwork.VPNSiteProperties{
		// 				AddressSpace: &armnetwork.AddressSpace{
		// 					AddressPrefixes: []*string{
		// 						to.Ptr("10.0.0.0/16")},
		// 					},
		// 					DeviceProperties: &armnetwork.DeviceProperties{
		// 						LinkSpeedInMbps: to.Ptr[int32](0),
		// 					},
		// 					IsSecuritySite: to.Ptr(false),
		// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 					VirtualWan: &armnetwork.SubResource{
		// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"),
		// 					},
		// 					VPNSiteLinks: []*armnetwork.VPNSiteLink{
		// 						{
		// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1"),
		// 							Name: to.Ptr("vpnSiteLink1"),
		// 							Type: to.Ptr("Microsoft.Network/vpnSites/vpnSiteLinks"),
		// 							Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
		// 							Properties: &armnetwork.VPNSiteLinkProperties{
		// 								BgpProperties: &armnetwork.VPNLinkBgpSettings{
		// 									Asn: to.Ptr[int64](1234),
		// 									BgpPeeringAddress: to.Ptr("192.168.0.0"),
		// 								},
		// 								IPAddress: to.Ptr("50.50.50.56"),
		// 								LinkProperties: &armnetwork.VPNLinkProviderProperties{
		// 									LinkSpeedInMbps: to.Ptr[int32](0),
		// 								},
		// 								ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 							},
		// 					}},
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("vpnSite2"),
		// 				Type: to.Ptr("Microsoft.Network/vpnSites"),
		// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2"),
		// 				Location: to.Ptr("East US"),
		// 				Tags: map[string]*string{
		// 					"key1": to.Ptr("value1"),
		// 				},
		// 				Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
		// 				Properties: &armnetwork.VPNSiteProperties{
		// 					AddressSpace: &armnetwork.AddressSpace{
		// 						AddressPrefixes: []*string{
		// 							to.Ptr("10.0.0.0/16")},
		// 						},
		// 						BgpProperties: &armnetwork.BgpSettings{
		// 							Asn: to.Ptr[int64](1234),
		// 							BgpPeeringAddress: to.Ptr("192.168.0.0"),
		// 						},
		// 						DeviceProperties: &armnetwork.DeviceProperties{
		// 							DeviceModel: to.Ptr("model01"),
		// 							DeviceVendor: to.Ptr("vendor1"),
		// 							LinkSpeedInMbps: to.Ptr[int32](200),
		// 						},
		// 						IPAddress: to.Ptr("10.1.0.0"),
		// 						IsSecuritySite: to.Ptr(false),
		// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 						VirtualWan: &armnetwork.SubResource{
		// 						},
		// 					},
		// 			}},
		// 		}
	}
}

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

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

/**
 * This sample demonstrates how to Lists all the VpnSites in a subscription.
 *
 * @summary Lists all the VpnSites in a subscription.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSiteList.json
 */
async function vpnSiteList() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.vpnSites.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSiteList.json
// this example is just showing the usage of "VpnSites_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (VpnSiteResource item in subscriptionResource.GetVpnSitesAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    VpnSiteData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "West US",
      "name": "vpnSite1",
      "type": "Microsoft.Network/vpnSites",
      "tags": {
        "key1": "value1"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "virtualWan": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
        },
        "deviceProperties": {
          "linkSpeedInMbps": 0
        },
        "addressSpace": {
          "addressPrefixes": [
            "10.0.0.0/16"
          ]
        },
        "isSecuritySite": false,
        "vpnSiteLinks": [
          {
            "name": "vpnSiteLink1",
            "type": "Microsoft.Network/vpnSites/vpnSiteLinks",
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
            "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
            "properties": {
              "provisioningState": "Succeeded",
              "ipAddress": "50.50.50.56",
              "linkProperties": {
                "linkSpeedInMbps": 0
              },
              "bgpProperties": {
                "bgpPeeringAddress": "192.168.0.0",
                "asn": 1234
              }
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "East US",
      "name": "vpnSite2",
      "type": "Microsoft.Network/vpnSites",
      "tags": {
        "key1": "value1"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "virtualWan": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan1",
        "deviceProperties": {
          "deviceVendor": "vendor1",
          "deviceModel": "model01",
          "linkSpeedInMbps": 200
        },
        "ipAddress": "10.1.0.0",
        "addressSpace": {
          "addressPrefixes": [
            "10.0.0.0/16"
          ]
        },
        "bgpProperties": {
          "bgpPeeringAddress": "192.168.0.0",
          "asn": 1234
        },
        "isSecuritySite": false
      }
    }
  ]
}

Definitions

Name	Description
AddressSpace	AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.
BgpSettings	BGP settings details.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
DeviceProperties	List of properties of the device.
IPConfigurationBgpPeeringAddress	Properties of IPConfigurationBgpPeeringAddress.
ListVpnSitesResult	Result of the request to list VpnSites. It contains a list of VpnSites and a URL nextLink to get the next set of results.
O365BreakOutCategoryPolicies	Office365 breakout categories.
O365PolicyProperties	The Office365 breakout policy.
ProvisioningState	The current provisioning state.
SubResource	Reference to another subresource.
VpnLinkBgpSettings	BGP settings details for a link.
VpnLinkProviderProperties	List of properties of a link provider.
VpnSite	VpnSite Resource.
VpnSiteLink	VpnSiteLink Resource.

AddressSpace

AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.

Name	Type	Description
addressPrefixes	string[]	A list of address blocks reserved for this virtual network in CIDR notation.

BgpSettings

BGP settings details.

Name	Type	Description
asn	integer	The BGP speaker's ASN.
bgpPeeringAddress	string	The BGP peering address and BGP identifier of this BGP speaker.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	BGP peering address with IP configuration ID for virtual network gateway.
peerWeight	integer	The weight added to routes learned from this BGP speaker.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

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.

DeviceProperties

List of properties of the device.

Name	Type	Description
deviceModel	string	Model of the device.
deviceVendor	string	Name of the device Vendor.
linkSpeedInMbps	integer	Link speed.

IPConfigurationBgpPeeringAddress

Properties of IPConfigurationBgpPeeringAddress.

Name	Type	Description
customBgpIpAddresses	string[]	The list of custom BGP peering addresses which belong to IP configuration.
defaultBgpIpAddresses	string[]	The list of default BGP peering addresses which belong to IP configuration.
ipconfigurationId	string	The ID of IP configuration which belongs to gateway.
tunnelIpAddresses	string[]	The list of tunnel public IP addresses which belong to IP configuration.

ListVpnSitesResult

Result of the request to list VpnSites. It contains a list of VpnSites and a URL nextLink to get the next set of results.

Name	Type	Description
nextLink	string	URL to get the next set of operation list results if there are any.
value	VpnSite[]	List of VpnSites.

O365BreakOutCategoryPolicies

Office365 breakout categories.

Name	Type	Description
allow	boolean	Flag to control allow category.
default	boolean	Flag to control default category.
optimize	boolean	Flag to control optimize category.

O365PolicyProperties

The Office365 breakout policy.

Name	Type	Description
breakOutCategories	O365BreakOutCategoryPolicies	Office365 breakout categories.

ProvisioningState

The current provisioning state.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.

VpnLinkBgpSettings

BGP settings details for a link.

Name	Type	Description
asn	integer	The BGP speaker's ASN.
bgpPeeringAddress	string	The BGP peering address and BGP identifier of this BGP speaker.

VpnLinkProviderProperties

List of properties of a link provider.

Name	Type	Description
linkProviderName	string	Name of the link provider.
linkSpeedInMbps	integer	Link speed.

VpnSite

VpnSite 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.addressSpace	AddressSpace	The AddressSpace that contains an array of IP address ranges.
properties.bgpProperties	BgpSettings	The set of bgp properties.
properties.deviceProperties	DeviceProperties	The device properties.
properties.ipAddress	string	The ip-address for the vpn-site.
properties.isSecuritySite	boolean	IsSecuritySite flag.
properties.o365Policy	O365PolicyProperties	Office365 Policy.
properties.provisioningState	ProvisioningState	The provisioning state of the VPN site resource.
properties.siteKey	string	The key for vpn-site that can be used for connections.
properties.virtualWan	SubResource	The VirtualWAN to which the vpnSite belongs.
properties.vpnSiteLinks	VpnSiteLink[]	List of all vpn site links.
tags	object	Resource tags.
type	string	Resource type.

VpnSiteLink

VpnSiteLink Resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.bgpProperties	VpnLinkBgpSettings	The set of bgp properties.
properties.fqdn	string	FQDN of vpn-site-link.
properties.ipAddress	string	The ip-address for the vpn-site-link.
properties.linkProperties	VpnLinkProviderProperties	The link provider properties.
properties.provisioningState	ProvisioningState	The provisioning state of the VPN site link resource.
type	string	Resource type.