Vpn Connections - List By Vpn Gateway

Recupera todas las conexiones VPN para una puerta de enlace de VPN de virtual wan determinada.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
gatewayName
path True

string

El nombre de la puerta de enlace.

resourceGroupName
path True

string

Nombre del grupo de recursos de VpnGateway.

subscriptionId
path True

string

Las credenciales de suscripción que identifican de forma exclusiva la suscripción a Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.

api-version
query True

string

Versión de API del cliente.

Respuestas

Nombre Tipo Description
200 OK

ListVpnConnectionsResult

Solicitud correcta. Devuelve todas las conexiones Vpn para una puerta de enlace de VPN de virtual wan.

Other Status Codes

CloudError

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

VpnConnectionList

Sample Request

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

Sample Response

[
  {
    "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"
        }
      }
    }
  }
]

Definiciones

Nombre Description
CloudError

Respuesta de error del servicio.

CloudErrorBody

Respuesta de error del servicio.

DhGroup

Los grupos de DH usados en la fase 1 de IKE para la SA inicial.

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration para una conexión de puerta de enlace de red virtual.

IkeEncryption

Algoritmo de cifrado de IKE (fase 2 de IKE).

IkeIntegrity

El algoritmo de integridad de IKE (fase 2 de IKE).

IpsecEncryption

Algoritmo de cifrado IPSec (fase 1 de IKE).

IpsecIntegrity

Algoritmo de integridad de IPSec (fase 1 de IKE).

IpsecPolicy

Una configuración de directiva IPSec para una conexión de puerta de enlace de red virtual.

ListVpnConnectionsResult

Resultado de la solicitud para enumerar todas las conexiones vpn a una puerta de enlace de VPN de virtual wan. Contiene una lista de vpn Connections y una dirección URL nextLink para obtener el siguiente conjunto de resultados.

PfsGroup

Los grupos pfs usados en la fase 2 de IKE para la nueva SA secundaria.

PropagatedRouteTable

Lista de RouteTables a la que anunciar las rutas.

ProvisioningState

Estado de aprovisionamiento actual.

RoutingConfiguration

Configuración de enrutamiento que indica las tablas de rutas asociadas y propagadas para esta conexión.

StaticRoute

Lista de todas las rutas estáticas.

StaticRoutesConfig

Configuración de rutas estáticas en este HubVnetConnectionConfiguration para rutas estáticas en este HubVnetConnection.

SubResource

Referencia a otro subrecurso.

TrafficSelectorPolicy

Una directiva de selector de tráfico para una conexión de puerta de enlace de red virtual.

VirtualNetworkGatewayConnectionProtocol

Protocolo de conexión usado para esta conexión.

VnetLocalRouteOverrideCriteria

Parámetro que determina si la NVA en la red virtual de radio se omite para el tráfico con destino en la red virtual de radio.

VnetRoute

Lista de rutas que controlan el enrutamiento desde VirtualHub a una conexión de red virtual.

VpnConnection

Recurso VpnConnection.

VpnConnectionStatus

Estado actual de la conexión vpn.

VpnLinkConnectionMode

Modo de conexión de vínculo vpn.

VpnSiteLinkConnection

Recurso VpnSiteLinkConnection.

CloudError

Respuesta de error del servicio.

Nombre Tipo Description
error

CloudErrorBody

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

CloudErrorBody[]

Lista de detalles adicionales sobre el error.

message

string

Mensaje que describe el error, diseñado para ser adecuado para su presentación en una interfaz de usuario.

target

string

Destino del error determinado. 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

Algoritmo de cifrado de 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

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

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

DhGroup

El grupo de DH que se usa en la fase 1 de IKE para la SA inicial.

ikeEncryption

IkeEncryption

Algoritmo de cifrado de IKE (fase 2 de IKE).

ikeIntegrity

IkeIntegrity

El algoritmo de integridad de IKE (fase 2 de IKE).

ipsecEncryption

IpsecEncryption

Algoritmo de cifrado IPSec (fase 1 de IKE).

ipsecIntegrity

