Virtual Network Gateways - List Connections

Service:

Network Gateway

API Version:

2024-05-01

Gets all the connections in a virtual network gateway.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
virtualNetworkGatewayName	path	True	string	The name of the virtual network gateway.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	VirtualNetworkGatewayListConnectionsResult	Request successful. The operation returns a list of VirtualNetworkGatewayConnection resource.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

VirtualNetworkGatewaysListConnections

Sample request

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

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

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
DhGroup	The DH Groups used in IKE Phase 1 for initial SA.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration for a virtual network gateway connection.
IkeEncryption	The IKE encryption algorithm (IKE phase 2).
IkeIntegrity	The IKE integrity algorithm (IKE phase 2).
IpsecEncryption	The IPSec encryption algorithm (IKE phase 1).
IpsecIntegrity	The IPSec integrity algorithm (IKE phase 1).
IpsecPolicy	An IPSec Policy configuration for a virtual network gateway connection.
PfsGroup	The Pfs Groups used in IKE Phase 2 for new child SA.
ProvisioningState	The current provisioning state.
SubResource	Reference to another subresource.
TrafficSelectorPolicy	An traffic selector policy for a virtual network gateway connection.
TunnelConnectionHealth	VirtualNetworkGatewayConnection properties.
VirtualNetworkConnectionGatewayReference	A reference to VirtualNetworkGateway or LocalNetworkGateway resource.
VirtualNetworkGatewayConnectionListEntity	A common class for general resource information.
VirtualNetworkGatewayConnectionMode	Gateway connection type.
VirtualNetworkGatewayConnectionProtocol	Connection protocol used for this connection.
VirtualNetworkGatewayConnectionStatus	Virtual Network Gateway connection status.
VirtualNetworkGatewayConnectionType	Gateway connection type.
VirtualNetworkGatewayListConnectionsResult	Response for the VirtualNetworkGatewayListConnections API service call.

CloudError

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

Object

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

DhGroup

Enumeration

The DH Groups used in IKE Phase 1 for initial SA.

Value	Description
DHGroup1
DHGroup14
DHGroup2
DHGroup2048
DHGroup24
ECP256
ECP384
None

GatewayCustomBgpIpAddressIpConfiguration

Object

GatewayCustomBgpIpAddressIpConfiguration for a virtual network gateway connection.

Name	Type	Description
customBgpIpAddress	string	The custom BgpPeeringAddress which belongs to IpconfigurationId.
ipConfigurationId	string	The IpconfigurationId of ipconfiguration which belongs to gateway.

IkeEncryption

Enumeration

The IKE encryption algorithm (IKE phase 2).

Value	Description
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES256

IkeIntegrity

Enumeration

The IKE integrity algorithm (IKE phase 2).

Value	Description
GCMAES128
GCMAES256
MD5
SHA1
SHA256
SHA384

IpsecEncryption

Enumeration

The IPSec encryption algorithm (IKE phase 1).

Value	Description
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES192
GCMAES256
None

IpsecIntegrity

Enumeration

The IPSec integrity algorithm (IKE phase 1).

Value	Description
GCMAES128
GCMAES192
GCMAES256
MD5
SHA1
SHA256

IpsecPolicy

Object

An IPSec Policy configuration for a virtual network gateway connection.

Name	Type	Description
dhGroup	DhGroup	The DH Group used in IKE Phase 1 for initial SA.
ikeEncryption	IkeEncryption	The IKE encryption algorithm (IKE phase 2).
ikeIntegrity	IkeIntegrity	The IKE integrity algorithm (IKE phase 2).
ipsecEncryption	IpsecEncryption	The IPSec encryption algorithm (IKE phase 1).
ipsecIntegrity	IpsecIntegrity	The IPSec integrity algorithm (IKE phase 1).
pfsGroup	PfsGroup	The Pfs Group used in IKE Phase 2 for new child SA.
saDataSizeKilobytes	integer (int32)	The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
saLifeTimeSeconds	integer (int32)	The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.

PfsGroup

Enumeration

The Pfs Groups used in IKE Phase 2 for new child SA.

Value	Description
ECP256
ECP384
None
PFS1
PFS14
PFS2
PFS2048
PFS24
PFSMM

ProvisioningState

Enumeration

