Vpn Connections - List By Vpn Gateway
Hämtar alla VPN-anslutningar för en viss vpn-gateway för virtuellt wan.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections?api-version=2024-05-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
gateway
|
path | True |
string |
Namnet på gatewayen. |
resource
|
path | True |
string |
Resursgruppens namn på VpnGateway. |
subscription
|
path | True |
string |
Autentiseringsuppgifterna för prenumerationen som unikt identifierar Microsoft Azure-prenumerationen. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop. |
api-version
|
query | True |
string |
Klient-API-version. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Begäran lyckades. Returnerar alla VPN-anslutningar för en vpn-gateway med virtuellt wan-nätverk. |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
VpnConnectionList
Exempelbegäran
Exempelsvar
[
{
"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"
}
}
}
}
]
Definitioner
Name | Description |
---|---|
Cloud |
Ett felsvar från tjänsten. |
Cloud |
Ett felsvar från tjänsten. |
Dh |
De DH-grupper som används i IKE Fas 1 för inledande SA. |
Gateway |
GatewayCustomBgpIpAddressIpConfiguration för en virtuell nätverksgatewayanslutning. |
Ike |
IKE-krypteringsalgoritmen (IKE fas 2). |
Ike |
IKE-integritetsalgoritmen (IKE fas 2). |
Ipsec |
IPSec-krypteringsalgoritmen (IKE-fas 1). |
Ipsec |
IPSec-integritetsalgoritmen (IKE fas 1). |
Ipsec |
En IPSec-principkonfiguration för en anslutning till en virtuell nätverksgateway. |
List |
Resultatet av begäran om att visa en lista över alla VPN-anslutningar till en virtuell wan vpn-gateway. Den innehåller en lista över VPN-anslutningar och en URL nextLink för att få nästa uppsättning resultat. |
Pfs |
Pfs-grupper som används i IKE Fas 2 för ny underordnad SA. |
Propagated |
Listan med RouteTables som du vill annonsera vägarna till. |
Provisioning |
Det aktuella etableringstillståndet. |
Routing |
Routningskonfiguration som anger de associerade och distribuerade routningstabellerna för den här anslutningen. |
Static |
Lista över alla statiska vägar. |
Static |
Konfiguration för statiska vägar på detta HubVnetConnectionConfiguration för statiska vägar på denna HubVnetConnection. |
Sub |
Referens till en annan underresurs. |
Traffic |
En trafikväljarprincip för en virtuell nätverksgatewayanslutning. |
Virtual |
Anslutningsprotokoll som används för den här anslutningen. |
Vnet |
Parameter som avgör om NVA i eker-vnet kringgås för trafik med målet i det virtuella ekernätverket. |
Vnet |
Lista över vägar som styr routning från VirtualHub till en virtuell nätverksanslutning. |
Vpn |
VpnConnection-resurs. |
Vpn |
Vpn-anslutningens aktuella tillstånd. |
Vpn |
Anslutningsläge för VPN-länk. |
Vpn |
VpnSiteLinkConnection-resurs. |
CloudError
Ett felsvar från tjänsten.
Name | Typ | Description |
---|---|---|
error |
Molnfeltext. |
CloudErrorBody
Ett felsvar från tjänsten.
Name | Typ | Description |
---|---|---|
code |
string |
En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt. |
details |
En lista med ytterligare information om felet. |
|
message |
string |
Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt. |
target |
string |
Målet för det specifika felet. Till exempel namnet på egenskapen i fel. |
DhGroup
De DH-grupper som används i IKE Fas 1 för inledande SA.
Värde | Description |
---|---|
DHGroup1 | |
DHGroup14 | |
DHGroup2 | |
DHGroup2048 | |
DHGroup24 | |
ECP256 | |
ECP384 | |
None |
GatewayCustomBgpIpAddressIpConfiguration
GatewayCustomBgpIpAddressIpConfiguration för en virtuell nätverksgatewayanslutning.
Name | Typ | Description |
---|---|---|
customBgpIpAddress |
string |
Den anpassade BgpPeeringAddress som tillhör IpconfigurationId. |
ipConfigurationId |
string |
IpconfigurationId för ipconfiguration som tillhör gatewayen. |
IkeEncryption
IKE-krypteringsalgoritmen (IKE fas 2).
Värde | Description |
---|---|
AES128 | |
AES192 | |
AES256 | |
DES | |
DES3 | |
GCMAES128 | |
GCMAES256 |
IkeIntegrity
IKE-integritetsalgoritmen (IKE fas 2).
Värde | Description |
---|---|
GCMAES128 | |
GCMAES256 | |
MD5 | |
SHA1 | |
SHA256 | |
SHA384 |
IpsecEncryption
IPSec-krypteringsalgoritmen (IKE-fas 1).
Värde | Description |
---|---|
AES128 | |
AES192 | |
AES256 | |
DES | |
DES3 | |
GCMAES128 | |
GCMAES192 | |
GCMAES256 | |
None |
IpsecIntegrity
IPSec-integritetsalgoritmen (IKE fas 1).
Värde | Description |
---|---|
GCMAES128 | |
GCMAES192 | |
GCMAES256 | |
MD5 | |
SHA1 | |
SHA256 |
IpsecPolicy
En IPSec-principkonfiguration för en anslutning till en virtuell nätverksgateway.
Name | Typ | Description |
---|---|---|
dhGroup |
Den DH-grupp som används i IKE Fas 1 för inledande SA. |
|
ikeEncryption |
IKE-krypteringsalgoritmen (IKE fas 2). |
|
ikeIntegrity |
IKE-integritetsalgoritmen (IKE fas 2). |
|
ipsecEncryption |
IPSec-krypteringsalgoritmen (IKE-fas 1). |
|
ipsecIntegrity |
IPSec-integritetsalgoritmen (IKE fas 1). |
|
pfsGroup |
Pfs-gruppen som används i IKE Fas 2 för ny underordnad SA. |
|
saDataSizeKilobytes |
integer (int32) |
IPSec-säkerhetsassociationen (kallas även snabbläge eller fas 2 SA) nyttolaststorlek i KB för en VPN-tunnel från plats till plats. |
saLifeTimeSeconds |
integer (int32) |
IPSec-säkerhetsassociationen (kallas även snabbläge eller fas 2 SA) i sekunder för en VPN-tunnel för plats-till-plats. |
ListVpnConnectionsResult
Resultatet av begäran om att visa en lista över alla VPN-anslutningar till en virtuell wan vpn-gateway. Den innehåller en lista över VPN-anslutningar och en URL nextLink för att få nästa uppsättning resultat.
Name | Typ | Description |
---|---|---|
nextLink |
string |
URL för att hämta nästa uppsättning resultat i åtgärdslistan om det finns några. |
value |
Lista över VPN-anslutningar. |
PfsGroup
Pfs-grupper som används i IKE Fas 2 för ny underordnad SA.
Värde | Description |
---|---|
ECP256 | |
ECP384 | |
None | |
PFS1 | |
PFS14 | |
PFS2 | |
PFS2048 | |
PFS24 | |
PFSMM |
PropagatedRouteTable
Listan med RouteTables som du vill annonsera vägarna till.
Name | Typ | Description |
---|---|---|
ids |
Listan över resurs-ID:t för alla RouteTables. |
|
labels |
string[] |
Listan med etiketter. |
ProvisioningState
Det aktuella etableringstillståndet.
Värde | Description |
---|---|
Deleting | |
Failed | |
Succeeded | |
Updating |
RoutingConfiguration
Routningskonfiguration som anger de associerade och distribuerade routningstabellerna för den här anslutningen.
Name | Typ | Description |
---|---|---|
associatedRouteTable |
Resurs-ID:t RouteTable som är associerad med den här RoutingConfiguration. |
|
inboundRouteMap |
Resurs-ID för RouteMap som är associerad med den här RoutingConfiguration för inkommande inlärda vägar. |
|
outboundRouteMap |
Resurs-ID för denRouteMap som är associerad med den här RoutingConfiguration för utgående annonserade vägar. |
|
propagatedRouteTables |
Listan med RouteTables som du vill annonsera vägarna till. |
|
vnetRoutes |
Lista över vägar som styr routning från VirtualHub till en virtuell nätverksanslutning. |
StaticRoute
Lista över alla statiska vägar.
Name | Typ | Description |
---|---|---|
addressPrefixes |
string[] |
Lista över alla adressprefix. |
name |
string |
Namnet på StaticRoute som är unikt i en VnetRoute. |
nextHopIpAddress |
string |
IP-adressen för nästa hopp. |
StaticRoutesConfig
Konfiguration för statiska vägar på detta HubVnetConnectionConfiguration för statiska vägar på denna HubVnetConnection.
Name | Typ | Description |
---|---|---|
propagateStaticRoutes |
boolean |
Booleskt värde som anger om statiska vägar i den här anslutningen automatiskt sprids till routningstabeller som anslutningen sprids till. |
vnetLocalRouteOverrideCriteria |
Parameter som avgör om NVA i eker-vnet kringgås för trafik med målet i eker. |
SubResource
Referens till en annan underresurs.
Name | Typ | Description |
---|---|---|
id |
string |
Resurs-ID. |
TrafficSelectorPolicy
En trafikväljarprincip för en virtuell nätverksgatewayanslutning.
Name | Typ | Description |
---|---|---|
localAddressRanges |
string[] |
En samling lokala adressutrymmen i CIDR-format. |
remoteAddressRanges |
string[] |
En samling fjärradressutrymmen i CIDR-format. |
VirtualNetworkGatewayConnectionProtocol
Anslutningsprotokoll som används för den här anslutningen.
Värde | Description |
---|---|
IKEv1 | |
IKEv2 |
VnetLocalRouteOverrideCriteria
Parameter som avgör om NVA i eker-vnet kringgås för trafik med målet i det virtuella ekernätverket.
Värde | Description |
---|---|
Contains | |
Equal |
VnetRoute
Lista över vägar som styr routning från VirtualHub till en virtuell nätverksanslutning.
Name | Typ | Description |
---|---|---|
bgpConnections |
Listan med referenser till HubBgpConnection-objekt. |
|
staticRoutes |
Lista över alla statiska vägar. |
|
staticRoutesConfig |
Konfiguration för statiska vägar på denna HubVnetConnection. |
VpnConnection
VpnConnection-resurs.
Name | Typ | Description |
---|---|---|
etag |
string |
En unik skrivskyddad sträng som ändras när resursen uppdateras. |
id |
string |
Resurs-ID. |
name |
string |
Namnet på resursen som är unik i en resursgrupp. Det här namnet kan användas för att komma åt resursen. |
properties.connectionBandwidth |
integer (int32) |
Förväntad bandbredd i MBPS. |
properties.connectionStatus |
Anslutningsstatus. |
|
properties.dpdTimeoutSeconds |
integer (int32) |
DPD-timeout i sekunder för VPN-anslutning. |
properties.egressBytesTransferred |
integer (int64) |
Utgående byte har överförts. |
properties.enableBgp |
boolean |
AktiveraBgp-flagga. |
properties.enableInternetSecurity |
boolean |
Aktivera internetsäkerhet. |
properties.enableRateLimiting |
boolean |
AktiveraBgp-flagga. |
properties.ingressBytesTransferred |
integer (int64) |
Inkommande byte har överförts. |
properties.ipsecPolicies |
IPSec-principerna som ska beaktas av den här anslutningen. |
|
properties.provisioningState |
Etableringstillståndet för VPN-anslutningsresursen. |
|
properties.remoteVpnSite |
ID för den anslutna VPN-platsen. |
|
properties.routingConfiguration |
Routningskonfigurationen som anger de associerade och spridade routningstabellerna i den här anslutningen. |
|
properties.routingWeight |
integer (int32) |
Routningsvikt för VPN-anslutning. |
properties.sharedKey |
string |
SharedKey för VPN-anslutningen. |
properties.trafficSelectorPolicies |
De trafikväljarprinciper som ska beaktas av den här anslutningen. |
|
properties.useLocalAzureIpAddress |
boolean |
Använd lokal azure ip för att initiera anslutningen. |
properties.usePolicyBasedTrafficSelectors |
boolean |
Aktivera principbaserade trafikväljare. |
properties.vpnConnectionProtocolType |
Anslutningsprotokoll som används för den här anslutningen. |
|
properties.vpnLinkConnections |
Lista över alla vpn-platslänkanslutningar till gatewayen. |
VpnConnectionStatus
Vpn-anslutningens aktuella tillstånd.
Värde | Description |
---|---|
Connected | |
Connecting | |
NotConnected | |
Unknown |
VpnLinkConnectionMode
Anslutningsläge för VPN-länk.
Värde | Description |
---|---|
Default | |
InitiatorOnly | |
ResponderOnly |
VpnSiteLinkConnection
VpnSiteLinkConnection-resurs.
Name | Typ | Description |
---|---|---|
etag |
string |
En unik skrivskyddad sträng som ändras när resursen uppdateras. |
id |
string |
Resurs-ID. |
name |
string |
Namnet på resursen som är unik i en resursgrupp. Det här namnet kan användas för att komma åt resursen. |
properties.connectionBandwidth |
integer (int32) |
Förväntad bandbredd i MBPS. |
properties.connectionStatus |
Anslutningsstatus. |
|
properties.dpdTimeoutSeconds |
integer (int32) |
Tidsgränsen för död peeridentifiering i sekunder för VpnLink-anslutning. |
properties.egressBytesTransferred |
integer (int64) |
Utgående byte har överförts. |
properties.egressNatRules |
Lista över utgående NatRules. |
|
properties.enableBgp |
boolean |
AktiveraBgp-flagga. |
properties.enableRateLimiting |
boolean |
AktiveraBgp-flagga. |
properties.ingressBytesTransferred |
integer (int64) |
Inkommande byte har överförts. |
properties.ingressNatRules |
Lista över inkommande NatRules. |
|
properties.ipsecPolicies |
IPSec-principerna som ska beaktas av den här anslutningen. |
|
properties.provisioningState |
Etableringstillståndet för VPN-platslänkanslutningsresursen. |
|
properties.routingWeight |
integer (int32) |
Routningsvikt för VPN-anslutning. |
properties.sharedKey |
string |
SharedKey för VPN-anslutningen. |
properties.useLocalAzureIpAddress |
boolean |
Använd lokal azure ip för att initiera anslutningen. |
properties.usePolicyBasedTrafficSelectors |
boolean |
Aktivera principbaserade trafikväljare. |
properties.vpnConnectionProtocolType |
Anslutningsprotokoll som används för den här anslutningen. |
|
properties.vpnGatewayCustomBgpAddresses |
vpnGatewayCustomBgpAddresses som används av den här anslutningen. |
|
properties.vpnLinkConnectionMode |
Anslutningsläge för VPN-länk. |
|
properties.vpnSiteLink |
Id för den anslutna vpn-platslänken. |
|
type |
string |
Resurstyp. |