Virtual Network Gateways - List Connections

參考

Service:: Network Gateway

API Version:: 2023-09-01

取得虛擬網路閘道中的所有連線。

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

URI 參數

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

回應

名稱	類型	Description
200 OK	VirtualNetworkGatewayListConnectionsResult	要求成功。作業會傳回 VirtualNetworkGatewayConnection 資源的清單。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

範例

VirtualNetworkGatewaysListConnections

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkGateways/test-vpn-gateway-1/connections?api-version=2023-09-01


/**
 * Samples for VirtualNetworkGateways ListConnections.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * VirtualNetworkGatewaysListConnections.json
     */
    /**
     * Sample code: VirtualNetworkGatewaysListConnections.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualNetworkGatewaysListConnections(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualNetworkGateways().listConnections("testrg",
            "test-vpn-gateway-1", 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 virtual_network_gateways_list_connections.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.virtual_network_gateways.list_connections(
        resource_group_name="testrg",
        virtual_network_gateway_name="test-vpn-gateway-1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewaysListConnections.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/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewaysListConnections.json
func ExampleVirtualNetworkGatewaysClient_NewListConnectionsPager() {
	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.NewVirtualNetworkGatewaysClient().NewListConnectionsPager("testrg", "test-vpn-gateway-1", 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.VirtualNetworkGatewayListConnectionsResult = armnetwork.VirtualNetworkGatewayListConnectionsResult{
		// 	Value: []*armnetwork.VirtualNetworkGatewayConnectionListEntity{
		// 		{
		// 			Name: to.Ptr("test-vpn-connection"),
		// 			Type: to.Ptr("Microsoft.Network/connections"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/connections/test-vpn-connection"),
		// 			Location: to.Ptr("eastus"),
		// 			Etag: to.Ptr("W/\\\"00000000-0000-0000-0000-000000000000\\\""),
		// 			Properties: &armnetwork.VirtualNetworkGatewayConnectionListEntityPropertiesFormat{
		// 				ConnectionType: to.Ptr(armnetwork.VirtualNetworkGatewayConnectionTypeVnet2Vnet),
		// 				EgressBytesTransferred: to.Ptr[int64](0),
		// 				EnableBgp: to.Ptr(true),
		// 				IngressBytesTransferred: to.Ptr[int64](0),
		// 				IPSecPolicies: []*armnetwork.IPSecPolicy{
		// 				},
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				ResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				RoutingWeight: to.Ptr[int32](22),
		// 				TrafficSelectorPolicies: []*armnetwork.TrafficSelectorPolicy{
		// 				},
		// 				UsePolicyBasedTrafficSelectors: to.Ptr(false),
		// 				VirtualNetworkGateway1: &armnetwork.VirtualNetworkConnectionGatewayReference{
		// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkGateways/test-vpn-gateway-1"),
		// 				},
		// 				VirtualNetworkGateway2: &armnetwork.VirtualNetworkConnectionGatewayReference{
		// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/testrg-2/providers/Microsoft.Network/virtualNetworkGateways/test-vpn-gateway-2"),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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 Gets all the connections in a virtual network gateway.
 *
 * @summary Gets all the connections in a virtual network gateway.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewaysListConnections.json
 */
async function virtualNetworkGatewaysListConnections() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "testrg";
  const virtualNetworkGatewayName = "test-vpn-gateway-1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.virtualNetworkGateways.listConnections(
    resourceGroupName,
    virtualNetworkGatewayName,
  )) {
    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

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewaysListConnections.json
// this example is just showing the usage of "VirtualNetworkGateways_ListConnections" 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 VirtualNetworkGatewayResource created on azure
// for more information of creating VirtualNetworkGatewayResource, please refer to the document of VirtualNetworkGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "testrg";
string virtualNetworkGatewayName = "test-vpn-gateway-1";
ResourceIdentifier virtualNetworkGatewayResourceId = VirtualNetworkGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualNetworkGatewayName);
VirtualNetworkGatewayResource virtualNetworkGateway = client.GetVirtualNetworkGatewayResource(virtualNetworkGatewayResourceId);

