Vpn Connections - Get
Recupera los detalles de una conexión VPN.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}?api-version=2024-05-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
connection
|
path | True |
string |
Nombre de la conexión vpn. |
gateway
|
path | True |
string |
Nombre de la puerta de enlace. |
resource
|
path | True |
string |
Nombre del grupo de recursos de VpnGateway. |
subscription
|
path | True |
string |
Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio. |
api-version
|
query | True |
string |
Versión de la API de cliente. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Solicitud correcta. Devuelve los detalles de la conexión VPN. |
|
Other Status Codes |
Respuesta de error que describe por qué se produjo un error en la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | suplantar la cuenta de usuario |
Ejemplos
VpnConnectionGet
Solicitud de ejemplo
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1?api-version=2024-05-01
Respuesta de muestra
{
"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": "ResponderOnly"
}
},
{
"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": "InitiatorOnly"
}
}
],
"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"
}
}
}
}
Definiciones
Nombre | Description |
---|---|
Cloud |
Respuesta de error del servicio. |
Cloud |
Respuesta de error del servicio. |
Dh |
Los grupos de DH usados en la fase 1 de IKE para la SA inicial. |
Gateway |
GatewayCustomBgpIpAddressIpConfiguration para una conexión de puerta de enlace de red virtual. |
Ike |
El algoritmo de cifrado IKE (fase 2 de IKE). |
Ike |
El algoritmo de integridad de IKE (fase 2 de IKE). |
Ipsec |
El algoritmo de cifrado IPSec (fase 1 de IKE). |
Ipsec |
El algoritmo de integridad de IPSec (fase 1 de IKE). |
Ipsec |
Una configuración de directiva IPSec para una conexión de puerta de enlace de red virtual. |
Pfs |
Los grupos pfs usados en la fase 2 de IKE para la nueva SA secundaria. |
Propagated |
Lista de RouteTables a las que anunciar las rutas. |
Provisioning |
Estado de aprovisionamiento actual. |
Routing |
Configuración de enrutamiento que indica las tablas de rutas asociadas y propagadas para esta conexión. |
Static |
Lista de todas las rutas estáticas. |
Static |
Configuración de rutas estáticas en este hubVnetConnectionConfiguration para rutas estáticas en este HubVnetConnection. |
Sub |
Referencia a otro subrecurso. |
Traffic |
Una directiva de selector de tráfico para una conexión de puerta de enlace de red virtual. |
Virtual |
Protocolo de conexión usado para esta conexión. |
Vnet |
Parámetro que determina si se omite la NVA en la red virtual radial para el tráfico con destino en la red virtual de radio. |
Vnet |
Lista de rutas que controlan el enrutamiento desde VirtualHub a una conexión de red virtual. |
Vpn |
Recurso vpnConnection. |
Vpn |
Estado actual de la conexión vpn. |
Vpn |
Modo de conexión de vínculo vpn. |
Vpn |
Recurso VpnSiteLinkConnection. |
CloudError
Respuesta de error del servicio.
Nombre | Tipo | Description |
---|---|---|
error |
Cuerpo del error en la nube. |
CloudErrorBody
Respuesta de error del servicio.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación. |
details |
Lista de detalles adicionales sobre el error. |
|
message |
string |
Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario. |
target |
string |
Destino del error concreto. Por ejemplo, el nombre de la propiedad en error. |
DhGroup
Los grupos de DH usados en la fase 1 de IKE para la SA inicial.
Nombre | Tipo | Description |
---|---|---|
DHGroup1 |
string |
|
DHGroup14 |
string |
|
DHGroup2 |
string |
|
DHGroup2048 |
string |
|
DHGroup24 |
string |
|
ECP256 |
string |
|
ECP384 |
string |
|
None |
string |
GatewayCustomBgpIpAddressIpConfiguration
GatewayCustomBgpIpAddressIpConfiguration para una conexión de puerta de enlace de red virtual.
Nombre | Tipo | Description |
---|---|---|
customBgpIpAddress |
string |
El BgpPeeringAddress personalizado que pertenece a IpconfigurationId. |
ipConfigurationId |
string |
IpconfigurationId de ipconfiguration que pertenece a la puerta de enlace. |
IkeEncryption
El algoritmo de cifrado IKE (fase 2 de IKE).
Nombre | Tipo | Description |
---|---|---|
AES128 |
string |
|
AES192 |
string |
|
AES256 |
string |
|
DES |
string |
|
DES3 |
string |
|
GCMAES128 |
string |
|
GCMAES256 |
string |
IkeIntegrity
El algoritmo de integridad de IKE (fase 2 de IKE).
Nombre | Tipo | Description |
---|---|---|
GCMAES128 |
string |
|
GCMAES256 |
string |
|
MD5 |
string |
|
SHA1 |
string |
|
SHA256 |
string |
|
SHA384 |
string |
IpsecEncryption
El algoritmo de cifrado IPSec (fase 1 de IKE).
Nombre | Tipo | Description |
---|---|---|
AES128 |
string |
|
AES192 |
string |
|
AES256 |
string |
|
DES |
string |
|
DES3 |
string |
|
GCMAES128 |
string |
|
GCMAES192 |
string |
|
GCMAES256 |
string |
|
None |
string |
IpsecIntegrity
El algoritmo de integridad de IPSec (fase 1 de IKE).
Nombre | Tipo | Description |
---|---|---|
GCMAES128 |
string |
|
GCMAES192 |
string |
|
GCMAES256 |
string |
|
MD5 |
string |
|
SHA1 |
string |
|
SHA256 |
string |
IpsecPolicy
Una configuración de directiva IPSec para una conexión de puerta de enlace de red virtual.
Nombre | Tipo | Description |
---|---|---|
dhGroup |
El grupo de DH usado en la fase 1 de IKE para la SA inicial. |
|
ikeEncryption |
El algoritmo de cifrado IKE (fase 2 de IKE). |
|
ikeIntegrity |
El algoritmo de integridad de IKE (fase 2 de IKE). |
|
ipsecEncryption |
El algoritmo de cifrado IPSec (fase 1 de IKE). |
|
ipsecIntegrity |
El algoritmo de integridad de IPSec (fase 1 de IKE). |
|
pfsGroup |
El grupo Pfs usado en la fase 2 de IKE para la nueva SA secundaria. |
|
saDataSizeKilobytes |
integer |
El tamaño de carga de la Asociación de seguridad ipSec (también denominado Modo rápido o SA de fase 2) en KB para un túnel VPN de sitio a sitio. |
saLifeTimeSeconds |
integer |
La duración de la Asociación de seguridad ipSec (también denominada Modo rápido o SA de fase 2) en segundos para un túnel VPN de sitio a sitio. |
PfsGroup
Los grupos pfs usados en la fase 2 de IKE para la nueva SA secundaria.
Nombre | Tipo | Description |
---|---|---|
ECP256 |
string |
|
ECP384 |
string |
|
None |
string |
|
PFS1 |
string |
|
PFS14 |
string |
|
PFS2 |
string |
|
PFS2048 |
string |
|
PFS24 |
string |
|
PFSMM |
string |
PropagatedRouteTable
Lista de RouteTables a las que anunciar las rutas.
Nombre | Tipo | Description |
---|---|---|
ids |
Lista de identificadores de recursos de todas las RouteTables. |
|
labels |
string[] |
Lista de etiquetas. |
ProvisioningState
Estado de aprovisionamiento actual.
Nombre | Tipo | Description |
---|---|---|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
RoutingConfiguration
Configuración de enrutamiento que indica las tablas de rutas asociadas y propagadas para esta conexión.
Nombre | Tipo | Description |
---|---|---|
associatedRouteTable |
El identificador de recurso RouteTable asociado a este RoutingConfiguration. |
|
inboundRouteMap |
El identificador de recurso del objeto RouteMap asociado a este Objeto RoutingConfiguration para las rutas aprendidas de entrada. |
|
outboundRouteMap |
El identificador de recurso derouteMap asociado a este routingConfiguration para las rutas anunciadas salientes. |
|
propagatedRouteTables |
Lista de RouteTables a las que anunciar las rutas. |
|
vnetRoutes |
Lista de rutas que controlan el enrutamiento desde VirtualHub a una conexión de red virtual. |
StaticRoute
Lista de todas las rutas estáticas.
Nombre | Tipo | Description |
---|---|---|
addressPrefixes |
string[] |
Lista de todos los prefijos de dirección. |
name |
string |
Nombre de StaticRoute que es único dentro de una instancia de VnetRoute. |
nextHopIpAddress |
string |
Dirección IP del próximo salto. |
StaticRoutesConfig
Configuración de rutas estáticas en este hubVnetConnectionConfiguration para rutas estáticas en este HubVnetConnection.
Nombre | Tipo | Description |
---|---|---|
propagateStaticRoutes |
boolean |
Boolean que indica si las rutas estáticas de esta conexión se propagan automáticamente a las tablas de rutas a las que se propaga esta conexión. |
vnetLocalRouteOverrideCriteria |
Parámetro que determina si se omite la NVA en la red virtual de radio para el tráfico con destino en radio. |
SubResource
Referencia a otro subrecurso.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso. |
TrafficSelectorPolicy
Una directiva de selector de tráfico para una conexión de puerta de enlace de red virtual.
Nombre | Tipo | Description |
---|---|---|
localAddressRanges |
string[] |
Colección de espacios de direcciones locales en formato CIDR. |
remoteAddressRanges |
string[] |
Colección de espacios de direcciones remotas en formato CIDR. |
VirtualNetworkGatewayConnectionProtocol
Protocolo de conexión usado para esta conexión.
Nombre | Tipo | Description |
---|---|---|
IKEv1 |
string |
|
IKEv2 |
string |
VnetLocalRouteOverrideCriteria
Parámetro que determina si se omite la NVA en la red virtual radial para el tráfico con destino en la red virtual de radio.
Nombre | Tipo | Description |
---|---|---|
Contains |
string |
|
Equal |
string |
VnetRoute
Lista de rutas que controlan el enrutamiento desde VirtualHub a una conexión de red virtual.
Nombre | Tipo | Description |
---|---|---|
bgpConnections |
Lista de referencias a objetos HubBgpConnection. |
|
staticRoutes |
Lista de todas las rutas estáticas. |
|
staticRoutesConfig |
Configuración de rutas estáticas en este HubVnetConnection. |
VpnConnection
Recurso vpnConnection.
Nombre | Tipo | Description |
---|---|---|
etag |
string |
Cadena de solo lectura única que cambia cada vez que se actualiza el recurso. |
id |
string |
Identificador de recurso. |
name |
string |
Nombre del recurso que es único dentro de un grupo de recursos. Este nombre se puede usar para acceder al recurso. |
properties.connectionBandwidth |
integer |
Ancho de banda esperado en MBPS. |
properties.connectionStatus |
Estado de conexión. |
|
properties.dpdTimeoutSeconds |
integer |
Tiempo de espera de DPD en segundos para la conexión vpn. |
properties.egressBytesTransferred |
integer |
Bytes de salida transferidos. |
properties.enableBgp |
boolean |
Marca EnableBgp. |
properties.enableInternetSecurity |
boolean |
Habilite la seguridad de Internet. |
properties.enableRateLimiting |
boolean |
Marca EnableBgp. |
properties.ingressBytesTransferred |
integer |
Bytes de entrada transferidos. |
properties.ipsecPolicies |
Las directivas IPSec que debe tener en cuenta esta conexión. |
|
properties.provisioningState |
Estado de aprovisionamiento del recurso de conexión VPN. |
|
properties.remoteVpnSite |
Identificador del sitio vpn conectado. |
|
properties.routingConfiguration |
Configuración de enrutamiento que indica las tablas de rutas asociadas y propagadas en esta conexión. |
|
properties.routingWeight |
integer |
Peso del enrutamiento para la conexión VPN. |
properties.sharedKey |
string |
SharedKey para la conexión VPN. |
properties.trafficSelectorPolicies |
Las directivas del selector de tráfico que debe tener en cuenta esta conexión. |
|
properties.useLocalAzureIpAddress |
boolean |
Use azure ip local para iniciar la conexión. |
properties.usePolicyBasedTrafficSelectors |
boolean |
Habilite los selectores de tráfico basados en directivas. |
properties.vpnConnectionProtocolType |
Protocolo de conexión usado para esta conexión. |
|
properties.vpnLinkConnections |
Lista de todas las conexiones de vínculo de sitio vpn a la puerta de enlace. |
VpnConnectionStatus
Estado actual de la conexión vpn.
Nombre | Tipo | Description |
---|---|---|
Connected |
string |
|
Connecting |
string |
|
NotConnected |
string |
|
Unknown |
string |
VpnLinkConnectionMode
Modo de conexión de vínculo vpn.
Nombre | Tipo | Description |
---|---|---|
Default |
string |
|
InitiatorOnly |
string |
|
ResponderOnly |
string |
VpnSiteLinkConnection
Recurso VpnSiteLinkConnection.
Nombre | Tipo | Description |
---|---|---|
etag |
string |
Cadena de solo lectura única que cambia cada vez que se actualiza el recurso. |
id |
string |
Identificador de recurso. |
name |
string |
Nombre del recurso que es único dentro de un grupo de recursos. Este nombre se puede usar para acceder al recurso. |
properties.connectionBandwidth |
integer |
Ancho de banda esperado en MBPS. |
properties.connectionStatus |
Estado de conexión. |
|
properties.dpdTimeoutSeconds |
integer |
Tiempo de espera de detección del mismo nivel inactivo en segundos para la conexión VpnLink. |
properties.egressBytesTransferred |
integer |
Bytes de salida transferidos. |
properties.egressNatRules |
Lista de natRules de salida. |
|
properties.enableBgp |
boolean |
Marca EnableBgp. |
properties.enableRateLimiting |
boolean |
Marca EnableBgp. |
properties.ingressBytesTransferred |
integer |
Bytes de entrada transferidos. |
properties.ingressNatRules |
Lista de entradas NatRules. |
|
properties.ipsecPolicies |
Las directivas IPSec que debe tener en cuenta esta conexión. |
|
properties.provisioningState |
Estado de aprovisionamiento del recurso de conexión de vínculo de sitio VPN. |
|
properties.routingWeight |
integer |
Peso del enrutamiento para la conexión VPN. |
properties.sharedKey |
string |
SharedKey para la conexión VPN. |
properties.useLocalAzureIpAddress |
boolean |
Use azure ip local para iniciar la conexión. |
properties.usePolicyBasedTrafficSelectors |
boolean |
Habilite los selectores de tráfico basados en directivas. |
properties.vpnConnectionProtocolType |
Protocolo de conexión usado para esta conexión. |
|
properties.vpnGatewayCustomBgpAddresses |
vpnGatewayCustomBgpAddresses usado por esta conexión. |
|
properties.vpnLinkConnectionMode |
Modo de conexión de vínculo vpn. |
|
properties.vpnSiteLink |
Identificador del vínculo del sitio vpn conectado. |
|
type |
string |
Tipo de recurso. |