Vpn Sites - List By Resource Group

リファレンス

サービス:: Virtual WAN

API バージョン:: 2024-05-01

リソースグループ内のすべての vpnSite を一覧表示します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	VpnSite のリソースグループ名。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	ListVpnSitesResult	要求が成功しました。リソースグループ内のすべての vpnSite の詳細を返します。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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
        }
      }
    }
  ]
}

定義

名前	説明
AddressSpace	AddressSpace には、仮想ネットワークのサブネットで使用できる IP アドレス範囲の配列が含まれています。
BgpSettings	BGP 設定の詳細。
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
DeviceProperties	デバイスのプロパティの一覧。
IpamPoolPrefixAllocation	IpamPool プレフィックス割り当てリファレンス。
IPConfigurationBgpPeeringAddress	IPConfigurationBgpPeeringAddress のプロパティ。
ListVpnSitesResult	VpnSite を一覧表示する要求の結果。これには、VpnSites の一覧と、次の結果セットを取得するための URL nextLink が含まれています。
O365BreakOutCategoryPolicies	Office365 ブレークアウトカテゴリ。
O365PolicyProperties	Office365 ブレークアウトポリシー。
ProvisioningState	現在のプロビジョニング状態。
SubResource	別のサブリソースへの参照。
VpnLinkBgpSettings	リンクの BGP 設定の詳細。
VpnLinkProviderProperties	リンクプロバイダーのプロパティの一覧。
VpnSite	VpnSite リソース。
VpnSiteLink	VpnSiteLink リソース。

AddressSpace

AddressSpace には、仮想ネットワークのサブネットで使用できる IP アドレス範囲の配列が含まれています。

名前	型	説明
addressPrefixes	string[]	CIDR 表記でこの仮想ネットワーク用に予約されているアドレスブロックの一覧。
ipamPoolPrefixAllocations	IpamPoolPrefixAllocation[]	IP アドレスプレフィックスを割り当てる IPAM プールの一覧。

BgpSettings

BGP 設定の詳細。

名前	型	説明
asn	integer	BGP スピーカーの ASN。
bgpPeeringAddress	string	この BGP スピーカーの BGP ピアリングアドレスと BGP 識別子。
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	仮想ネットワークゲートウェイの IP 構成 ID を持つ BGP ピアリングアドレス。
peerWeight	integer	この BGP スピーカーから学習したルートに追加された重み。

CloudError

サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	クラウドエラー本文。

CloudErrorBody

サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

DeviceProperties

デバイスのプロパティの一覧。

名前	型	説明
deviceModel	string	デバイスのモデル。
deviceVendor	string	デバイスベンダーの名前。
linkSpeedInMbps	integer	リンク速度。

IpamPoolPrefixAllocation

IpamPool プレフィックス割り当てリファレンス。

名前	型	説明
allocatedAddressPrefixes	string[]	関連付けられたリソースの IpamPool に割り当てられた IP アドレスプレフィックスの一覧。
numberOfIpAddresses	string	割り当てる IP アドレスの数。
pool.id	string	関連付けられている Azure IpamPool リソースのリソース ID。

IPConfigurationBgpPeeringAddress

IPConfigurationBgpPeeringAddress のプロパティ。

名前	型	説明
customBgpIpAddresses	string[]	IP 構成に属するカスタム BGP ピアリングアドレスの一覧。
defaultBgpIpAddresses	string[]	IP 構成に属する既定の BGP ピアリングアドレスの一覧。
ipconfigurationId	string	ゲートウェイに属する IP 構成の ID。
tunnelIpAddresses	string[]	IP 構成に属するトンネルパブリック IP アドレスの一覧。

ListVpnSitesResult

VpnSite を一覧表示する要求の結果。これには、VpnSites の一覧と、次の結果セットを取得するための URL nextLink が含まれています。

名前	型	説明
nextLink	string	操作リストの次のセットが存在する場合に結果を取得する URL。
value	VpnSite[]	VpnSites の一覧。

O365BreakOutCategoryPolicies

Office365 ブレークアウトカテゴリ。

名前	型	説明
allow	boolean	許可カテゴリを制御するフラグ。
default	boolean	既定のカテゴリを制御するフラグ。
optimize	boolean	最適化カテゴリを制御するフラグ。

O365PolicyProperties

Office365 ブレークアウトポリシー。

名前	型	説明
breakOutCategories	O365BreakOutCategoryPolicies	Office365 ブレークアウトカテゴリ。

ProvisioningState

現在のプロビジョニング状態。

名前	型	説明
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

別のサブリソースへの参照。

名前	型	説明
id	string	リソース ID。

VpnLinkBgpSettings

リンクの BGP 設定の詳細。

名前	型	説明
asn	integer	BGP スピーカーの ASN。
bgpPeeringAddress	string	この BGP スピーカーの BGP ピアリングアドレスと BGP 識別子。

VpnLinkProviderProperties

リンクプロバイダーのプロパティの一覧。

名前	型	説明
linkProviderName	string	リンクプロバイダーの名前。
linkSpeedInMbps	integer	リンク速度。

VpnSite

VpnSite リソース。

名前	型	説明
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソース ID。
location	string	リソースの場所。
name	string	リソース名。
properties.addressSpace	AddressSpace	IP アドレス範囲の配列を含む AddressSpace。
properties.bgpProperties	BgpSettings	bgp プロパティのセット。
properties.deviceProperties	DeviceProperties	デバイスのプロパティ。
properties.ipAddress	string	VPN サイトの IP アドレス。
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 リソース。

名前	型	説明
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソース ID。
name	string	リソースグループ内で一意であるリソースの名前。この名前は、リソースへのアクセスに使用できます。
properties.bgpProperties	VpnLinkBgpSettings	bgp プロパティのセット。
properties.fqdn	string	vpn-site-link の FQDN。
properties.ipAddress	string	vpn-site-link の IP アドレス。
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

その他のリソース