Virtual Network Gateways - List Connections

Referenz

Dienst:: Network Gateway

API-Version:: 2023-11-01

Ruft alle Verbindungen in einem virtuellen Netzwerkgateway ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
virtualNetworkGatewayName	path	True	string	Der Name des virtuellen Netzwerkgateways.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	VirtualNetworkGatewayListConnectionsResult	Anforderung erfolgreich. Der Vorgang gibt eine Liste der VirtualNetworkGatewayConnection-Ressource zurück.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

VirtualNetworkGatewaysListConnections

Beispielanforderung

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


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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Diensts.
CloudErrorBody	Eine Fehlerantwort des Diensts.
DhGroup	Die DH-Gruppen, die in IKE Phase 1 für die erste SA verwendet werden.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration für eine Verbindung mit einem virtuellen Netzwerkgateway.
IkeEncryption	Der IKE-Verschlüsselungsalgorithmus (IKE Phase 2).
IkeIntegrity	Der IKE-Integritätsalgorithmus (IKE Phase 2).
IpsecEncryption	Der IPSec-Verschlüsselungsalgorithmus (IKE Phase 1).
IpsecIntegrity	Der IPSec-Integritätsalgorithmus (IKE Phase 1).
IpsecPolicy	Eine IPSec-Richtlinienkonfiguration für eine Verbindung mit einem virtuellen Netzwerkgateway.
PfsGroup	Die pfs Groups, die in IKE Phase 2 für neue untergeordnete SA verwendet werden.
ProvisioningState	Der aktuelle Bereitstellungsstatus.
SubResource	Verweisen auf eine andere Unterressource.
TrafficSelectorPolicy	Eine Datenverkehrsauswahlrichtlinie für eine Verbindung mit einem virtuellen Netzwerkgateway.
TunnelConnectionHealth	VirtualNetworkGatewayConnection-Eigenschaften.
VirtualNetworkConnectionGatewayReference	Ein Verweis auf die VirtualNetworkGateway- oder LocalNetworkGateway-Ressource.
VirtualNetworkGatewayConnectionListEntity	Eine allgemeine Klasse für allgemeine Ressourceninformationen.
VirtualNetworkGatewayConnectionMode	Gatewayverbindungstyp.
VirtualNetworkGatewayConnectionProtocol	Verbindungsprotokoll, das für diese Verbindung verwendet wird.
VirtualNetworkGatewayConnectionStatus	Verbindungsstatus des virtuellen Netzwerkgateways.
VirtualNetworkGatewayConnectionType	Gatewayverbindungstyp.
VirtualNetworkGatewayListConnectionsResult	Antwort für den VirtualNetworkGatewayListConnections-API-Dienstaufruf.

CloudError

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Cloudfehlertext.

CloudErrorBody

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

DhGroup

Die DH-Gruppen, die in IKE Phase 1 für die erste SA verwendet werden.

Name	Typ	Beschreibung
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration für eine Verbindung mit einem virtuellen Netzwerkgateway.

Name	Typ	Beschreibung
customBgpIpAddress	string	Die benutzerdefinierte BgpPeeringAddress, die zu IpconfigurationId gehört.
ipConfigurationId	string	Die IpconfigurationId der ipconfiguration, die zum Gateway gehört.

IkeEncryption

Der IKE-Verschlüsselungsalgorithmus (IKE Phase 2).

Name	Typ	Beschreibung
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

Der IKE-Integritätsalgorithmus (IKE Phase 2).

Name	Typ	Beschreibung
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IpsecEncryption

Der IPSec-Verschlüsselungsalgorithmus (IKE Phase 1).

Name	Typ	Beschreibung
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

Der IPSec-Integritätsalgorithmus (IKE Phase 1).

Name	Typ	Beschreibung
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

Eine IPSec-Richtlinienkonfiguration für eine Verbindung mit einem virtuellen Netzwerkgateway.

