Virtual Network Gateways - List Connections

Service:

Network Gateway

API Version:

2023-09-01

Obtém todas as ligações num gateway de rede virtual.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	As credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
virtualNetworkGatewayName	path	True	string	O nome do gateway de rede virtual.
api-version	query	True	string	Versão da API de Cliente.

Respostas

Name	Tipo	Description
200 OK	VirtualNetworkGatewayListConnectionsResult	Pedido com êxito. A operação devolve uma lista do recurso VirtualNetworkGatewayConnection.
Other Status Codes	CloudError	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

VirtualNetworkGatewaysListConnections

Sample Request

HTTP

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

Java

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

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

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

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

dotnet

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

Definições

Name	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
DhGroup	Os Grupos DH utilizados na Fase 1 do IKE para SA inicial.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration para uma ligação de gateway de rede virtual.
IkeEncryption	O algoritmo de encriptação IKE (fase IKE 2).
IkeIntegrity	O algoritmo de integridade IKE (fase IKE 2).
IpsecEncryption	O algoritmo de encriptação IPSec (fase IKE 1).
IpsecIntegrity	O algoritmo de integridade IPSec (fase IKE 1).
IpsecPolicy	Uma configuração da Política IPSec para uma ligação de gateway de rede virtual.
PfsGroup	Os Grupos Pfs utilizados na Fase 2 do IKE para a nova SA subordinada.
ProvisioningState	O estado de aprovisionamento atual.
SubResource	Referência a outra sub-origem.
TrafficSelectorPolicy	Uma política de seletor de tráfego para uma ligação de gateway de rede virtual.
TunnelConnectionHealth	Propriedades virtualNetworkGatewayConnection.
VirtualNetworkConnectionGatewayReference	Uma referência ao recurso VirtualNetworkGateway ou LocalNetworkGateway.
VirtualNetworkGatewayConnectionListEntity	Uma classe comum para informações gerais de recursos.
VirtualNetworkGatewayConnectionMode	Tipo de ligação de gateway.
VirtualNetworkGatewayConnectionProtocol	Protocolo de ligação utilizado para esta ligação.
VirtualNetworkGatewayConnectionStatus	Rede Virtual estado da ligação do Gateway.
VirtualNetworkGatewayConnectionType	Tipo de ligação de gateway.
VirtualNetworkGatewayListConnectionsResult	Resposta para a chamada ao serviço da API VirtualNetworkGatewayListConnections.

CloudError

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Corpo do erro da cloud.

CloudErrorBody

Uma resposta de erro do serviço.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

DhGroup

Os Grupos DH utilizados na Fase 1 do IKE para SA inicial.

Name	Tipo	Description
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration para uma ligação de gateway de rede virtual.

Name	Tipo	Description
customBgpIpAddress	string	O BgpPeeringAddress personalizado que pertence a IpconfigurationId.
ipConfigurationId	string	O IpconfigurationId da ipconfiguration que pertence ao gateway.

IkeEncryption

O algoritmo de encriptação IKE (fase IKE 2).

Name	Tipo	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

O algoritmo de integridade IKE (fase IKE 2).

Name	Tipo	Description
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IpsecEncryption

O algoritmo de encriptação IPSec (fase IKE 1).

Name	Tipo	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

O algoritmo de integridade IPSec (fase IKE 1).

Name	Tipo	Description
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

Uma configuração da Política IPSec para uma ligação de gateway de rede virtual.

Name	Tipo	Description
dhGroup	DhGroup	O Grupo DH utilizado na Fase 1 do IKE para SA inicial.
ikeEncryption	IkeEncryption	O algoritmo de encriptação IKE (fase IKE 2).
ikeIntegrity	IkeIntegrity	O algoritmo de integridade IKE (fase IKE 2).
ipsecEncryption	IpsecEncryption	O algoritmo de encriptação IPSec (fase IKE 1).
ipsecIntegrity	IpsecIntegrity	O algoritmo de integridade IPSec (fase IKE 1).
pfsGroup	PfsGroup	O Grupo Pfs utilizado na Fase 2 do IKE para a nova SA subordinada.
saDataSizeKilobytes	integer	O tamanho de payload da Associação de Segurança IPSec (também denominado Modo Rápido ou Fase 2 SA) em KB para um túnel de VPN site a site.
saLifeTimeSeconds	integer	A Duração da Associação de Segurança IPSec (também denominada Modo Rápido ou Fase 2 SA) em segundos para um túnel de VPN site a site.

PfsGroup

Os Grupos Pfs utilizados na Fase 2 do IKE para a nova SA subordinada.

Name	Tipo	Description
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

ProvisioningState

O estado de aprovisionamento atual.

Name	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Referência a outra sub-origem.

Name	Tipo	Description
id	string	ID do Recurso.

TrafficSelectorPolicy

Uma política de seletor de tráfego para uma ligação de gateway de rede virtual.

