Vpn Sites - List By Resource Group

參考

服務:: Virtual WAN

API 版本:: 2024-05-01

列出資源群組中的所有 vpnSites。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	VpnSite 的資源組名。
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	ListVpnSitesResult	要求成功。傳回資源群組中所有 vpnSites 的詳細數據。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

VpnSiteListByResourceGroup

範例要求

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


/**
 * Samples for VpnSites ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-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/2024-05-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/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/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{
		// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/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 resource group.
 *
 * @summary Lists all the vpnSites in a resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-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

範例回覆

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

定義

名稱	Description
AddressSpace	AddressSpace 包含可由虛擬網路子網使用的IP位址範圍數位。
BgpSettings	BGP 設定詳細數據。
CloudError	來自服務的錯誤回應。
CloudErrorBody	來自服務的錯誤回應。
DeviceProperties	裝置的屬性清單。
IpamPoolPrefixAllocation	IpamPool 前置詞配置參考。
IPConfigurationBgpPeeringAddress	IPConfigurationBgpPeeringAddress 的屬性。
ListVpnSitesResult	列出 VpnSites 的要求結果。其中包含 VpnSites 清單和 url nextLink，以取得下一組結果。
O365BreakOutCategoryPolicies	Office365 分組類別。
O365PolicyProperties	Office365 分拆原則。
ProvisioningState	目前的布建狀態。
SubResource	另一個子資源的參考。
VpnLinkBgpSettings	連結的 BGP 設定詳細數據。
VpnLinkProviderProperties	連結提供者的屬性清單。
VpnSite	VpnSite 資源。
VpnSiteLink	VpnSiteLink 資源。

AddressSpace

AddressSpace 包含可由虛擬網路子網使用的IP位址範圍數位。

名稱	類型	Description
addressPrefixes	string[]	以 CIDR 表示法保留給此虛擬網路的位址區塊清單。
ipamPoolPrefixAllocations	IpamPoolPrefixAllocation[]	配置IP位址前置的IPAM集區清單。

BgpSettings

BGP 設定詳細數據。

名稱	類型	Description
asn	integer	BGP 喇叭的 ASN。
bgpPeeringAddress	string	這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	具有虛擬網路閘道IP組態標識碼的 BGP 對等互連位址。
peerWeight	integer	新增至此 BGP 喇叭所學習路由的權數。

CloudError

來自服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	雲端錯誤本文。

CloudErrorBody

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。例如，錯誤中的屬性名稱。

DeviceProperties

裝置的屬性清單。

名稱	類型	Description
deviceModel	string	裝置的模型。
deviceVendor	string	裝置廠商的名稱。
linkSpeedInMbps	integer	連結速度。

IpamPoolPrefixAllocation

IpamPool 前置詞配置參考。

名稱	類型	Description
allocatedAddressPrefixes	string[]	相關聯資源的 IpamPool 中指派的 IP 位址前置詞清單。
numberOfIpAddresses	string	要配置的IP位址數目。
pool.id	string	相關聯 Azure IpamPool 資源的資源標識碼。

IPConfigurationBgpPeeringAddress

IPConfigurationBgpPeeringAddress 的屬性。

名稱	類型	Description
customBgpIpAddresses	string[]	屬於IP組態的自訂BGP對等互連位址清單。
defaultBgpIpAddresses	string[]	屬於IP組態的預設 BGP 對等互連位址清單。
ipconfigurationId	string	屬於閘道的IP組態標識碼。
tunnelIpAddresses	string[]	屬於IP組態的通道公用IP位址清單。

ListVpnSitesResult

列出 VpnSites 的要求結果。其中包含 VpnSites 清單和 url nextLink，以取得下一組結果。

名稱	類型	Description
nextLink	string	如果有的話，取得下一組作業清單結果的URL。
value	VpnSite[]	VpnSites 的清單。

O365BreakOutCategoryPolicies

Office365 分組類別。

名稱	類型	Description
allow	boolean	用來控制允許類別的旗標。
default	boolean	用來控制預設類別的旗標。
optimize	boolean	用來控制優化類別的旗標。

O365PolicyProperties

Office365 分拆原則。

名稱	類型	Description
breakOutCategories	O365BreakOutCategoryPolicies	Office365 分組類別。

ProvisioningState

目前的布建狀態。

名稱	類型	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

另一個子資源的參考。

名稱	類型	Description
id	string	資源標識碼。

VpnLinkBgpSettings

連結的 BGP 設定詳細數據。

名稱	類型	Description
asn	integer	BGP 喇叭的 ASN。
bgpPeeringAddress	string	這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。

VpnLinkProviderProperties

連結提供者的屬性清單。

名稱	類型	Description
linkProviderName	string	連結提供者的名稱。
linkSpeedInMbps	integer	連結速度。

VpnSite

VpnSite 資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源標識碼。
location	string	資源位置。
name	string	資源名稱。
properties.addressSpace	AddressSpace	包含IP位址範圍數位的AddressSpace。
properties.bgpProperties	BgpSettings	bgp 屬性集。
properties.deviceProperties	DeviceProperties	裝置屬性。
properties.ipAddress	string	vpn-site 的 ip-address。
properties.isSecuritySite	boolean	IsSecuritySite 旗標。
properties.o365Policy	O365PolicyProperties	Office365 原則。
properties.provisioningState	ProvisioningState	VPN 月臺資源的布建狀態。
properties.siteKey	string	VPN 月臺的金鑰，可用於連線。
properties.virtualWan	SubResource	vpnSite 所屬的 VirtualWAN。
properties.vpnSiteLinks	VpnSiteLink[]	所有 VPN 網站連結的清單。
tags	object	資源標籤。
type	string	資源類型。

VpnSiteLink

VpnSiteLink 資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源標識碼。
name	string	資源群組內唯一的資源名稱。此名稱可用來存取資源。
properties.bgpProperties	VpnLinkBgpSettings	bgp 屬性集。
properties.fqdn	string	vpn-site-link 的 FQDN。
properties.ipAddress	string	vpn-site-link 的 ip-address。
properties.linkProperties	VpnLinkProviderProperties	連結提供者屬性。
properties.provisioningState	ProvisioningState	VPN 網站鏈接資源的布建狀態。
type	string	資源類型。

共用方式為

Vpn Sites - List By Resource Group

URI 參數

回應

安全性

azure_auth

範圍

範例

VpnSiteListByResourceGroup

範例要求

範例回覆

定義

AddressSpace

BgpSettings

CloudError

CloudErrorBody

DeviceProperties

IpamPoolPrefixAllocation

IPConfigurationBgpPeeringAddress

ListVpnSitesResult

O365BreakOutCategoryPolicies

O365PolicyProperties

ProvisioningState

SubResource

VpnLinkBgpSettings

VpnLinkProviderProperties

VpnSite

VpnSiteLink

其他資源