Name	Typ	Beschreibung
dhGroup	DhGroup	Die DH Group wurde in IKE Phase 1 für die erste SA verwendet.
ikeEncryption	IkeEncryption	Der IKE-Verschlüsselungsalgorithmus (IKE Phase 2).
ikeIntegrity	IkeIntegrity	Der IKE-Integritätsalgorithmus (IKE Phase 2).
ipsecEncryption	IpsecEncryption	Der IPSec-Verschlüsselungsalgorithmus (IKE Phase 1).
ipsecIntegrity	IpsecIntegrity	Der IPSec-Integritätsalgorithmus (IKE Phase 1).
pfsGroup	PfsGroup	Die Pfs Group, die in IKE Phase 2 für neue untergeordnete SA verwendet wird.
saDataSizeKilobytes	integer	Die Nutzlastgröße der IPSec-Sicherheitszuordnung (auch als Schnellmodus oder Phase 2 SA bezeichnet) in KB für einen Standort-zu-Standort-VPN-Tunnel.
saLifeTimeSeconds	integer	Die IPSec Security Association (auch als Schnellmodus oder Phase 2 SA bezeichnet) Lebensdauer in Sekunden für einen Standort-zu-Standort-VPN-Tunnel.

PfsGroup

Die pfs Groups, die in IKE Phase 2 für neue untergeordnete SA verwendet werden.

Name	Typ	Beschreibung
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

ProvisioningState

Der aktuelle Bereitstellungsstatus.

Name	Typ	Beschreibung
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Verweisen auf eine andere Unterressource.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.

TrafficSelectorPolicy

Eine Datenverkehrsauswahlrichtlinie für eine Verbindung mit einem virtuellen Netzwerkgateway.

Name	Typ	Beschreibung
localAddressRanges	string[]	Eine Sammlung lokaler Adressräume im CIDR-Format.
remoteAddressRanges	string[]	Eine Sammlung von Remoteadressräumen im CIDR-Format.

TunnelConnectionHealth

VirtualNetworkGatewayConnection-Eigenschaften.

Name	Typ	Beschreibung
connectionStatus	VirtualNetworkGatewayConnectionStatus	Verbindungsstatus des virtuellen Netzwerkgateways.
egressBytesTransferred	integer	Die in dieser Verbindung übertragenen Eingangsbytes.
ingressBytesTransferred	integer	Die in dieser Verbindung übertragenen Eingangsbytes.
lastConnectionEstablishedUtcTime	string	Die Uhrzeit, zu der die Verbindung im Utc-Format hergestellt wurde.
tunnel	string	Tunnelname.

VirtualNetworkConnectionGatewayReference

Ein Verweis auf die VirtualNetworkGateway- oder LocalNetworkGateway-Ressource.

Name	Typ	Beschreibung
id	string	Die ID der VirtualNetworkGateway- oder LocalNetworkGateway-Ressource.

VirtualNetworkGatewayConnectionListEntity

