Vpn Link Connections - List By Vpn Connection

サービス:

Virtual WAN

API バージョン:

2024-05-01

特定の仮想 WAN VPN ゲートウェイ VPN 接続のすべての VPN サイト リンク接続を取得します。

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

URI パラメーター

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

応答

名前	型	説明
200 OK	ListVpnSiteLinkConnectionsResult	要求が成功しました。 仮想 WAN VPN ゲートウェイのすべての Vpn 接続を返します。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

VpnSiteLinkConnectionList

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections?api-version=2024-05-01

Java

/**
 * Samples for VpnLinkConnections ListByVpnConnection.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnSiteLinkConnectionList.
     * json
     */
    /**
     * Sample code: VpnSiteLinkConnectionList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnSiteLinkConnectionList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnLinkConnections().listByVpnConnection("rg1", "gateway1",
            "vpnConnection1", 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

Python

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_link_connection_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_link_connections.list_by_vpn_connection(
        resource_group_name="rg1",
        gateway_name="gateway1",
        connection_name="vpnConnection1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnSiteLinkConnectionList.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

Go

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/VpnSiteLinkConnectionList.json
func ExampleVPNLinkConnectionsClient_NewListByVPNConnectionPager() {
	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.NewVPNLinkConnectionsClient().NewListByVPNConnectionPager("rg1", "gateway1", "vpnConnection1", 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.ListVPNSiteLinkConnectionsResult = armnetwork.ListVPNSiteLinkConnectionsResult{
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.
 *
 * @summary Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnSiteLinkConnectionList.json
 */
async function vpnSiteLinkConnectionList() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const gatewayName = "gateway1";
  const connectionName = "vpnConnection1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.vpnLinkConnections.listByVpnConnection(
    resourceGroupName,
    gatewayName,
    connectionName,
  )) {
    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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnSiteLinkConnectionList.json
// this example is just showing the usage of "VpnLinkConnections_ListByVpnConnection" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VpnConnectionResource created on azure
// for more information of creating VpnConnectionResource, please refer to the document of VpnConnectionResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string gatewayName = "gateway1";
string connectionName = "vpnConnection1";
ResourceIdentifier vpnConnectionResourceId = VpnConnectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, gatewayName, connectionName);
VpnConnectionResource vpnConnection = client.GetVpnConnectionResource(vpnConnectionResourceId);

// get the collection of this VpnSiteLinkConnectionResource
VpnSiteLinkConnectionCollection collection = vpnConnection.GetVpnSiteLinkConnections();

// invoke the operation and iterate over the result
await foreach (VpnSiteLinkConnectionResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    VpnSiteLinkConnectionData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

[
  {
    "name": "Connection-Link1",
    "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
    "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
    "properties": {
      "provisioningState": "Succeeded",
      "vpnSiteLink": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
      },
      "connectionBandwidth": 200,
      "ipsecPolicies": [],
      "vpnConnectionProtocolType": "IKEv2",
      "sharedKey": "key",
      "ingressBytesTransferred": 0,
      "egressBytesTransferred": 0,
      "enableBgp": false,
      "vpnGatewayCustomBgpAddresses": [
        {
          "ipConfigurationId": "Instance0",
          "customBgpIpAddress": "169.254.21.1"
        },
        {
          "ipConfigurationId": "Instance1",
          "customBgpIpAddress": "169.254.21.3"
        }
      ],
      "enableRateLimiting": false,
      "useLocalAzureIpAddress": false,
      "usePolicyBasedTrafficSelectors": false,
      "routingWeight": 0,
      "dpdTimeoutSeconds": 0
    }
  }
]

定義

名前	説明
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
DhGroup	初期 SA の IKE フェーズ 1 で使用される DH グループ。
GatewayCustomBgpIpAddressIpConfiguration	仮想ネットワーク ゲートウェイ接続の GatewayCustomBgpIpAddressIpConfiguration。
IkeEncryption	IKE 暗号化アルゴリズム (IKE フェーズ 2)。
IkeIntegrity	IKE 整合性アルゴリズム (IKE フェーズ 2)。
IpsecEncryption	IPSec 暗号化アルゴリズム (IKE フェーズ 1)。
IpsecIntegrity	IPSec 整合性アルゴリズム (IKE フェーズ 1)。
IpsecPolicy	仮想ネットワーク ゲートウェイ接続の IPSec ポリシー構成。
ListVpnSiteLinkConnectionsResult	仮想 WAN VPN ゲートウェイへのすべての VPN 接続を一覧表示する要求の結果。 これには、Vpn 接続の一覧と、次の結果セットを取得するための URL nextLink が含まれています。
PfsGroup	IKE フェーズ 2 で新しい子 SA に使用される Pfs グループ。
ProvisioningState	現在のプロビジョニング状態。
SubResource	別のサブリソースへの参照。
VirtualNetworkGatewayConnectionProtocol	この接続に使用される接続プロトコル。
VpnConnectionStatus	VPN 接続の現在の状態。
VpnLinkConnectionMode	VPN リンク接続モード。
VpnSiteLinkConnection	VpnSiteLinkConnection リソース。

CloudError

Object

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

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

CloudErrorBody

Object

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

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

DhGroup

列挙

初期 SA の IKE フェーズ 1 で使用される DH グループ。