IpsecIntegrity

Algoritmo de integridad de IPSec (fase 1 de IKE).

pfsGroup

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 de 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 de IPSec (también denominada Modo rápido o SA de fase 2) en segundos para un túnel VPN de sitio a sitio.

ListVpnConnectionsResult

Resultado de la solicitud para enumerar todas las conexiones vpn a una puerta de enlace de VPN de virtual wan. Contiene una lista de vpn Connections y una dirección URL nextLink para obtener el siguiente conjunto de resultados.

Nombre Tipo Description
nextLink

string

Dirección URL para obtener el siguiente conjunto de resultados de la lista de operaciones si hay alguno.

value

VpnConnection[]

Lista de Connections vpn.

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 la que anunciar las rutas.

Nombre Tipo Description
ids

SubResource[]

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

SubResource

Id. de recurso RouteTable asociado a este RoutingConfiguration.

inboundRouteMap

SubResource

El identificador de recurso de RouteMap asociado a este RoutingConfiguration para las rutas aprendidas entrantes.

outboundRouteMap

SubResource

El identificador de recurso derouteMap asociado a este RoutingConfiguration para las rutas anunciadas salientes.

propagatedRouteTables

PropagatedRouteTable

Lista de RouteTables a la que anunciar las rutas.

vnetRoutes

VnetRoute

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

El 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

VnetLocalRouteOverrideCriteria

Parámetro que determina si la NVA en la red virtual de radio se omite para el tráfico con destino en radio.

SubResource

Referencia a otro subrecurso.

Nombre Tipo Description
id

string

Identificador del 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 la NVA en la red virtual de radio se omite 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

SubResource[]

Lista de referencias a objetos HubBgpConnection.

staticRoutes

StaticRoute[]

Lista de todas las rutas estáticas.

staticRoutesConfig

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 del 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

VpnConnectionStatus

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

IpsecPolicy[]

Las directivas IPSec que debe tener en cuenta esta conexión.

properties.provisioningState

ProvisioningState

Estado de aprovisionamiento del recurso de conexión VPN.

properties.remoteVpnSite

SubResource

Identificador del sitio vpn conectado.

properties.routingConfiguration

RoutingConfiguration

Configuración de enrutamiento que indica las tablas de rutas asociadas y propagadas en esta conexión.

properties.routingWeight

integer

Peso del enrutamiento de la conexión VPN.

properties.sharedKey

string

SharedKey para la conexión VPN.

properties.trafficSelectorPolicies

TrafficSelectorPolicy[]

Las directivas de 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

VirtualNetworkGatewayConnectionProtocol

Protocolo de conexión usado para esta conexión.

properties.vpnLinkConnections

VpnSiteLinkConnection[]

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 del 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

VpnConnectionStatus

Estado de conexión.

properties.egressBytesTransferred

integer

Bytes de salida transferidos.

properties.egressNatRules

SubResource[]

Lista de natrules de salida.

properties.enableBgp

boolean

Marca EnableBgp.

properties.enableRateLimiting

boolean

Marca EnableBgp.

properties.ingressBytesTransferred

integer

Bytes de entrada transferidos.

properties.ingressNatRules

SubResource[]

Lista de natRules de entrada.

properties.ipsecPolicies

IpsecPolicy[]

Las directivas IPSec que debe tener en cuenta esta conexión.

properties.provisioningState

ProvisioningState

Estado de aprovisionamiento del recurso de conexión de vínculo de sitio VPN.

properties.routingWeight

integer

Peso del enrutamiento de 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

VirtualNetworkGatewayConnectionProtocol

Protocolo de conexión usado para esta conexión.

properties.vpnGatewayCustomBgpAddresses

GatewayCustomBgpIpAddressIpConfiguration[]

vpnGatewayCustomBgpAddresses usado por esta conexión.

properties.vpnLinkConnectionMode

VpnLinkConnectionMode

Modo de conexión de vínculo vpn.

properties.vpnSiteLink

SubResource

Identificador del vínculo del sitio vpn conectado.

type

string

Tipo de recurso.