Eine allgemeine Klasse für allgemeine Ressourceninformationen.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
properties.authorizationKey	string	Der AuthorizationKey.
properties.connectionMode	VirtualNetworkGatewayConnectionMode	Der Verbindungsmodus für diese Verbindung.
properties.connectionProtocol	VirtualNetworkGatewayConnectionProtocol	Verbindungsprotokoll, das für diese Verbindung verwendet wird.
properties.connectionStatus	VirtualNetworkGatewayConnectionStatus	Verbindungsstatus des virtuellen Netzwerkgateways.
properties.connectionType	VirtualNetworkGatewayConnectionType	Gatewayverbindungstyp.
properties.egressBytesTransferred	integer	Die in dieser Verbindung übertragenen Eingangsbytes.
properties.enableBgp	boolean	EnableBgp-Flag.
properties.enablePrivateLinkFastPath	boolean	Umgehen Sie das ExpressRoute-Gateway beim Zugriff auf private Links. ExpressRoute FastPath (expressRouteGatewayBypass) muss aktiviert sein.
properties.expressRouteGatewayBypass	boolean	Umgehen Des ExpressRoute-Gateways für die Datenweiterleitung.
properties.gatewayCustomBgpIpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	GatewayCustomBgpIpAddresses, die für die Verbindung des virtuellen Netzwerkgateways verwendet werden sollen.
properties.ingressBytesTransferred	integer	Die in dieser Verbindung übertragenen Eingangsbytes.
properties.ipsecPolicies	IpsecPolicy[]	Die IPSec-Richtlinien, die von dieser Verbindung berücksichtigt werden sollen.
properties.localNetworkGateway2	VirtualNetworkConnectionGatewayReference	Der Verweis auf die Ressource des lokalen Netzwerkgateways.
properties.peer	SubResource	Der Verweis auf peerings-Ressource.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der Verbindungsressource des virtuellen Netzwerkgateways.
properties.resourceGuid	string	Die GUID-Eigenschaft der Ressourcen-GUID der Verbindungsressource des virtuellen Netzwerks.
properties.routingWeight	integer	Die Gewichtung des Routings.
properties.sharedKey	string	Der freigegebene IPSec-Schlüssel.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	Die Datenverkehrsauswahlrichtlinien, die von dieser Verbindung berücksichtigt werden sollen.
properties.tunnelConnectionStatus	TunnelConnectionHealth[]	Sammlung des Verbindungsstatus aller Tunnel.
properties.usePolicyBasedTrafficSelectors	boolean	Aktivieren Sie richtlinienbasierte Datenverkehrsmarkierer.
properties.virtualNetworkGateway1	VirtualNetworkConnectionGatewayReference	Der Verweis auf die Ressource des virtuellen Netzwerkgateways.
properties.virtualNetworkGateway2	VirtualNetworkConnectionGatewayReference	Der Verweis auf die Ressource des virtuellen Netzwerkgateways.
tags	object	Ressourcentags.
type	string	Ressourcentyp.

VirtualNetworkGatewayConnectionMode

Gatewayverbindungstyp.

Name	Typ	Beschreibung
Default	string
InitiatorOnly	string
ResponderOnly	string

VirtualNetworkGatewayConnectionProtocol

Verbindungsprotokoll, das für diese Verbindung verwendet wird.

Name	Typ	Beschreibung
IKEv1	string
IKEv2	string

VirtualNetworkGatewayConnectionStatus

Verbindungsstatus des virtuellen Netzwerkgateways.

Name	Typ	Beschreibung
Connected	string
Connecting	string
NotConnected	string
Unknown	string

VirtualNetworkGatewayConnectionType

Gatewayverbindungstyp.

Name	Typ	Beschreibung
ExpressRoute	string
IPsec	string
VPNClient	string
Vnet2Vnet	string

VirtualNetworkGatewayListConnectionsResult

Antwort für den VirtualNetworkGatewayListConnections-API-Dienstaufruf.

Name	Typ	Beschreibung
nextLink	string	Die URL, um den nächsten Satz von Ergebnissen abzurufen.
value	VirtualNetworkGatewayConnectionListEntity[]	Eine Liste der VirtualNetworkGatewayConnection-Ressourcen, die in einer Ressourcengruppe vorhanden sind.

Freigeben über

Virtual Network Gateways - List Connections

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

VirtualNetworkGatewaysListConnections

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CloudError

CloudErrorBody

DhGroup

GatewayCustomBgpIpAddressIpConfiguration

IkeEncryption

IkeIntegrity

IpsecEncryption

IpsecIntegrity

IpsecPolicy

PfsGroup

ProvisioningState

SubResource

TrafficSelectorPolicy

TunnelConnectionHealth

VirtualNetworkConnectionGatewayReference

VirtualNetworkGatewayConnectionListEntity

VirtualNetworkGatewayConnectionMode

VirtualNetworkGatewayConnectionProtocol

VirtualNetworkGatewayConnectionStatus

VirtualNetworkGatewayConnectionType

VirtualNetworkGatewayListConnectionsResult

Zusätzliche Ressourcen