// invoke the operation and iterate over the result
await foreach (VirtualNetworkGatewayConnectionListEntity item in virtualNetworkGateway.GetConnectionsAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "name": "test-vpn-connection",
      "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/connections/test-vpn-connection",
      "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"",
      "type": "Microsoft.Network/connections",
      "location": "eastus",
      "properties": {
        "provisioningState": "Succeeded",
        "resourceGuid": "00000000-0000-0000-0000-000000000000",
        "virtualNetworkGateway1": {
          "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkGateways/test-vpn-gateway-1"
        },
        "virtualNetworkGateway2": {
          "id": "/subscriptions/subid/resourceGroups/testrg-2/providers/Microsoft.Network/virtualNetworkGateways/test-vpn-gateway-2"
        },
        "connectionType": "Vnet2Vnet",
        "routingWeight": 22,
        "enableBgp": true,
        "usePolicyBasedTrafficSelectors": false,
        "ipsecPolicies": [],
        "trafficSelectorPolicies": [],
        "ingressBytesTransferred": 0,
        "egressBytesTransferred": 0
      }
    }
  ]
}

定義

名稱	Description
CloudError	來自服務的錯誤回應。
CloudErrorBody	來自服務的錯誤回應。
DhGroup	IKE 階段 1 中用於初始 SA 的 DH 群組。
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration 用於虛擬網路網關聯機。
IkeEncryption	IKE 加密演算法 (IKE 階段 2) 。
IkeIntegrity	IKE 完整性演算法 (IKE 階段 2) 。
IpsecEncryption	IPSec 加密演算法 (IKE 階段 1) 。
IpsecIntegrity	IPSec 完整性演算法 (IKE 階段 1) 。
IpsecPolicy	虛擬網路網關聯機的IPSec原則設定。
PfsGroup	IKE 階段 2 中用於新子 SA 的 Pfs 群組。
ProvisioningState	目前的布建狀態。
SubResource	另一個子資源的參考。
TrafficSelectorPolicy	虛擬網路網關聯機的流量選取器原則。
TunnelConnectionHealth	VirtualNetworkGatewayConnection 属性。
VirtualNetworkConnectionGatewayReference	VirtualNetworkGateway 或 LocalNetworkGateway 資源的參考。
VirtualNetworkGatewayConnectionListEntity	一般資源資訊的通用類別。
VirtualNetworkGatewayConnectionMode	網關聯機類型。
VirtualNetworkGatewayConnectionProtocol	用於此連線的連線通訊協定。
VirtualNetworkGatewayConnectionStatus	虛擬網路網關聯機狀態。
VirtualNetworkGatewayConnectionType	網關聯機類型。
VirtualNetworkGatewayListConnectionsResult	VirtualNetworkGatewayListConnections API 服務呼叫的回應。

CloudError

來自服務的錯誤回應。

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

CloudErrorBody

來自服務的錯誤回應。

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

DhGroup

IKE 階段 1 中用於初始 SA 的 DH 群組。

名稱	類型	Description
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration 用於虛擬網路網關聯機。

名稱	類型	Description
customBgpIpAddress	string	屬於 IpconfigurationId 的自定義 BgpPeeringAddress。
ipConfigurationId	string	屬於閘道之 ipconfiguration 的 IpconfigurationId。

IkeEncryption

IKE 加密演算法 (IKE 階段 2) 。

名稱	類型	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

IKE 完整性演算法 (IKE 階段 2) 。

名稱	類型	Description
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IpsecEncryption

IPSec 加密演算法 (IKE 階段 1) 。

名稱	類型	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

IPSec 完整性演算法 (IKE 階段 1) 。

名稱	類型	Description
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

虛擬網路網關聯機的IPSec原則設定。

名稱	類型	Description
dhGroup	DhGroup	IKE 階段 1 中用於初始 SA 的 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	IPSec 安全性關聯 (也稱為快速模式或階段 2 SA) KB 的承載大小，供站對站 VPN 通道使用。
saLifeTimeSeconds	integer	IPSec 安全性關聯 (也稱為快速模式或階段 2 SA) 存留期，以秒為單位，讓站對站 VPN 通道。

PfsGroup

IKE 階段 2 中用於新子 SA 的 Pfs 群組。

名稱	類型	Description
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

ProvisioningState

目前的布建狀態。

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

SubResource

另一個子資源的參考。

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

TrafficSelectorPolicy

虛擬網路網關聯機的流量選取器原則。

