Vpn Sites - List

Referens

Tjänst:: Virtual WAN

API-version:: 2024-05-01

Visar en lista över alla VpnSites i en prenumeration.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string	Autentiseringsuppgifterna för prenumerationen som unikt identifierar Microsoft Azure-prenumerationen. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	ListVpnSitesResult	Begäran lyckades. Returnerar information om alla VpnSites i prenumerationen.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

VpnSiteList

Exempelbegäran

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

Exempelsvar

Statuskod:: 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
      }
    }
  ]
}

Definitioner

Name	Description
AddressSpace	AddressSpace innehåller en matris med IP-adressintervall som kan användas av undernät i det virtuella nätverket.
BgpSettings	Information om BGP-inställningar.
CloudError	Ett felsvar från tjänsten.
CloudErrorBody	Ett felsvar från tjänsten.
DeviceProperties	Lista över enhetens egenskaper.
IpamPoolPrefixAllocation	IpamPool-prefixallokeringsreferens.
IPConfigurationBgpPeeringAddress	Egenskaper för IPConfigurationBgpPeeringAddress.
ListVpnSitesResult	Resultatet av begäran om att lista VpnSites. Den innehåller en lista över VpnSites och en URL nextLink för att få nästa uppsättning resultat.
O365BreakOutCategoryPolicies	Utbrytarkategorier för Office365.
O365PolicyProperties	Utbrytningsprincipen för Office365.
ProvisioningState	Det aktuella etableringstillståndet.
SubResource	Referens till en annan underresurs.
VpnLinkBgpSettings	Information om BGP-inställningar för en länk.
VpnLinkProviderProperties	Lista över egenskaper för en länkprovider.
VpnSite	VpnSite-resurs.
VpnSiteLink	VpnSiteLink-resurs.

AddressSpace

AddressSpace innehåller en matris med IP-adressintervall som kan användas av undernät i det virtuella nätverket.

Name	Typ	Description
addressPrefixes	string[]	En lista över adressblock som är reserverade för det här virtuella nätverket i CIDR-notation.
ipamPoolPrefixAllocations	IpamPoolPrefixAllocation[]	En lista över IPAM-pooler som allokerar IP-adressprefix.

BgpSettings

Information om BGP-inställningar.

Name	Typ	Description
asn	integer	BGP-talarens ASN.
bgpPeeringAddress	string	BGP-peeringadressen och BGP-identifieraren för den här BGP-talaren.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	BGP-peeringadress med IP-konfigurations-ID för virtuell nätverksgateway.
peerWeight	integer	Vikten som lagts till i vägar som lärts från den här BGP-talaren.

CloudError

Ett felsvar från tjänsten.

Name	Typ	Description
error	CloudErrorBody	Molnfeltext.

CloudErrorBody

Ett felsvar från tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
details	CloudErrorBody[]	En lista med ytterligare information om felet.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
target	string	Målet för det specifika felet. Till exempel namnet på egenskapen i fel.

DeviceProperties

Lista över enhetens egenskaper.

Name	Typ	Description
deviceModel	string	Enhetens modell.
deviceVendor	string	Namnet på enhetsleverantören.
linkSpeedInMbps	integer	Länkhastighet.

IpamPoolPrefixAllocation

IpamPool-prefixallokeringsreferens.

Name	Typ	Description
allocatedAddressPrefixes	string[]	Lista över tilldelade IP-adressprefix i IpamPool för den associerade resursen.
numberOfIpAddresses	string	Antal IP-adresser som ska allokeras.
pool.id	string	Resurs-ID för den associerade Azure IpamPool-resursen.

IPConfigurationBgpPeeringAddress

Egenskaper för IPConfigurationBgpPeeringAddress.

