Freigeben über


Vpn Connections - List By Vpn Gateway

Ruft alle VPN-Verbindungen für ein bestimmtes virtuelles WAN-VPN-Gateway ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
gatewayName
path True

string

Der Name des Gateways.

resourceGroupName
path True

string

Der Ressourcengruppenname des VpnGateway.

subscriptionId
path True

string

Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True

string

Client-API-Version.

Antworten

Name Typ Beschreibung
200 OK

ListVpnConnectionsResult

Anforderung erfolgreich. Gibt alle VPN-Verbindungen für ein virtuelles WAN-VPN-Gateway 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

VpnConnectionList

Beispielanforderung

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections?api-version=2024-05-01

Beispiel für eine Antwort

[
  {
    "name": "vpnConnection1",
    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
    "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
    "properties": {
      "provisioningState": "Succeeded",
      "remoteVpnSite": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
      },
      "enableInternetSecurity": false,
      "ingressBytesTransferred": 0,
      "egressBytesTransferred": 0,
      "trafficSelectorPolicies": [],
      "vpnLinkConnections": [
        {
          "name": "Connection-Link1",
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
          "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
          "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
          "properties": {
            "provisioningState": "Succeeded",
            "vpnSiteLink": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
            },
            "connectionBandwidth": 200,
            "ipsecPolicies": [],
            "vpnConnectionProtocolType": "IKEv2",
            "sharedKey": "key",
            "ingressBytesTransferred": 0,
            "egressBytesTransferred": 0,
            "enableBgp": false,
            "enableRateLimiting": false,
            "useLocalAzureIpAddress": false,
            "usePolicyBasedTrafficSelectors": false,
            "routingWeight": 0,
            "vpnLinkConnectionMode": "Default"
          }
        },
        {
          "name": "Connection-Link2",
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2",
          "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
          "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
          "properties": {
            "provisioningState": "Succeeded",
            "vpnSiteLink": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"
            },
            "connectionBandwidth": 200,
            "ipsecPolicies": [],
            "vpnConnectionProtocolType": "IKEv2",
            "sharedKey": "key",
            "ingressBytesTransferred": 0,
            "egressBytesTransferred": 0,
            "enableBgp": false,
            "enableRateLimiting": false,
            "useLocalAzureIpAddress": false,
            "usePolicyBasedTrafficSelectors": false,
            "routingWeight": 0,
            "vpnLinkConnectionMode": "Default"
          }
        }
      ],
      "routingConfiguration": {
        "associatedRouteTable": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
        },
        "propagatedRouteTables": {
          "labels": [
            "label1",
            "label2"
          ],
          "ids": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
            },
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"
            },
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"
            }
          ]
        },
        "inboundRouteMap": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"
        },
        "outboundRouteMap": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"
        }
      }
    }
  }
]

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.

ListVpnConnectionsResult

Ergebnis der Anforderung zum Auflisten aller VPN-Verbindungen mit einem virtuellen WAN-VPN-Gateway. Sie enthält eine Liste von VPN-Verbindungen und eine URL nextLink, um den nächsten Satz von Ergebnissen abzurufen.

PfsGroup

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

PropagatedRouteTable

Die Liste der RouteTables, an die die Routen angekündigt werden sollen.

ProvisioningState

Der aktuelle Bereitstellungsstatus.

RoutingConfiguration

Routingkonfiguration, die die zugeordneten und verteilten Routentabellen für diese Verbindung angibt.

StaticRoute

Liste aller statischen Routen.

StaticRoutesConfig

Konfiguration für statische Routen auf diesem HubVnetConnectionConfiguration für statische Routen auf diesem HubVnetConnection.

SubResource

Verweisen auf eine andere Unterressource.

TrafficSelectorPolicy

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

VirtualNetworkGatewayConnectionProtocol

Verbindungsprotokoll, das für diese Verbindung verwendet wird.

VnetLocalRouteOverrideCriteria

Parameter, der bestimmt, ob NVA in Speichen-vnet für Datenverkehr mit Ziel in Speichen-vnet umgangen wird.

VnetRoute

Liste der Routen, die das Routing von VirtualHub in eine virtuelle Netzwerkverbindung steuern.

VpnConnection

VpnConnection-Ressource.

VpnConnectionStatus

Der aktuelle Status der VPN-Verbindung.

VpnLinkConnectionMode

