Vpn Sites - List By Resource Group

Referencia

Szolgáltatás:: Virtual WAN

API-verzió:: 2023-11-01

Egy erőforráscsoport összes vpnSite-ját listázza.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	A VpnSite erőforráscsoportjának neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	ListVpnSitesResult	A kérés sikeres. Az erőforráscsoportban lévő összes vpnSites adatait adja vissza.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

VpnSiteListByResourceGroup

Mintakérelem

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


/**
 * Samples for VpnSites ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VpnSiteListByResourceGroup.
     * json
     */
    /**
     * Sample code: VpnSiteListByResourceGroup.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnSiteListByResourceGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnSites().listByResourceGroup("rg1",
            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_by_resource_group.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_by_resource_group(
        resource_group_name="rg1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VpnSiteListByResourceGroup.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/f4c6c8697c59f966db0d1e36b62df3af3bca9065/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VpnSiteListByResourceGroup.json
func ExampleVPNSitesClient_NewListByResourceGroupPager() {
	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().NewListByResourceGroupPager("rg1", 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/rg1/providers/Microsoft.Network/vpnSites/vpnSite2"),
		// 				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")},
		// 						},
		// 						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"),
		// 						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 resource group.
 *
 * @summary Lists all the vpnSites in a resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VpnSiteListByResourceGroup.json
 */
async function vpnSiteListByResourceGroup() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.vpnSites.listByResourceGroup(resourceGroupName)) {
    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

Mintaválasz

Állapotkó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/rg1/providers/Microsoft.Network/vpnSites/vpnSite2",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "West US",
      "name": "vpnSite2",
      "type": "Microsoft.Network/vpnSites",
      "tags": {
        "key1": "value1"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "virtualWan": "/subscriptions/subid/resourceGroups/rg1/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
        }
      }
    }
  ]
}

Definíciók

Name	Description
AddressSpace	A AddressSpace a virtuális hálózat alhálózatai által használható IP-címtartományokat tartalmazó tömböt tartalmaz.
BgpSettings	A BGP beállításainak részletei.
CloudError	Hibaválasz a szolgáltatástól.
CloudErrorBody	Hibaválasz a szolgáltatástól.
DeviceProperties	Az eszköz tulajdonságainak listája.
IPConfigurationBgpPeeringAddress	Az IPConfigurationBgpPeeringAddress tulajdonságai.
ListVpnSitesResult	A VpnSites listázására irányuló kérés eredménye. Tartalmazza a VpnSites listáját és egy URL-címet a következő találatok lekéréséhez.
O365BreakOutCategoryPolicies	Office365-ös mellékkategóriák.
O365PolicyProperties	Az Office365-ös különrend.
ProvisioningState	Az aktuális kiépítési állapot.
SubResource	Hivatkozás egy másik alforrásra.
VpnLinkBgpSettings	A hivatkozás BGP-beállításainak részletei.
VpnLinkProviderProperties	Hivatkozásszolgáltató tulajdonságainak listája.
VpnSite	VpnSite-erőforrás.
VpnSiteLink	VpnSiteLink-erőforrás.

AddressSpace

A AddressSpace a virtuális hálózat alhálózatai által használható IP-címtartományokat tartalmazó tömböt tartalmaz.

Name	Típus	Description
addressPrefixes	string[]	A CIDR-jelölésben a virtuális hálózat számára fenntartott címblokkok listája.

BgpSettings

A BGP beállításainak részletei.

Name	Típus	Description
asn	integer	A BGP-hangszóró ASN-jét.
bgpPeeringAddress	string	A BGP-társviszony-létesítési cím és a BGP-beszélő BGP-azonosítója.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	BGP-társviszony-létesítési cím a virtuális hálózati átjáró IP-konfigurációazonosítójával.
peerWeight	integer	A BGP-hangszóróból tanult útvonalakhoz hozzáadott súly.

CloudError

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	Felhőbeli hibatörzs.

CloudErrorBody

Hibaválasz a szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
details	CloudErrorBody[]	A hiba további részleteinek listája.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja. Például a tulajdonság neve hibás.

DeviceProperties

Az eszköz tulajdonságainak listája.

Name	Típus	Description
deviceModel	string	Az eszköz modellje.
deviceVendor	string	Az eszköz szállítójának neve.
linkSpeedInMbps	integer	Kapcsolat sebessége.

IPConfigurationBgpPeeringAddress

Az IPConfigurationBgpPeeringAddress tulajdonságai.

