Vpn Sites - List

Referentie

Service:: Virtual WAN

API-versie:: 2024-05-01

Een lijst met alle VpnSites in een abonnement.

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

URI-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string	De abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	ListVpnSitesResult	Aanvraag is voltooid. Retourneert de details van alle VpnSites in het abonnement.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

VpnSiteList

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AddressSpace	AddressSpace bevat een matrix met IP-adresbereiken die kunnen worden gebruikt door subnetten van het virtuele netwerk.
BgpSettings	Details van BGP-instellingen.
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
DeviceProperties	Lijst met eigenschappen van het apparaat.
IpamPoolPrefixAllocation	Verwijzing naar ipamPool-voorvoegseltoewijzing.
IPConfigurationBgpPeeringAddress	Eigenschappen van IPConfigurationBgpPeeringAddress.
ListVpnSitesResult	Resultaat van de aanvraag om VpnSites weer te geven. Het bevat een lijst met VpnSites en een URL nextLink om de volgende set resultaten op te halen.
O365BreakOutCategoryPolicies	Aparte categorieën voor Office365.
O365PolicyProperties	Het office365-aparte beleid.
ProvisioningState	De huidige inrichtingsstatus.
SubResource	Verwijzing naar een andere subresource.
VpnLinkBgpSettings	Details van BGP-instellingen voor een koppeling.
VpnLinkProviderProperties	Lijst met eigenschappen van een koppelingsprovider.
VpnSite	VpnSite-resource.
VpnSiteLink	VpnSiteLink-resource.

AddressSpace

AddressSpace bevat een matrix met IP-adresbereiken die kunnen worden gebruikt door subnetten van het virtuele netwerk.

Name	Type	Description
addressPrefixes	string[]	Een lijst met adresblokken die zijn gereserveerd voor dit virtuele netwerk in CIDR-notatie.
ipamPoolPrefixAllocations	IpamPoolPrefixAllocation[]	Een lijst met IPAM-pools die IP-adresvoorvoegsels toewijzen.

BgpSettings

Details van BGP-instellingen.

Name	Type	Description
asn	integer	De ASN van de BGP-spreker.
bgpPeeringAddress	string	Het BGP-peeringadres en de BGP-id van deze BGP-spreker.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	BGP-peeringadres met IP-configuratie-id voor virtuele netwerkgateway.
peerWeight	integer	Het gewicht toegevoegd aan routes die zijn geleerd van deze BGP-luidspreker.

CloudError

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Hoofdtekst van cloudfout.

CloudErrorBody

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

DeviceProperties

Lijst met eigenschappen van het apparaat.

Name	Type	Description
deviceModel	string	Model van het apparaat.
deviceVendor	string	Naam van de leverancier van het apparaat.
linkSpeedInMbps	integer	Snelheid van koppeling.

IpamPoolPrefixAllocation

Verwijzing naar ipamPool-voorvoegseltoewijzing.

Name	Type	Description
allocatedAddressPrefixes	string[]	Lijst met toegewezen IP-adresvoorvoegsels in de IpamPool van de gekoppelde resource.
numberOfIpAddresses	string	Aantal IP-adressen dat moet worden toegewezen.
pool.id	string	Resource-id van de bijbehorende Azure IpamPool-resource.

IPConfigurationBgpPeeringAddress

Eigenschappen van IPConfigurationBgpPeeringAddress.

Name	Type	Description
customBgpIpAddresses	string[]	De lijst met aangepaste BGP-peeringadressen die deel uitmaken van ip-configuratie.
defaultBgpIpAddresses	string[]	De lijst met standaard BGP-peeringadressen die deel uitmaken van ip-configuratie.
ipconfigurationId	string	De id van de IP-configuratie die deel uitmaakt van de gateway.
tunnelIpAddresses	string[]	De lijst met openbare IP-adressen van de tunnel die deel uitmaken van de IP-configuratie.

ListVpnSitesResult

Resultaat van de aanvraag om VpnSites weer te geven. Het bevat een lijst met VpnSites en een URL nextLink om de volgende set resultaten op te halen.

Name	Type	Description
nextLink	string	URL voor het ophalen van de volgende set met resultaten van de bewerkingslijst, indien aanwezig.
value	VpnSite[]	Lijst met VpnSites.

O365BreakOutCategoryPolicies

Aparte categorieën voor Office365.

Name	Type	Description
allow	boolean	Vlag om de categorie Toestaan te beheren.
default	boolean	Vlag om de standaardcategorie te beheren.
optimize	boolean	Vlag om de categorie optimaliseren te beheren.

O365PolicyProperties

Het office365-aparte beleid.

Name	Type	Description
breakOutCategories	O365BreakOutCategoryPolicies	Aparte categorieën voor Office365.

ProvisioningState

De huidige inrichtingsstatus.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Verwijzing naar een andere subresource.

Name	Type	Description
id	string	Resource-id.

VpnLinkBgpSettings

Details van BGP-instellingen voor een koppeling.

Name	Type	Description
asn	integer	De ASN van de BGP-spreker.
bgpPeeringAddress	string	Het BGP-peeringadres en de BGP-id van deze BGP-spreker.

VpnLinkProviderProperties

Lijst met eigenschappen van een koppelingsprovider.

Name	Type	Description
linkProviderName	string	Naam van de koppelingsprovider.
linkSpeedInMbps	integer	Snelheid van koppeling.

VpnSite

VpnSite-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.addressSpace	AddressSpace	De AddressSpace die een matrix met IP-adresbereiken bevat.
properties.bgpProperties	BgpSettings	De set bgp-eigenschappen.
properties.deviceProperties	DeviceProperties	De apparaateigenschappen.
properties.ipAddress	string	Het IP-adres voor de vpn-site.
properties.isSecuritySite	boolean	IsSecuritySite-vlag.
properties.o365Policy	O365PolicyProperties	Office365-beleid.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de VPN-siteresource.
properties.siteKey	string	De sleutel voor vpn-site die kan worden gebruikt voor verbindingen.
properties.virtualWan	SubResource	De VirtualWAN waartoe de vpnSite behoort.
properties.vpnSiteLinks	VpnSiteLink[]	Lijst met alle vpn-sitekoppelingen.
tags	object	Resourcetags.
type	string	Resourcetype.

VpnSiteLink

VpnSiteLink-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.bgpProperties	VpnLinkBgpSettings	De set bgp-eigenschappen.
properties.fqdn	string	FQDN van vpn-site-link.
properties.ipAddress	string	Het IP-adres voor de vpn-site-link.
properties.linkProperties	VpnLinkProviderProperties	De eigenschappen van de koppelingsprovider.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de koppelingsresource voor de VPN-site.
type	string	Resourcetype.

Delen via

Vpn Sites - List

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

VpnSiteList

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AddressSpace

BgpSettings

CloudError

CloudErrorBody

DeviceProperties

IpamPoolPrefixAllocation

IPConfigurationBgpPeeringAddress

ListVpnSitesResult

O365BreakOutCategoryPolicies

O365PolicyProperties

ProvisioningState

SubResource

VpnLinkBgpSettings

VpnLinkProviderProperties

VpnSite

VpnSiteLink

Aanvullende resources