値	説明
DHGroup1
DHGroup14
DHGroup2
DHGroup2048
DHGroup24
ECP256
ECP384
None

GatewayCustomBgpIpAddressIpConfiguration

Object

仮想ネットワーク ゲートウェイ接続の GatewayCustomBgpIpAddressIpConfiguration。

名前	型	説明
customBgpIpAddress	string	IpconfigurationId に属するカスタム BgpPeeringAddress。
ipConfigurationId	string	ゲートウェイに属する ipconfiguration の IpconfigurationId。

IkeEncryption

列挙

IKE 暗号化アルゴリズム (IKE フェーズ 2)。

値	説明
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES256

IkeIntegrity

列挙

IKE 整合性アルゴリズム (IKE フェーズ 2)。

値	説明
GCMAES128
GCMAES256
MD5
SHA1
SHA256
SHA384

IpsecEncryption

列挙

IPSec 暗号化アルゴリズム (IKE フェーズ 1)。

値	説明
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES192
GCMAES256
None

IpsecIntegrity

列挙

IPSec 整合性アルゴリズム (IKE フェーズ 1)。

値	説明
GCMAES128
GCMAES192
GCMAES256
MD5
SHA1
SHA256

IpsecPolicy

Object

仮想ネットワーク ゲートウェイ接続の IPSec ポリシー構成。

名前	型	説明
dhGroup	DhGroup	初期 SA に IKE フェーズ 1 で使用される DH グループ。
ikeEncryption	IkeEncryption	IKE 暗号化アルゴリズム (IKE フェーズ 2)。
ikeIntegrity	IkeIntegrity	IKE 整合性アルゴリズム (IKE フェーズ 2)。
ipsecEncryption	IpsecEncryption	IPSec 暗号化アルゴリズム (IKE フェーズ 1)。
ipsecIntegrity	IpsecIntegrity	IPSec 整合性アルゴリズム (IKE フェーズ 1)。
pfsGroup	PfsGroup	IKE フェーズ 2 で新しい子 SA に使用される Pfs グループ。
saDataSizeKilobytes	integer (int32)	サイト間 VPN トンネルの IPSec セキュリティ アソシエーション (クイック モードまたはフェーズ 2 SA とも呼ばれます) ペイロード サイズ (KB)。
saLifeTimeSeconds	integer (int32)	サイト間 VPN トンネルの IPSec セキュリティ アソシエーション (クイック モードまたはフェーズ 2 SA とも呼ばれます) の有効期間 (秒単位)。

ListVpnSiteLinkConnectionsResult

Object

仮想 WAN VPN ゲートウェイへのすべての VPN 接続を一覧表示する要求の結果。 これには、Vpn 接続の一覧と、次の結果セットを取得するための URL nextLink が含まれています。

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

PfsGroup

列挙

IKE フェーズ 2 で新しい子 SA に使用される Pfs グループ。

値	説明
ECP256
ECP384
None
PFS1
PFS14
PFS2
PFS2048
PFS24
PFSMM

ProvisioningState

列挙

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

値	説明
Deleting
Failed
Succeeded
Updating

SubResource

Object

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

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

VirtualNetworkGatewayConnectionProtocol

列挙

この接続に使用される接続プロトコル。

値	説明
IKEv1
IKEv2

VpnConnectionStatus

列挙

VPN 接続の現在の状態。

値	説明
Connected
Connecting
NotConnected
Unknown

VpnLinkConnectionMode

列挙

VPN リンク接続モード。

値	説明
Default
InitiatorOnly
ResponderOnly

VpnSiteLinkConnection

Object

VpnSiteLinkConnection リソース。

名前	型	説明
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソース ID。
name	string	リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。
properties.connectionBandwidth	integer (int32)	予想される帯域幅 (MBPS)。
properties.connectionStatus	VpnConnectionStatus	接続の状態。
properties.dpdTimeoutSeconds	integer (int32)	VpnLink 接続のデッド ピア検出タイムアウト (秒単位)。
properties.egressBytesTransferred	integer (int64)	転送されたエグレス バイト数。
properties.egressNatRules	SubResource[]	エグレス NatRules の一覧。
properties.enableBgp	boolean	EnableBgp フラグ。
properties.enableRateLimiting	boolean	EnableBgp フラグ。
properties.ingressBytesTransferred	integer (int64)	転送されたイングレス バイト。
properties.ingressNatRules	SubResource[]	イングレス NatRules の一覧。
properties.ipsecPolicies	IpsecPolicy[]	この接続によって考慮される IPSec ポリシー。
properties.provisioningState	ProvisioningState	VPN サイト リンク接続リソースのプロビジョニング状態。
properties.routingWeight	integer (int32)	VPN 接続のルーティングの重み。
properties.sharedKey	string	VPN 接続の SharedKey。
properties.useLocalAzureIpAddress	boolean	ローカル Azure IP を使用して接続を開始します。
properties.usePolicyBasedTrafficSelectors	boolean	ポリシー ベースのトラフィック セレクターを有効にします。
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	この接続に使用される接続プロトコル。
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	この接続で使用される vpnGatewayCustomBgpAddresses。
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	VPN リンク接続モード。
properties.vpnSiteLink	SubResource	接続されている VPN サイト リンクの ID。
type	string	リソースの種類。