Name	Typ	Description
customBgpIpAddresses	string[]	Listan över anpassade BGP-peeringadresser som tillhör IP-konfigurationen.
defaultBgpIpAddresses	string[]	Listan över standardadresser för BGP-peering som tillhör IP-konfigurationen.
ipconfigurationId	string	ID för IP-konfiguration som tillhör gatewayen.
tunnelIpAddresses	string[]	Listan över offentliga IP-adresser för tunnlar som tillhör IP-konfigurationen.

ListVpnSitesResult

Resultatet av begäran om att lista VpnSites. Den innehåller en lista över VpnSites och en URL nextLink för att få nästa uppsättning resultat.

Name	Typ	Description
nextLink	string	URL för att hämta nästa uppsättning resultat i åtgärdslistan om det finns några.
value	VpnSite[]	Lista över VpnSites.

O365BreakOutCategoryPolicies

Utbrytarkategorier för Office365.

Name	Typ	Description
allow	boolean	Flagga för att styra tillåt kategori.
default	boolean	Flagga för att styra standardkategorin.
optimize	boolean	Flagga för att styra optimeringskategorin.

O365PolicyProperties

Utbrytningsprincipen för Office365.

Name	Typ	Description
breakOutCategories	O365BreakOutCategoryPolicies	Utbrytarkategorier för Office365.

ProvisioningState

Det aktuella etableringstillståndet.

Name	Typ	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Referens till en annan underresurs.

Name	Typ	Description
id	string	Resurs-ID.

VpnLinkBgpSettings

Information om BGP-inställningar för en länk.

Name	Typ	Description
asn	integer	BGP-talarens ASN.
bgpPeeringAddress	string	BGP-peeringadressen och BGP-identifieraren för den här BGP-talaren.

VpnLinkProviderProperties

Lista över egenskaper för en länkprovider.

Name	Typ	Description
linkProviderName	string	Namnet på länkprovidern.
linkSpeedInMbps	integer	Länkhastighet.

VpnSite

VpnSite-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
location	string	Resursplats.
name	string	Resursnamn.
properties.addressSpace	AddressSpace	Adressområdet som innehåller en matris med IP-adressintervall.
properties.bgpProperties	BgpSettings	Uppsättningen med bgp-egenskaper.
properties.deviceProperties	DeviceProperties	Enhetsegenskaperna.
properties.ipAddress	string	IP-adressen för vpn-platsen.
properties.isSecuritySite	boolean	IsSecuritySite-flagga.
properties.o365Policy	O365PolicyProperties	Office365-princip.
properties.provisioningState	ProvisioningState	Etableringstillståndet för VPN-platsresursen.
properties.siteKey	string	Nyckeln för vpn-plats som kan användas för anslutningar.
properties.virtualWan	SubResource	Den VirtualWAN som vpnSite tillhör.
properties.vpnSiteLinks	VpnSiteLink[]	Lista över alla vpn-webbplatslänkar.
tags	object	Resurstaggar.
type	string	Resurstyp.

VpnSiteLink

VpnSiteLink-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
name	string	Namnet på resursen som är unik i en resursgrupp. Det här namnet kan användas för att komma åt resursen.
properties.bgpProperties	VpnLinkBgpSettings	Uppsättningen med bgp-egenskaper.
properties.fqdn	string	FQDN för vpn-site-link.
properties.ipAddress	string	IP-adressen för vpn-site-link.
properties.linkProperties	VpnLinkProviderProperties	Egenskaperna för länkprovidern.
properties.provisioningState	ProvisioningState	Etableringstillståndet för VPN-platslänkresursen.
type	string	Resurstyp.

Dela via

Vpn Sites - List

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

VpnSiteList

Exempelbegäran

Exempelsvar

Definitioner

AddressSpace

BgpSettings

CloudError

CloudErrorBody

DeviceProperties

IpamPoolPrefixAllocation

IPConfigurationBgpPeeringAddress

ListVpnSitesResult

O365BreakOutCategoryPolicies

O365PolicyProperties

ProvisioningState

SubResource

VpnLinkBgpSettings

VpnLinkProviderProperties

VpnSite

VpnSiteLink

Ytterligare resurser