Verbindungsmodus für VPN-Verbindungen.

VpnSiteLinkConnection

VpnSiteLinkConnection-Ressource.

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.

ListVpnConnectionsResult

Ergebnis der Anforderung zum Auflisten aller VPN-Verbindungen mit einem virtuellen WAN-VPN-Gateway. Sie enthält eine Liste von VPN-Verbindungen und eine URL nextLink, um den nächsten Satz von Ergebnissen abzurufen.

Name Typ Beschreibung
nextLink

string

URL zum Abrufen des nächsten Vorgangslistenergebnisses, falls vorhanden.

value

VpnConnection[]

Liste der VPN-Verbindungen.

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

PropagatedRouteTable

Die Liste der RouteTables, an die die Routen angekündigt werden sollen.

Name Typ Beschreibung
ids

SubResource[]

Die Liste der Ressourcen-IDs aller RouteTables.

labels

string[]

Die Liste der Bezeichnungen.

ProvisioningState

Der aktuelle Bereitstellungsstatus.

Name Typ Beschreibung
Deleting

string

Failed

string

Succeeded

string

Updating

string

RoutingConfiguration

Routingkonfiguration, die die zugeordneten und verteilten Routentabellen für diese Verbindung angibt.

Name Typ Beschreibung
associatedRouteTable

SubResource

Die Ressourcen-ID RouteTable, die dieser RoutingConfiguration zugeordnet ist.

inboundRouteMap

SubResource

Die Ressourcen-ID der RouteMap, die dieser RoutingConfiguration für eingehende gelernte Routen zugeordnet ist.

outboundRouteMap

SubResource

Die Ressourcen-ID der RouteMap, die dieser RoutingConfiguration für ausgehende angekündigte Routen zugeordnet ist.

propagatedRouteTables

PropagatedRouteTable

Die Liste der RouteTables, an die die Routen angekündigt werden sollen.

vnetRoutes

VnetRoute

Liste der Routen, die das Routing von VirtualHub in eine virtuelle Netzwerkverbindung steuern.

StaticRoute

Liste aller statischen Routen.

Name Typ Beschreibung
addressPrefixes

string[]

Liste aller Adresspräfixe.

name

string

Der Name der StaticRoute, die innerhalb einer VnetRoute eindeutig ist.

nextHopIpAddress

string

Die IP-Adresse des nächsten Hops.

StaticRoutesConfig

Konfiguration für statische Routen auf diesem HubVnetConnectionConfiguration für statische Routen auf diesem HubVnetConnection.

Name Typ Beschreibung
propagateStaticRoutes

boolean

Boolescher Wert, der angibt, ob statische Routen für diese Verbindung automatisch an Routingtabellen weitergegeben werden, an die diese Verbindung weitergegeben wird.

vnetLocalRouteOverrideCriteria

VnetLocalRouteOverrideCriteria

Parameter, der bestimmt, ob NVA im Speichen-vnet für datenverkehr mit Ziel in Spoke umgangen wird.

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.

VirtualNetworkGatewayConnectionProtocol

Verbindungsprotokoll, das für diese Verbindung verwendet wird.

Name Typ Beschreibung
IKEv1

string

IKEv2

string

VnetLocalRouteOverrideCriteria

Parameter, der bestimmt, ob NVA in Speichen-vnet für Datenverkehr mit Ziel in Speichen-vnet umgangen wird.

Name Typ Beschreibung
Contains

string

Equal

string

VnetRoute

Liste der Routen, die das Routing von VirtualHub in eine virtuelle Netzwerkverbindung steuern.

Name Typ Beschreibung
bgpConnections

SubResource[]

Die Liste der Verweise auf HubBgpConnection-Objekte.

staticRoutes

StaticRoute[]

Liste aller statischen Routen.

staticRoutesConfig

StaticRoutesConfig

Konfiguration für statische Routen für diese HubVnetConnection.

VpnConnection

VpnConnection-Ressource.

Name Typ Beschreibung
etag

string

Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.

id

string

Ressourcen-ID.

name

string

Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.

properties.connectionBandwidth

integer

Erwartete Bandbreite in MBPS.

properties.connectionStatus

VpnConnectionStatus

Der Verbindungsstatus.

properties.dpdTimeoutSeconds

integer

DPD-Timeout in Sekunden für vpn-Verbindung.

properties.egressBytesTransferred

integer

Übertragene Eingangsbytes.

