Virtual Network Gateways - List Connections

服务:

Network Gateway

API 版本:

2024-05-01

获取虚拟网络网关中的所有连接。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。
subscriptionId	path	True	string	唯一标识 Azure 订阅Microsoft的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。
virtualNetworkGatewayName	path	True	string	虚拟网络网关的名称。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	VirtualNetworkGatewayListConnectionsResult	请求成功。 该操作返回 VirtualNetworkGatewayConnection 资源的列表。
Other Status Codes	CloudError	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

VirtualNetworkGatewaysListConnections

示例请求

HTTP

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

Java

/**
 * Samples for VirtualNetworkGateways ListConnections.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-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

Python

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/2024-05-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

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/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

JavaScript

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/2024-05-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

dotnet

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-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

示例响应

状态代码:

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
      }
    }
  ]
}

定义

名称	说明
CloudError	服务的错误响应。
CloudErrorBody	服务的错误响应。
DhGroup	IKE 阶段 1 中使用的 DH 组用于初始 SA。
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

Object

服务的错误响应。

名称	类型	说明
error	CloudErrorBody	云错误正文。

CloudErrorBody

Object

服务的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。 例如，错误属性的名称。

DhGroup

枚举

IKE 阶段 1 中使用的 DH 组用于初始 SA。

值	说明
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	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 中使用的 Pfs 组用于新的子 SA。
saDataSizeKilobytes	integer (int32)	IPSec 安全关联（也称为快速模式或阶段 2 SA）有效负载大小（以 KB 为单位），用于站点到站点 VPN 隧道。
saLifeTimeSeconds	integer (int32)	站点到站点 VPN 隧道的 IPSec 安全关联（也称为快速模式或阶段 2 SA）生存期（以秒为单位）。

PfsGroup

枚举

IKE 阶段 2 中用于新子 SA 的 Pfs 组。

值	说明
ECP256
ECP384
None
PFS1
PFS14
PFS2
PFS2048
PFS24
PFSMM

ProvisioningState

枚举

当前预配状态。

值	说明
Deleting
Failed
Succeeded
Updating

SubResource

Object

对另一个子资源的引用。

名称	类型	说明
id	string	资源 ID。

TrafficSelectorPolicy

Object

虚拟网络网关连接的流量选择器策略。

名称	类型	说明
localAddressRanges	string[]	CIDR 格式的本地地址空间的集合。
remoteAddressRanges	string[]	采用 CIDR 格式的远程地址空间集合。

TunnelConnectionHealth

Object

VirtualNetworkGatewayConnection 属性。

名称	类型	说明
connectionStatus	VirtualNetworkGatewayConnectionStatus	虚拟网络网关连接状态。
egressBytesTransferred	integer (int64)	在此连接中传输的出口字节数。
ingressBytesTransferred	integer (int64)	在此连接中传输的入口字节数。
lastConnectionEstablishedUtcTime	string	以 Utc 格式建立连接的时间。
tunnel	string	隧道名称。

VirtualNetworkConnectionGatewayReference

Object

对 VirtualNetworkGateway 或 LocalNetworkGateway 资源的引用。

名称	类型	说明
id	string	VirtualNetworkGateway 或 LocalNetworkGateway 资源的 ID。

VirtualNetworkGatewayConnectionListEntity

Object

常规资源信息的通用类。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.authorizationKey	string	authorizationKey。
properties.connectionMode	VirtualNetworkGatewayConnectionMode	此连接的连接模式。
properties.connectionProtocol	VirtualNetworkGatewayConnectionProtocol	用于此连接的连接协议。
properties.connectionStatus	VirtualNetworkGatewayConnectionStatus	虚拟网络网关连接状态。
properties.connectionType	VirtualNetworkGatewayConnectionType	网关连接类型。
properties.egressBytesTransferred	integer (int64)	在此连接中传输的出口字节数。
properties.enableBgp	boolean	EnableBgp 标志。
properties.enablePrivateLinkFastPath	boolean	访问专用链接时绕过 ExpressRoute 网关。 必须启用 ExpressRoute FastPath （expressRouteGatewayBypass）。
properties.expressRouteGatewayBypass	boolean	绕过 ExpressRoute 网关进行数据转发。
properties.gatewayCustomBgpIpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	用于虚拟网络网关连接的 GatewayCustomBgpIpAddresses。
properties.ingressBytesTransferred	integer (int64)	在此连接中传输的入口字节数。
properties.ipsecPolicies	IpsecPolicy[]	此连接要考虑的 IPSec 策略。
properties.localNetworkGateway2	VirtualNetworkConnectionGatewayReference	对本地网络网关资源的引用。
properties.peer	SubResource	对等互连资源的引用。
properties.provisioningState	ProvisioningState	虚拟网络网关连接资源的预配状态。
properties.resourceGuid	string	虚拟网络网关连接资源的资源 GUID 属性。
properties.routingWeight	integer (int32)	路由权重。
properties.sharedKey	string	IPSec 共享密钥。
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	此连接要考虑的流量选择器策略。
properties.tunnelConnectionStatus	TunnelConnectionHealth[]	所有隧道的连接运行状况的集合。
properties.usePolicyBasedTrafficSelectors	boolean	启用基于策略的流量选择器。
properties.virtualNetworkGateway1	VirtualNetworkConnectionGatewayReference	对虚拟网络网关资源的引用。
properties.virtualNetworkGateway2	VirtualNetworkConnectionGatewayReference	对虚拟网络网关资源的引用。
tags	object	资源标记。
type	string	资源类型。

VirtualNetworkGatewayConnectionMode

枚举

网关连接类型。

值	说明
Default
InitiatorOnly
ResponderOnly

VirtualNetworkGatewayConnectionProtocol

枚举

用于此连接的连接协议。

值	说明
IKEv1
IKEv2

VirtualNetworkGatewayConnectionStatus

枚举

虚拟网络网关连接状态。

值	说明
Connected
Connecting
NotConnected
Unknown

VirtualNetworkGatewayConnectionType

枚举

网关连接类型。

值	说明
ExpressRoute
IPsec
VPNClient
Vnet2Vnet

VirtualNetworkGatewayListConnectionsResult

Object

VirtualNetworkGatewayListConnections API 服务调用的响应。

名称	类型	说明
nextLink	string	用于获取下一组结果的 URL。
value	VirtualNetworkGatewayConnectionListEntity[]	资源组中存在的 VirtualNetworkGatewayConnection 资源的列表。