Vpn Sites - List

Reference

Služba:: Virtual WAN

Verze rozhraní API:: 2024-05-01

Zobrazí seznam všech webů VpnSites v předplatném.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	ListVpnSitesResult	Žádost byla úspěšná. Vrátí podrobnosti o všech webech VpnSites v předplatném.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

VpnSiteList

Ukázkový požadavek

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


/**
 * 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

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

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

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

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

Ukázková odpověď

Stavový kód:: 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
      }
    }
  ]
}

Definice

Name	Description
AddressSpace	AddressSpace obsahuje pole rozsahů IP adres, které můžou používat podsítě virtuální sítě.
BgpSettings	Podrobnosti o nastavení protokolu BGP.
CloudError	Chybová odpověď ze služby.
CloudErrorBody	Chybová odpověď ze služby.
DeviceProperties	Seznam vlastností zařízení
IpamPoolPrefixAllocation	Referenční informace o přidělování předpon IpamPool
IPConfigurationBgpPeeringAddress	Vlastnosti IPConfigurationBgpPeeringAddress.
ListVpnSitesResult	Výsledek požadavku na výpis webů VpnSites. Obsahuje seznam webů VpnSites a adresu URL nextLink k získání další sady výsledků.
O365BreakOutCategoryPolicies	Kategorie breakoutů v Office365
O365PolicyProperties	Zásady přerušení Office365
ProvisioningState	Aktuální stav zřizování.
SubResource	Odkaz na jiný podsourc.
VpnLinkBgpSettings	Podrobnosti nastavení protokolu BGP pro odkaz
VpnLinkProviderProperties	Seznam vlastností zprostředkovatele propojení
VpnSite	Prostředek VpnSite.
VpnSiteLink	Prostředek VpnSiteLink.

AddressSpace

AddressSpace obsahuje pole rozsahů IP adres, které můžou používat podsítě virtuální sítě.

Name	Typ	Description
addressPrefixes	string[]	Seznam bloků adres vyhrazených pro tuto virtuální síť v zápisu CIDR
ipamPoolPrefixAllocations	IpamPoolPrefixAllocation[]	Seznam fondů IPAM, které přidělují předpony IP adres.

BgpSettings

Podrobnosti o nastavení protokolu BGP.

Name	Typ	Description
asn	integer	ASN mluvčího protokolu BGP.
bgpPeeringAddress	string	Adresa partnerského vztahu protokolu BGP a identifikátor protokolu BGP tohoto mluvčího protokolu BGP.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	Adresa partnerského vztahu protokolu BGP s ID konfigurace PROTOKOLU IP pro bránu virtuální sítě.
peerWeight	integer	Váha přidaná do tras získaných z tohoto mluvčího protokolu BGP.

CloudError

Chybová odpověď ze služby.

Name	Typ	Description
error	CloudErrorBody	Text chyby cloudu.

CloudErrorBody

Chybová odpověď ze služby.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

DeviceProperties

Seznam vlastností zařízení

Name	Typ	Description
deviceModel	string	Model zařízení
deviceVendor	string	Název dodavatele zařízení.
linkSpeedInMbps	integer	Rychlost propojení.

IpamPoolPrefixAllocation

Referenční informace o přidělování předpon IpamPool

Name	Typ	Description
allocatedAddressPrefixes	string[]	Seznam předpon přiřazených IP adres v ipamPool přidruženého prostředku
numberOfIpAddresses	string	Počet IP adres, které se mají přidělit
pool.id	string	ID prostředku přidruženého prostředku Azure IpamPool.

IPConfigurationBgpPeeringAddress

Vlastnosti IPConfigurationBgpPeeringAddress.

Name	Typ	Description
customBgpIpAddresses	string[]	Seznam vlastních adres partnerského vztahu protokolu BGP, které patří do konfigurace PROTOKOLU IP.
defaultBgpIpAddresses	string[]	Seznam výchozích adres partnerského vztahu protokolu BGP, které patří do konfigurace PROTOKOLU IP.
ipconfigurationId	string	ID konfigurace PROTOKOLU IP, která patří k bráně.
tunnelIpAddresses	string[]	Seznam veřejných IP adres tunelu, které patří do konfigurace PROTOKOLU IP.

ListVpnSitesResult

Výsledek požadavku na výpis webů VpnSites. Obsahuje seznam webů VpnSites a adresu URL nextLink k získání další sady výsledků.

Name	Typ	Description
nextLink	string	Adresa URL pro získání další sady výsledků seznamu operací, pokud existují.
value	VpnSite[]	Seznam webů VpnSites

O365BreakOutCategoryPolicies

Kategorie breakoutů v Office365

Name	Typ	Description
allow	boolean	Příznak pro řízení povolené kategorie.
default	boolean	Příznak pro řízení výchozí kategorie
optimize	boolean	Příznak pro řízení kategorie optimalizace

O365PolicyProperties

Zásady přerušení Office365

Name	Typ	Description
breakOutCategories	O365BreakOutCategoryPolicies	Kategorie breakoutů v Office365

ProvisioningState

Aktuální stav zřizování.

Name	Typ	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Odkaz na jiný podsourc.

Name	Typ	Description
id	string	ID prostředku.

VpnLinkBgpSettings

Podrobnosti nastavení protokolu BGP pro odkaz

Name	Typ	Description
asn	integer	ASN mluvčího protokolu BGP.
bgpPeeringAddress	string	Adresa partnerského vztahu protokolu BGP a identifikátor protokolu BGP tohoto mluvčího protokolu BGP.

VpnLinkProviderProperties

Seznam vlastností zprostředkovatele propojení

Name	Typ	Description
linkProviderName	string	Název zprostředkovatele propojení
linkSpeedInMbps	integer	Rychlost propojení.

VpnSite

Prostředek VpnSite.

Name	Typ	Description
etag	string	Jedinečný řetězec jen pro čtení, který se změní při každé aktualizaci prostředku.
id	string	ID prostředku.
location	string	Umístění prostředku
name	string	Název prostředku
properties.addressSpace	AddressSpace	AddressSpace, který obsahuje pole rozsahů IP adres.
properties.bgpProperties	BgpSettings	Sada vlastností protokolu bgp.
properties.deviceProperties	DeviceProperties	Vlastnosti zařízení.
properties.ipAddress	string	IP adresa pro vpn-site.
properties.isSecuritySite	boolean	Příznak IsSecuritySite.
properties.o365Policy	O365PolicyProperties	Zásady Office365
properties.provisioningState	ProvisioningState	Stav zřizování prostředku lokality VPN.
properties.siteKey	string	Klíč pro vpn-site, který lze použít pro připojení.
properties.virtualWan	SubResource	VirtualWAN, do které vpnSite patří.
properties.vpnSiteLinks	VpnSiteLink[]	Seznam všech propojení lokalit vpn
tags	object	Značky prostředků
type	string	Typ prostředku.

VpnSiteLink

Prostředek VpnSiteLink.

Name	Typ	Description
etag	string	Jedinečný řetězec jen pro čtení, který se změní při každé aktualizaci prostředku.
id	string	ID prostředku.
name	string	Název prostředku, který je jedinečný v rámci skupiny prostředků. Tento název lze použít pro přístup k prostředku.
properties.bgpProperties	VpnLinkBgpSettings	Sada vlastností protokolu bgp.
properties.fqdn	string	Plně kvalifikovaný název domény vpn-site-link.
properties.ipAddress	string	IP adresa pro vpn-site-link.
properties.linkProperties	VpnLinkProviderProperties	Vlastnosti zprostředkovatele propojení.
properties.provisioningState	ProvisioningState	Stav zřizování prostředku propojení lokality VPN.
type	string	Typ prostředku.