Name	Típus	Description
customBgpIpAddresses	string[]	Az IP-konfigurációhoz tartozó egyéni BGP-társviszony-létesítési címek listája.
defaultBgpIpAddresses	string[]	Az IP-konfigurációhoz tartozó alapértelmezett BGP-társviszony-címek listája.
ipconfigurationId	string	Az átjáróhoz tartozó IP-konfiguráció azonosítója.
tunnelIpAddresses	string[]	Az IP-konfigurációhoz tartozó nyilvános bújtatási IP-címek listája.

ListVpnSitesResult

A VpnSites listázására irányuló kérés eredménye. Tartalmazza a VpnSites listáját és egy URL-címet a következő találatok lekéréséhez.

Name	Típus	Description
nextLink	string	URL-cím a következő műveletlista eredményeinek lekéréséhez, ha vannak ilyenek.
value	VpnSite[]	A VpnSites listája.

O365BreakOutCategoryPolicies

Office365-ös mellékkategóriák.

Name	Típus	Description
allow	boolean	Jelölő a kategória engedélyezésének szabályozásához.
default	boolean	Jelölő az alapértelmezett kategória szabályozásához.
optimize	boolean	Jelölő az optimalizált kategória szabályozásához.

O365PolicyProperties

Az Office365-ös különrend.

Name	Típus	Description
breakOutCategories	O365BreakOutCategoryPolicies	Office365-ös mellékkategóriák.

ProvisioningState

Az aktuális kiépítési állapot.

Name	Típus	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Hivatkozás egy másik alforrásra.

Name	Típus	Description
id	string	Erőforrás-azonosító.

VpnLinkBgpSettings

A hivatkozás BGP-beállításainak részletei.

Name	Típus	Description
asn	integer	A BGP-hangszóró ASN-jét.
bgpPeeringAddress	string	A BGP-társviszony-létesítési cím és a BGP-beszélő BGP-azonosítója.

VpnLinkProviderProperties

Hivatkozásszolgáltató tulajdonságainak listája.

Name	Típus	Description
linkProviderName	string	A hivatkozásszolgáltató neve.
linkSpeedInMbps	integer	Kapcsolat sebessége.

VpnSite

VpnSite-erőforrás.

Name	Típus	Description
etag	string	Egyedi írásvédett sztring, amely az erőforrás frissítésekor változik.
id	string	Erőforrás-azonosító.
location	string	Erőforrás helye.
name	string	Erőforrás neve.
properties.addressSpace	AddressSpace	Az IP-címtartományokat tartalmazó AddressSpace.
properties.bgpProperties	BgpSettings	A bgp-tulajdonságok halmaza.
properties.deviceProperties	DeviceProperties	Az eszköz tulajdonságai.
properties.ipAddress	string	A VPN-hely IP-címe.
properties.isSecuritySite	boolean	IsSecuritySite jelző.
properties.o365Policy	O365PolicyProperties	Office365-szabályzat.
properties.provisioningState	ProvisioningState	A VPN-helyerőforrás kiépítési állapota.
properties.siteKey	string	A kapcsolatokhoz használható VPN-hely kulcsa.
properties.virtualWan	SubResource	Az a VirtualWAN, amelyhez a vpnSite tartozik.
properties.vpnSiteLinks	VpnSiteLink[]	Az összes VPN-webhelyhivatkozás listája.
tags	object	Erőforráscímkék.
type	string	Erőforrás típusa.

VpnSiteLink

VpnSiteLink-erőforrás.

Name	Típus	Description
etag	string	Egyedi írásvédett sztring, amely az erőforrás frissítésekor változik.
id	string	Erőforrás-azonosító.
name	string	Az erőforráscsoporton belül egyedi erőforrás neve. Ez a név használható az erőforrás eléréséhez.
properties.bgpProperties	VpnLinkBgpSettings	A bgp-tulajdonságok halmaza.
properties.fqdn	string	A vpn-site-link teljes tartománynevét.
properties.ipAddress	string	A vpn-site-link IP-címe.
properties.linkProperties	VpnLinkProviderProperties	A hivatkozásszolgáltató tulajdonságai.
properties.provisioningState	ProvisioningState	A VPN-helykapcsolati erőforrás kiépítési állapota.
type	string	Erőforrás típusa.

Megosztás a következőn keresztül:

Vpn Sites - List By Resource Group

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

VpnSiteListByResourceGroup

Mintakérelem

Mintaválasz

Definíciók

AddressSpace

BgpSettings

CloudError

CloudErrorBody

DeviceProperties

IPConfigurationBgpPeeringAddress

ListVpnSitesResult

O365BreakOutCategoryPolicies

O365PolicyProperties

ProvisioningState

SubResource

VpnLinkBgpSettings

VpnLinkProviderProperties

VpnSite

VpnSiteLink

További források