Name	Tipo	Description
localAddressRanges	string[]	Uma coleção de espaços de endereços locais no formato CIDR.
remoteAddressRanges	string[]	Uma coleção de espaços de endereços remotos no formato CIDR.

TunnelConnectionHealth

Propriedades virtualNetworkGatewayConnection.

Name	Tipo	Description
connectionStatus	VirtualNetworkGatewayConnectionStatus	Rede Virtual estado da ligação do Gateway.
egressBytesTransferred	integer	Os Bytes de Saída Transferidos nesta ligação.
ingressBytesTransferred	integer	Os Bytes de Entrada Transferidos nesta ligação.
lastConnectionEstablishedUtcTime	string	O momento em que a ligação foi estabelecida no formato Utc.
tunnel	string	Nome do túnel.

VirtualNetworkConnectionGatewayReference

Uma referência ao recurso VirtualNetworkGateway ou LocalNetworkGateway.

Name	Tipo	Description
id	string	O ID do recurso VirtualNetworkGateway ou LocalNetworkGateway.

VirtualNetworkGatewayConnectionListEntity

Uma classe comum para informações gerais de recursos.

Name	Tipo	Description
etag	string	Uma cadeia exclusiva só de leitura que é alterada sempre que o recurso é atualizado.
id	string	ID do Recurso.
location	string	Localização do recurso.
name	string	Nome do recurso.
properties.authorizationKey	string	A authorizationKey.
properties.connectionMode	VirtualNetworkGatewayConnectionMode	O modo de ligação para esta ligação.
properties.connectionProtocol	VirtualNetworkGatewayConnectionProtocol	Protocolo de ligação utilizado para esta ligação.
properties.connectionStatus	VirtualNetworkGatewayConnectionStatus	Rede Virtual estado da ligação do Gateway.
properties.connectionType	VirtualNetworkGatewayConnectionType	Tipo de ligação de gateway.
properties.egressBytesTransferred	integer	Os bytes de saída transferidos nesta ligação.
properties.enableBgp	boolean	Sinalizador EnableBgp.
properties.enablePrivateLinkFastPath	boolean	Ignore o gateway do ExpressRoute ao aceder a ligações privadas. O ExpressRoute FastPath (expressRouteGatewayBypass) tem de estar ativado.
properties.expressRouteGatewayBypass	boolean	Ignore o Gateway do ExpressRoute para reencaminhamento de dados.
properties.gatewayCustomBgpIpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	GatewayCustomBgpIpAddresses a utilizar para a Ligação do gateway de rede virtual.
properties.ingressBytesTransferred	integer	Os bytes de entrada transferidos nesta ligação.
properties.ipsecPolicies	IpsecPolicy[]	As Políticas IPSec a considerar por esta ligação.
properties.localNetworkGateway2	VirtualNetworkConnectionGatewayReference	A referência ao recurso de gateway de rede local.
properties.peer	SubResource	A referência ao recurso peerings.
properties.provisioningState	ProvisioningState	O estado de aprovisionamento do recurso de ligação do gateway de rede virtual.
properties.resourceGuid	string	A propriedade GUID do recurso do recurso de ligação do gateway de rede virtual.
properties.routingWeight	integer	O peso do encaminhamento.
properties.sharedKey	string	A chave partilhada IPSec.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	As Políticas do Seletor de Tráfego a considerar por esta ligação.
properties.tunnelConnectionStatus	TunnelConnectionHealth[]	Recolha do estado de funcionamento da ligação de todos os túneis.
properties.usePolicyBasedTrafficSelectors	boolean	Ativar seletores de tráfego baseados em políticas.
properties.virtualNetworkGateway1	VirtualNetworkConnectionGatewayReference	A referência ao recurso de gateway de rede virtual.
properties.virtualNetworkGateway2	VirtualNetworkConnectionGatewayReference	A referência ao recurso de gateway de rede virtual.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

VirtualNetworkGatewayConnectionMode

Tipo de ligação de gateway.

Name	Tipo	Description
Default	string
InitiatorOnly	string
ResponderOnly	string

VirtualNetworkGatewayConnectionProtocol

Protocolo de ligação utilizado para esta ligação.

Name	Tipo	Description
IKEv1	string
IKEv2	string

VirtualNetworkGatewayConnectionStatus

Rede Virtual estado da ligação do Gateway.

Name	Tipo	Description
Connected	string
Connecting	string
NotConnected	string
Unknown	string

VirtualNetworkGatewayConnectionType

Tipo de ligação de gateway.

Name	Tipo	Description
ExpressRoute	string
IPsec	string
VPNClient	string
Vnet2Vnet	string

VirtualNetworkGatewayListConnectionsResult

Resposta para a chamada ao serviço da API VirtualNetworkGatewayListConnections.

Name	Tipo	Description
nextLink	string	O URL para obter o próximo conjunto de resultados.
value	VirtualNetworkGatewayConnectionListEntity[]	Uma lista de recursos VirtualNetworkGatewayConnection que existem num grupo de recursos.