The current provisioning state.

Value	Description
Deleting
Failed
Succeeded
Updating

SubResource

Object

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.

TrafficSelectorPolicy

Object

An traffic selector policy for a virtual network gateway connection.

Name	Type	Description
localAddressRanges	string[]	A collection of local address spaces in CIDR format.
remoteAddressRanges	string[]	A collection of remote address spaces in CIDR format.

TunnelConnectionHealth

Object

VirtualNetworkGatewayConnection properties.

Name	Type	Description
connectionStatus	VirtualNetworkGatewayConnectionStatus	Virtual Network Gateway connection status.
egressBytesTransferred	integer (int64)	The Egress Bytes Transferred in this connection.
ingressBytesTransferred	integer (int64)	The Ingress Bytes Transferred in this connection.
lastConnectionEstablishedUtcTime	string	The time at which connection was established in Utc format.
tunnel	string	Tunnel name.

VirtualNetworkConnectionGatewayReference

Object

A reference to VirtualNetworkGateway or LocalNetworkGateway resource.

Name	Type	Description
id	string	The ID of VirtualNetworkGateway or LocalNetworkGateway resource.

VirtualNetworkGatewayConnectionListEntity

Object

A common class for general resource information.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.authorizationKey	string	The authorizationKey.
properties.connectionMode	VirtualNetworkGatewayConnectionMode	The connection mode for this connection.
properties.connectionProtocol	VirtualNetworkGatewayConnectionProtocol	Connection protocol used for this connection.
properties.connectionStatus	VirtualNetworkGatewayConnectionStatus	Virtual Network Gateway connection status.
properties.connectionType	VirtualNetworkGatewayConnectionType	Gateway connection type.
properties.egressBytesTransferred	integer (int64)	The egress bytes transferred in this connection.
properties.enableBgp	boolean	EnableBgp flag.
properties.enablePrivateLinkFastPath	boolean	Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
properties.expressRouteGatewayBypass	boolean	Bypass ExpressRoute Gateway for data forwarding.
properties.gatewayCustomBgpIpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.
properties.ingressBytesTransferred	integer (int64)	The ingress bytes transferred in this connection.
properties.ipsecPolicies	IpsecPolicy[]	The IPSec Policies to be considered by this connection.
properties.localNetworkGateway2	VirtualNetworkConnectionGatewayReference	The reference to local network gateway resource.
properties.peer	SubResource	The reference to peerings resource.
properties.provisioningState	ProvisioningState	The provisioning state of the virtual network gateway connection resource.
properties.resourceGuid	string	The resource GUID property of the virtual network gateway connection resource.
properties.routingWeight	integer (int32)	The routing weight.
properties.sharedKey	string	The IPSec shared key.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	The Traffic Selector Policies to be considered by this connection.
properties.tunnelConnectionStatus	TunnelConnectionHealth[]	Collection of all tunnels' connection health status.
properties.usePolicyBasedTrafficSelectors	boolean	Enable policy-based traffic selectors.
properties.virtualNetworkGateway1	VirtualNetworkConnectionGatewayReference	The reference to virtual network gateway resource.
properties.virtualNetworkGateway2	VirtualNetworkConnectionGatewayReference	The reference to virtual network gateway resource.
tags	object	Resource tags.
type	string	Resource type.

VirtualNetworkGatewayConnectionMode

Enumeration

Gateway connection type.

Value	Description
Default
InitiatorOnly
ResponderOnly

VirtualNetworkGatewayConnectionProtocol

Enumeration

Connection protocol used for this connection.

Value	Description
IKEv1
IKEv2

VirtualNetworkGatewayConnectionStatus

Enumeration

Virtual Network Gateway connection status.

Value	Description
Connected
Connecting
NotConnected
Unknown

VirtualNetworkGatewayConnectionType

Enumeration

Gateway connection type.

Value	Description
ExpressRoute
IPsec
VPNClient
Vnet2Vnet

VirtualNetworkGatewayListConnectionsResult

Object

Response for the VirtualNetworkGatewayListConnections API service call.

Name	Type	Description
nextLink	string	The URL to get the next set of results.
value	VirtualNetworkGatewayConnectionListEntity[]	A list of VirtualNetworkGatewayConnection resources that exists in a resource group.