Vpn Sites - List

Servizio:

Virtual WAN

Versione API:

2024-05-01

Elenca tutti i siti Vpn in una sottoscrizione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string	Credenziali della sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string	Versione dell'API client.

Risposte

Nome	Tipo	Descrizione
200 OK	ListVpnSitesResult	Richiesta riuscita. Restituisce i dettagli di tutti i siti Vpn nella sottoscrizione.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

VpnSiteList

Esempio di richiesta

HTTP

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

Java

/**
 * Samples for VpnSites List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-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

Python

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/2024-05-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

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-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{
		// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan1"),
		// 						},
		// 					},
		// 			}},
		// 		}
	}
}

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 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/2024-05-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

dotnet

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-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

Risposta di esempio

Codice di stato:

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": {
          "id": "/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
      }
    }
  ]
}

Definizioni

Nome	Descrizione
AddressSpace	AddressSpace contiene una matrice di intervalli di indirizzi IP che possono essere usati dalle subnet della rete virtuale.
BgpSettings	Dettagli delle impostazioni BGP.
CloudError	Risposta di errore dal servizio.
CloudErrorBody	Risposta di errore dal servizio.
DeviceProperties	Elenco delle proprietà del dispositivo.
IpamPoolPrefixAllocation	Informazioni di riferimento sull'allocazione del prefisso IpamPool.
IPConfigurationBgpPeeringAddress	Proprietà di IPConfigurationBgpPeeringAddress.
ListVpnSitesResult	Risultato della richiesta per elencare VpnSites. Contiene un elenco di VpnSites e un URL nextLink per ottenere il set di risultati successivo.
O365BreakOutCategoryPolicies	Categorie di interruzione di Office365.
O365PolicyProperties	Criteri di interruzione di Office365.
ProvisioningState	Stato di provisioning corrente.
SubResource	Riferimento a un'altra sottorisorsa.
VpnLinkBgpSettings	Dettagli delle impostazioni BGP per un collegamento.
VpnLinkProviderProperties	Elenco delle proprietà di un provider di collegamenti.
VpnSite	Risorsa VpnSite.
VpnSiteLink	Risorsa VpnSiteLink.

AddressSpace

AddressSpace contiene una matrice di intervalli di indirizzi IP che possono essere usati dalle subnet della rete virtuale.

Nome	Tipo	Descrizione
addressPrefixes	string[]	Elenco di blocchi di indirizzi riservati per questa rete virtuale nella notazione CIDR.
ipamPoolPrefixAllocations	IpamPoolPrefixAllocation[]	Elenco dei pool di Gestione indirizzi IP che allocano i prefissi degli indirizzi IP.

BgpSettings

Dettagli delle impostazioni BGP.

Nome	Tipo	Descrizione
asn	integer	ASN dell'altoparlante BGP.
bgpPeeringAddress	string	L'indirizzo di peering BGP e l'identificatore BGP di questo altoparlante BGP.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	Indirizzo di peering BGP con ID di configurazione IP per il gateway di rete virtuale.
peerWeight	integer	Peso aggiunto alle route apprese da questo altoparlante BGP.

CloudError

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	CloudErrorBody	Corpo dell'errore cloud.

CloudErrorBody

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in errore.

DeviceProperties

Elenco delle proprietà del dispositivo.

Nome	Tipo	Descrizione
deviceModel	string	Modello del dispositivo.
deviceVendor	string	Nome del fornitore del dispositivo.
linkSpeedInMbps	integer	Velocità di collegamento.

IpamPoolPrefixAllocation

Informazioni di riferimento sull'allocazione del prefisso IpamPool.

Nome	Tipo	Descrizione
allocatedAddressPrefixes	string[]	Elenco dei prefissi degli indirizzi IP assegnati in IpamPool della risorsa associata.
numberOfIpAddresses	string	Numero di indirizzi IP da allocare.
pool.id	string	ID risorsa della risorsa IpamPool di Azure associata.

IPConfigurationBgpPeeringAddress

Proprietà di IPConfigurationBgpPeeringAddress.

Nome	Tipo	Descrizione
customBgpIpAddresses	string[]	Elenco di indirizzi di peering BGP personalizzati che appartengono alla configurazione IP.
defaultBgpIpAddresses	string[]	Elenco di indirizzi di peering BGP predefiniti che appartengono alla configurazione IP.
ipconfigurationId	string	ID della configurazione IP che appartiene al gateway.
tunnelIpAddresses	string[]	Elenco di indirizzi IP pubblici del tunnel che appartengono alla configurazione IP.

ListVpnSitesResult

Risultato della richiesta per elencare VpnSites. Contiene un elenco di VpnSites e un URL nextLink per ottenere il set di risultati successivo.

Nome	Tipo	Descrizione
nextLink	string	URL per ottenere il set successivo di risultati dell'elenco di operazioni, se presenti.
value	VpnSite[]	Elenco di VpnSites.

O365BreakOutCategoryPolicies

Categorie di interruzione di Office365.

Nome	Tipo	Descrizione
allow	boolean	Contrassegno per controllare la categoria consenti.
default	boolean	Contrassegno per controllare la categoria predefinita.
optimize	boolean	Flag per controllare la categoria di ottimizzazione.

O365PolicyProperties

Criteri di interruzione di Office365.

Nome	Tipo	Descrizione
breakOutCategories	O365BreakOutCategoryPolicies	Categorie di interruzione di Office365.

ProvisioningState

Stato di provisioning corrente.

Nome	Tipo	Descrizione
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Riferimento a un'altra sottorisorsa.

Nome	Tipo	Descrizione
id	string	ID risorsa.

VpnLinkBgpSettings

Dettagli delle impostazioni BGP per un collegamento.

Nome	Tipo	Descrizione
asn	integer	ASN dell'altoparlante BGP.
bgpPeeringAddress	string	L'indirizzo di peering BGP e l'identificatore BGP di questo altoparlante BGP.

VpnLinkProviderProperties

Elenco delle proprietà di un provider di collegamenti.

Nome	Tipo	Descrizione
linkProviderName	string	Nome del provider di collegamenti.
linkSpeedInMbps	integer	Velocità di collegamento.

VpnSite

Risorsa VpnSite.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
location	string	Percorso della risorsa.
name	string	Nome risorsa.
properties.addressSpace	AddressSpace	AddressSpace che contiene una matrice di intervalli di indirizzi IP.
properties.bgpProperties	BgpSettings	Set di proprietà bgp.
properties.deviceProperties	DeviceProperties	Proprietà del dispositivo.
properties.ipAddress	string	Indirizzo IP per il sito VPN.
properties.isSecuritySite	boolean	Flag IsSecuritySite.
properties.o365Policy	O365PolicyProperties	Criteri di Office365.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa del sito VPN.
properties.siteKey	string	Chiave per vpn-site che può essere usata per le connessioni.
properties.virtualWan	SubResource	Rete WAN virtuale a cui appartiene il sito VPN.
properties.vpnSiteLinks	VpnSiteLink[]	Elenco di tutti i collegamenti al sito VPN.
tags	object	Tag di risorsa.
type	string	Tipo di risorsa.

VpnSiteLink

Risorsa VpnSiteLink.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.bgpProperties	VpnLinkBgpSettings	Set di proprietà bgp.
properties.fqdn	string	FQDN di vpn-site-link.
properties.ipAddress	string	Indirizzo IP per vpn-site-link.
properties.linkProperties	VpnLinkProviderProperties	Proprietà del provider di collegamenti.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa collegamento al sito VPN.
type	string	Tipo di risorsa.