Vpn Connections - List By Vpn Gateway
Hiermee haalt u alle VPN-verbindingen voor een bepaalde vpn-gateway voor een bepaalde virtuele wan op.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections?api-version=2024-05-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
gateway
|
path | True |
string |
De naam van de gateway. |
resource
|
path | True |
string |
De naam van de resourcegroep van de VpnGateway. |
subscription
|
path | True |
string |
De abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep. |
api-version
|
query | True |
string |
Client-API-versie. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Aanvraag is voltooid. Retourneert alle Vpn-verbindingen voor een vpn-gateway voor een virtuele wan. |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
VpnConnectionList
Voorbeeldaanvraag
Voorbeeldrespons
[
{
"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"
}
}
}
}
]
Definities
Name | Description |
---|---|
Cloud |
Een foutreactie van de service. |
Cloud |
Een foutreactie van de service. |
Dh |
De DH-groepen die worden gebruikt in IKE Fase 1 voor de eerste SA. |
Gateway |
GatewayCustomBgpIpAddressIpConfiguration voor een virtuele netwerkgatewayverbinding. |
Ike |
Het IKE-versleutelingsalgoritmen (IKE-fase 2). |
Ike |
Het IKE-integriteitsalgoritmen (IKE-fase 2). |
Ipsec |
Het IPSec-versleutelingsalgoritmen (IKE-fase 1). |
Ipsec |
Het IPSec-integriteitsalgoritmen (IKE-fase 1). |
Ipsec |
Een IPSec-beleidsconfiguratie voor een virtuele netwerkgatewayverbinding. |
List |
Resultaat van de aanvraag om alle VPN-verbindingen met een virtual wan VPN-gateway weer te geven. Het bevat een lijst met VPN-verbindingen en een URL nextLink om de volgende set resultaten op te halen. |
Pfs |
De Pfs-groepen die worden gebruikt in IKE Fase 2 voor nieuwe onderliggende SA. |
Propagated |
De lijst met RouteTables om de routes naar te adverteren. |
Provisioning |
De huidige inrichtingsstatus. |
Routing |
Routeringsconfiguratie die de gekoppelde en doorgegeven routetabellen voor deze verbinding aangeeft. |
Static |
Lijst met alle statische routes. |
Static |
Configuratie voor statische routes op deze HubVnetConnectionConfiguration voor statische routes op deze HubVnetConnection. |
Sub |
Verwijzing naar een andere subresource. |
Traffic |
Een verkeersselectorbeleid voor een gatewayverbinding met een virtueel netwerk. |
Virtual |
Verbindingsprotocol dat wordt gebruikt voor deze verbinding. |
Vnet |
Parameter die bepaalt of NVA in spoke-vnet wordt omzeild voor verkeer met bestemming in spoke-vnet. |
Vnet |
Lijst met routes die routering van VirtualHub naar een virtuele netwerkverbinding beheren. |
Vpn |
VpnConnection-resource. |
Vpn |
De huidige status van de VPN-verbinding. |
Vpn |
Vpn-koppelingsverbindingsmodus. |
Vpn |
VpnSiteLinkConnection-resource. |
CloudError
Een foutreactie van de service.
Name | Type | Description |
---|---|---|
error |
Hoofdtekst van cloudfout. |
CloudErrorBody
Een foutreactie van de service.
Name | Type | Description |
---|---|---|
code |
string |
Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt. |
details |
Een lijst met aanvullende informatie over de fout. |
|
message |
string |
Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface. |
target |
string |
Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout. |
DhGroup
De DH-groepen die worden gebruikt in IKE Fase 1 voor de eerste SA.
Name | Type | Description |
---|---|---|
DHGroup1 |
string |
|
DHGroup14 |
string |
|
DHGroup2 |
string |
|
DHGroup2048 |
string |
|
DHGroup24 |
string |
|
ECP256 |
string |
|
ECP384 |
string |
|
None |
string |
GatewayCustomBgpIpAddressIpConfiguration
GatewayCustomBgpIpAddressIpConfiguration voor een virtuele netwerkgatewayverbinding.
Name | Type | Description |
---|---|---|
customBgpIpAddress |
string |
Het aangepaste BgpPeeringAddress dat deel uitmaakt van IpconfigurationId. |
ipConfigurationId |
string |
De IpconfigurationId van ipconfiguration die deel uitmaakt van de gateway. |
IkeEncryption
Het IKE-versleutelingsalgoritmen (IKE-fase 2).
Name | Type | Description |
---|---|---|
AES128 |
string |
|
AES192 |
string |
|
AES256 |
string |
|
DES |
string |
|
DES3 |
string |
|
GCMAES128 |
string |
|
GCMAES256 |
string |
IkeIntegrity
Het IKE-integriteitsalgoritmen (IKE-fase 2).
Name | Type | Description |
---|---|---|
GCMAES128 |
string |
|
GCMAES256 |
string |
|
MD5 |
string |
|
SHA1 |
string |
|
SHA256 |
string |
|
SHA384 |
string |
IpsecEncryption
Het IPSec-versleutelingsalgoritmen (IKE-fase 1).
Name | Type | Description |
---|---|---|
AES128 |
string |
|
AES192 |
string |
|
AES256 |
string |
|
DES |
string |
|
DES3 |
string |
|
GCMAES128 |
string |
|
GCMAES192 |
string |
|
GCMAES256 |
string |
|
None |
string |
IpsecIntegrity
Het IPSec-integriteitsalgoritmen (IKE-fase 1).
Name | Type | Description |
---|---|---|
GCMAES128 |
string |
|
GCMAES192 |
string |
|
GCMAES256 |
string |
|
MD5 |
string |
|
SHA1 |
string |
|
SHA256 |
string |
IpsecPolicy
Een IPSec-beleidsconfiguratie voor een virtuele netwerkgatewayverbinding.
Name | Type | Description |
---|---|---|
dhGroup |
De DH-groep die wordt gebruikt in IKE Fase 1 voor de eerste SA. |
|
ikeEncryption |
Het IKE-versleutelingsalgoritmen (IKE-fase 2). |
|
ikeIntegrity |
Het IKE-integriteitsalgoritmen (IKE-fase 2). |
|
ipsecEncryption |
Het IPSec-versleutelingsalgoritmen (IKE-fase 1). |
|
ipsecIntegrity |
Het IPSec-integriteitsalgoritmen (IKE-fase 1). |
|
pfsGroup |
De Pfs-groep die wordt gebruikt in IKE Fase 2 voor nieuwe onderliggende SA. |
|
saDataSizeKilobytes |
integer |
De nettoladinggrootte IPSec-beveiligingskoppeling (ook wel snelle modus of fase 2 SA genoemd) in KB voor een site-naar-site-VPN-tunnel. |
saLifeTimeSeconds |
integer |
De LEVENSDUUR van de IPSec-beveiligingskoppeling (ook wel snelle modus of fase 2 SA genoemd) in seconden voor een site-naar-site-VPN-tunnel. |
ListVpnConnectionsResult
Resultaat van de aanvraag om alle VPN-verbindingen met een virtual wan VPN-gateway weer te geven. Het bevat een lijst met VPN-verbindingen en een URL nextLink om de volgende set resultaten op te halen.
Name | Type | Description |
---|---|---|
nextLink |
string |
URL voor het ophalen van de volgende set met resultaten van de bewerkingslijst, indien aanwezig. |
value |
Lijst met VPN-verbindingen. |
PfsGroup
De Pfs-groepen die worden gebruikt in IKE Fase 2 voor nieuwe onderliggende SA.
Name | Type | Description |
---|---|---|
ECP256 |
string |
|
ECP384 |
string |
|
None |
string |
|
PFS1 |
string |
|
PFS14 |
string |
|
PFS2 |
string |
|
PFS2048 |
string |
|
PFS24 |
string |
|
PFSMM |
string |
PropagatedRouteTable
De lijst met RouteTables om de routes naar te adverteren.
Name | Type | Description |
---|---|---|
ids |
De lijst met resource-id's van alle RouteTables. |
|
labels |
string[] |
De lijst met labels. |
ProvisioningState
De huidige inrichtingsstatus.
Name | Type | Description |
---|---|---|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
RoutingConfiguration
Routeringsconfiguratie die de gekoppelde en doorgegeven routetabellen voor deze verbinding aangeeft.
Name | Type | Description |
---|---|---|
associatedRouteTable |
De resource-id RouteTable die is gekoppeld aan deze RoutingConfiguration. |
|
inboundRouteMap |
De resource-id van de RouteMap die is gekoppeld aan deze RoutingConfiguration voor binnenkomende geleerde routes. |
|
outboundRouteMap |
De resource-id van deRouteMap die is gekoppeld aan deze RoutingConfiguration voor uitgaande geadverteerde routes. |
|
propagatedRouteTables |
De lijst met RouteTables om de routes naar te adverteren. |
|
vnetRoutes |
Lijst met routes die routering van VirtualHub naar een virtuele netwerkverbinding beheren. |
StaticRoute
Lijst met alle statische routes.
Name | Type | Description |
---|---|---|
addressPrefixes |
string[] |
Lijst met alle adresvoorvoegsels. |
name |
string |
De naam van de StaticRoute die uniek is binnen een VnetRoute. |
nextHopIpAddress |
string |
Het IP-adres van de volgende hop. |
StaticRoutesConfig
Configuratie voor statische routes op deze HubVnetConnectionConfiguration voor statische routes op deze HubVnetConnection.
Name | Type | Description |
---|---|---|
propagateStaticRoutes |
boolean |
Booleaanse waarde die aangeeft of statische routes op deze verbinding automatisch worden doorgegeven aan routetabellen waarnaar deze verbinding wordt doorgegeven. |
vnetLocalRouteOverrideCriteria |
Parameter die bepaalt of NVA in spoke-vnet wordt omzeild voor verkeer met bestemming in spoke. |
SubResource
Verwijzing naar een andere subresource.
Name | Type | Description |
---|---|---|
id |
string |
Resource-id. |
TrafficSelectorPolicy
Een verkeersselectorbeleid voor een gatewayverbinding met een virtueel netwerk.
Name | Type | Description |
---|---|---|
localAddressRanges |
string[] |
Een verzameling lokale adresruimten in CIDR-indeling. |
remoteAddressRanges |
string[] |
Een verzameling externe adresruimten in CIDR-indeling. |
VirtualNetworkGatewayConnectionProtocol
Verbindingsprotocol dat wordt gebruikt voor deze verbinding.
Name | Type | Description |
---|---|---|
IKEv1 |
string |
|
IKEv2 |
string |
VnetLocalRouteOverrideCriteria
Parameter die bepaalt of NVA in spoke-vnet wordt omzeild voor verkeer met bestemming in spoke-vnet.
Name | Type | Description |
---|---|---|
Contains |
string |
|
Equal |
string |
VnetRoute
Lijst met routes die routering van VirtualHub naar een virtuele netwerkverbinding beheren.
Name | Type | Description |
---|---|---|
bgpConnections |
De lijst met verwijzingen naar HubBgpConnection-objecten. |
|
staticRoutes |
Lijst met alle statische routes. |
|
staticRoutesConfig |
Configuratie voor statische routes op deze HubVnetConnection. |
VpnConnection
VpnConnection-resource.
Name | Type | Description |
---|---|---|
etag |
string |
Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt. |
id |
string |
Resource-id. |
name |
string |
De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource. |
properties.connectionBandwidth |
integer |
Verwachte bandbreedte in MBPS. |
properties.connectionStatus |
De verbindingsstatus. |
|
properties.dpdTimeoutSeconds |
integer |
DPD-time-out in seconden voor vpn-verbinding. |
properties.egressBytesTransferred |
integer |
Uitgaande bytes overgedragen. |
properties.enableBgp |
boolean |
EnableBgp-vlag. |
properties.enableInternetSecurity |
boolean |
Internetbeveiliging inschakelen. |
properties.enableRateLimiting |
boolean |
EnableBgp-vlag. |
properties.ingressBytesTransferred |
integer |
Binnenkomende bytes overgedragen. |
properties.ipsecPolicies |
Het IPSec-beleid dat door deze verbinding moet worden overwogen. |
|
properties.provisioningState |
De inrichtingsstatus van de VPN-verbindingsresource. |
|
properties.remoteVpnSite |
Id van de verbonden VPN-site. |
|
properties.routingConfiguration |
De routeringsconfiguratie die de gekoppelde en doorgegeven routetabellen op deze verbinding aangeeft. |
|
properties.routingWeight |
integer |
Routeringsgewicht voor vpn-verbinding. |
properties.sharedKey |
string |
SharedKey voor de VPN-verbinding. |
properties.trafficSelectorPolicies |
Het beleid voor verkeersselector dat door deze verbinding moet worden overwogen. |
|
properties.useLocalAzureIpAddress |
boolean |
Gebruik lokale Azure IP om verbinding te initiëren. |
properties.usePolicyBasedTrafficSelectors |
boolean |
Schakel verkeerkiezers op basis van beleid in. |
properties.vpnConnectionProtocolType |
Verbindingsprotocol dat wordt gebruikt voor deze verbinding. |
|
properties.vpnLinkConnections |
Lijst met alle vpn-sitekoppelingen naar de gateway. |
VpnConnectionStatus
De huidige status van de VPN-verbinding.
Name | Type | Description |
---|---|---|
Connected |
string |
|
Connecting |
string |
|
NotConnected |
string |
|
Unknown |
string |
VpnLinkConnectionMode
Vpn-koppelingsverbindingsmodus.
Name | Type | Description |
---|---|---|
Default |
string |
|
InitiatorOnly |
string |
|
ResponderOnly |
string |
VpnSiteLinkConnection
VpnSiteLinkConnection-resource.
Name | Type | Description |
---|---|---|
etag |
string |
Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt. |
id |
string |
Resource-id. |
name |
string |
De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource. |
properties.connectionBandwidth |
integer |
Verwachte bandbreedte in MBPS. |
properties.connectionStatus |
De verbindingsstatus. |
|
properties.dpdTimeoutSeconds |
integer |
Time-out voor dead peer detection in seconden voor VpnLink-verbinding. |
properties.egressBytesTransferred |
integer |
Uitgaande bytes overgedragen. |
properties.egressNatRules |
Lijst met uitgaande NatRules. |
|
properties.enableBgp |
boolean |
EnableBgp-vlag. |
properties.enableRateLimiting |
boolean |
EnableBgp-vlag. |
properties.ingressBytesTransferred |
integer |
Binnenkomende bytes overgedragen. |
properties.ingressNatRules |
Lijst met inkomend verkeer NatRules. |
|
properties.ipsecPolicies |
Het IPSec-beleid dat door deze verbinding moet worden overwogen. |
|
properties.provisioningState |
De inrichtingsstatus van de verbindingsresource van de VPN-sitekoppeling. |
|
properties.routingWeight |
integer |
Routeringsgewicht voor vpn-verbinding. |
properties.sharedKey |
string |
SharedKey voor de VPN-verbinding. |
properties.useLocalAzureIpAddress |
boolean |
Gebruik lokale Azure IP om verbinding te initiëren. |
properties.usePolicyBasedTrafficSelectors |
boolean |
Schakel verkeerkiezers op basis van beleid in. |
properties.vpnConnectionProtocolType |
Verbindingsprotocol dat wordt gebruikt voor deze verbinding. |
|
properties.vpnGatewayCustomBgpAddresses |
vpnGatewayCustomBgpAddresses die door deze verbinding worden gebruikt. |
|
properties.vpnLinkConnectionMode |
Vpn-koppelingsverbindingsmodus. |
|
properties.vpnSiteLink |
Id van de gekoppelde vpn-sitekoppeling. |
|
type |
string |
Resourcetype. |