properties.enableBgp

boolean

EnableBgp-Flag.

properties.enableInternetSecurity

boolean

Internetsicherheit aktivieren.

properties.enableRateLimiting

boolean

EnableBgp-Flag.

properties.ingressBytesTransferred

integer

Durchgestellte Byte.

properties.ipsecPolicies

IpsecPolicy[]

Die IPSec-Richtlinien, die von dieser Verbindung berücksichtigt werden sollen.

properties.provisioningState

ProvisioningState

Der Bereitstellungsstatus der VPN-Verbindungsressource.

properties.remoteVpnSite

SubResource

ID der verbundenen VPN-Website.

properties.routingConfiguration

RoutingConfiguration

Die Routingkonfiguration, die die zugeordneten und verteilten Routentabellen für diese Verbindung angibt.

properties.routingWeight

integer

Routinggewichtung für vpn-Verbindung.

properties.sharedKey

string

SharedKey für die VPN-Verbindung.

properties.trafficSelectorPolicies

TrafficSelectorPolicy[]

Die Datenverkehrsauswahlrichtlinien, die von dieser Verbindung berücksichtigt werden sollen.

properties.useLocalAzureIpAddress

boolean

Verwenden Sie die lokale Azure-IP, um die Verbindung zu initiieren.

properties.usePolicyBasedTrafficSelectors

boolean

Aktivieren Sie richtlinienbasierte Datenverkehrsmarkierer.

properties.vpnConnectionProtocolType

VirtualNetworkGatewayConnectionProtocol

Verbindungsprotokoll, das für diese Verbindung verwendet wird.

properties.vpnLinkConnections

VpnSiteLinkConnection[]

Liste aller Vpn-Standortlinkverbindungen mit dem Gateway.

VpnConnectionStatus

Der aktuelle Status der VPN-Verbindung.

Name Typ Beschreibung
Connected

string

Connecting

string

NotConnected

string

Unknown

string

VpnLinkConnectionMode

Verbindungsmodus für VPN-Verbindungen.

Name Typ Beschreibung
Default

string

InitiatorOnly

string

ResponderOnly

string

VpnSiteLinkConnection

VpnSiteLinkConnection-Ressource.

Name Typ Beschreibung
etag

string

Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.

id

string

Ressourcen-ID.

name

string

Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.

properties.connectionBandwidth

integer

Erwartete Bandbreite in MBPS.

properties.connectionStatus

VpnConnectionStatus

Der Verbindungsstatus.

properties.dpdTimeoutSeconds

integer

Timeout für tote Peererkennung in Sekunden für die VpnLink-Verbindung.

properties.egressBytesTransferred

integer

Übertragene Eingangsbytes.

properties.egressNatRules

SubResource[]

Liste des Ausgangs natRules.

properties.enableBgp

boolean

EnableBgp-Flag.

properties.enableRateLimiting

boolean

EnableBgp-Flag.

properties.ingressBytesTransferred

integer

Durchgestellte Byte.

properties.ingressNatRules

SubResource[]

Liste der Eingangs natRules.

properties.ipsecPolicies

IpsecPolicy[]

Die IPSec-Richtlinien, die von dieser Verbindung berücksichtigt werden sollen.

properties.provisioningState

ProvisioningState

Der Bereitstellungsstatus der VPN-Standortverbindungsressource.

properties.routingWeight

integer

Routinggewichtung für vpn-Verbindung.

properties.sharedKey

string

SharedKey für die VPN-Verbindung.

properties.useLocalAzureIpAddress

boolean

Verwenden Sie die lokale Azure-IP, um die Verbindung zu initiieren.

properties.usePolicyBasedTrafficSelectors

boolean

Aktivieren Sie richtlinienbasierte Datenverkehrsmarkierer.

properties.vpnConnectionProtocolType

VirtualNetworkGatewayConnectionProtocol

Verbindungsprotokoll, das für diese Verbindung verwendet wird.

properties.vpnGatewayCustomBgpAddresses

GatewayCustomBgpIpAddressIpConfiguration[]

vpnGatewayCustomBgpAddresses, die von dieser Verbindung verwendet werden.

properties.vpnLinkConnectionMode

VpnLinkConnectionMode

Verbindungsmodus für VPN-Verbindungen.

properties.vpnSiteLink

SubResource

ID des verbundenen VPN-Standortlinks.

type

string

Ressourcentyp.