名稱	類型	Description
localAddressRanges	string[]	CIDR 格式的本機位址空間集合。
remoteAddressRanges	string[]	CIDR 格式的遠端位址空間集合。

TunnelConnectionHealth

VirtualNetworkGatewayConnection 属性。

名稱	類型	Description
connectionStatus	VirtualNetworkGatewayConnectionStatus	虛擬網路網關聯機狀態。
egressBytesTransferred	integer	在此連線中傳輸的輸出位元組。
ingressBytesTransferred	integer	在此連線中傳輸的輸入位元組。
lastConnectionEstablishedUtcTime	string	以Utc格式建立連線的時間。
tunnel	string	通道名稱。

VirtualNetworkConnectionGatewayReference

VirtualNetworkGateway 或 LocalNetworkGateway 資源的參考。

名稱	類型	Description
id	string	VirtualNetworkGateway 或 LocalNetworkGateway 資源的標識符。

VirtualNetworkGatewayConnectionListEntity

一般資源資訊的通用類別。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
location	string	資源位置。
name	string	資源名稱。
properties.authorizationKey	string	authorizationKey。
properties.connectionMode	VirtualNetworkGatewayConnectionMode	此連線連接模式。
properties.connectionProtocol	VirtualNetworkGatewayConnectionProtocol	用於此連線的連線通訊協定。
properties.connectionStatus	VirtualNetworkGatewayConnectionStatus	虛擬網路網關聯機狀態。
properties.connectionType	VirtualNetworkGatewayConnectionType	網關聯機類型。
properties.egressBytesTransferred	integer	在此連線中傳輸的輸出位元組。
properties.enableBgp	boolean	EnableBgp 旗標。
properties.enablePrivateLinkFastPath	boolean	存取私人連結時略過 ExpressRoute 閘道。必須啟用 ExpressRoute FastPath (expressRouteGatewayBypass) 。
properties.expressRouteGatewayBypass	boolean	略過 ExpressRoute 閘道進行數據轉送。
properties.gatewayCustomBgpIpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	GatewayCustomBgpIpAddresses 用於虛擬網路網關聯機。
properties.ingressBytesTransferred	integer	在此連線中傳輸的輸入位元組。
properties.ipsecPolicies	IpsecPolicy[]	此連線要考慮的IPSec原則。
properties.localNetworkGateway2	VirtualNetworkConnectionGatewayReference	局域網路網關資源的參考。
properties.peer	SubResource	對等互連資源的參考。
properties.provisioningState	ProvisioningState	虛擬網路網關聯機資源的布建狀態。
properties.resourceGuid	string	虛擬網路網關聯機資源的資源 GUID 屬性。
properties.routingWeight	integer	路由權數。
properties.sharedKey	string	IPSec 共用金鑰。
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	此連線要考慮的流量選取器原則。
properties.tunnelConnectionStatus	TunnelConnectionHealth[]	所有通道聯機健康狀態的集合。
properties.usePolicyBasedTrafficSelectors	boolean	啟用以原則為基礎的流量選取器。
properties.virtualNetworkGateway1	VirtualNetworkConnectionGatewayReference	虛擬網路閘道資源的參考。
properties.virtualNetworkGateway2	VirtualNetworkConnectionGatewayReference	虛擬網路閘道資源的參考。
tags	object	資源標籤。
type	string	資源類型。

VirtualNetworkGatewayConnectionMode

網關聯機類型。

名稱	類型	Description
Default	string
InitiatorOnly	string
ResponderOnly	string

VirtualNetworkGatewayConnectionProtocol

用於此連線的連線通訊協定。

名稱	類型	Description
IKEv1	string
IKEv2	string

VirtualNetworkGatewayConnectionStatus

虛擬網路網關聯機狀態。

名稱	類型	Description
Connected	string
Connecting	string
NotConnected	string
Unknown	string

VirtualNetworkGatewayConnectionType

網關聯機類型。

名稱	類型	Description
ExpressRoute	string
IPsec	string
VPNClient	string
Vnet2Vnet	string

VirtualNetworkGatewayListConnectionsResult

VirtualNetworkGatewayListConnections API 服務呼叫的回應。

名稱	類型	Description
nextLink	string	要取得下一組結果的URL。
value	VirtualNetworkGatewayConnectionListEntity[]	存在於資源群組中的 VirtualNetworkGatewayConnection 資源清單。