Compartilhar via


Vpn Connections - List By Vpn Gateway

Recupera todas as conexões vpn para um gateway de vpn de wan virtual específico.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
gatewayName
path True

string

O nome do gateway.

resourceGroupName
path True

string

O nome do grupo de recursos do VpnGateway.

subscriptionId
path True

string

As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True

string

Versão da API do cliente.

Respostas

Nome Tipo Description
200 OK

ListVpnConnectionsResult

Solicitação bem-sucedida. Retorna todas as conexões Vpn para um gateway de vpn de wan virtual.

Other Status Codes

CloudError

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

VpnConnectionList

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
CloudError

Uma resposta de erro do serviço.

CloudErrorBody

Uma resposta de erro do serviço.

DhGroup

Os grupos de DH usados na Fase 1 do IKE para SA inicial.

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration para uma conexão de gateway de rede virtual.

IkeEncryption

O algoritmo de criptografia IKE (fase 2 do IKE).

IkeIntegrity

O algoritmo de integridade IKE (fase 2 do IKE).

IpsecEncryption

O algoritmo de criptografia IPSec (fase 1 do IKE).

IpsecIntegrity

O algoritmo de integridade IPSec (IKE fase 1).

IpsecPolicy

Uma configuração de Política IPSec para uma conexão de gateway de rede virtual.

ListVpnConnectionsResult

Resultado da solicitação para listar todas as conexões vpn para um gateway de vpn de wan virtual. Ele contém uma lista de Conexões Vpn e uma URL nextLink para obter o próximo conjunto de resultados.

PfsGroup

Os Grupos de Pfs usados na Fase 2 do IKE para a NOVA SA filho.

PropagatedRouteTable

A lista de RouteTables para a qual anunciar as rotas.

ProvisioningState

O estado de provisionamento atual.

RoutingConfiguration

Configuração de roteamento que indica as tabelas de rotas associadas e propagadas para essa conexão.

StaticRoute

Lista de todas as rotas estáticas.

StaticRoutesConfig

Configuração para rotas estáticas neste HubVnetConnectionConfiguration para rotas estáticas neste HubVnetConnection.

SubResource

Referência a outro sub-recurso.

TrafficSelectorPolicy

Uma política de seletor de tráfego para uma conexão de gateway de rede virtual.

VirtualNetworkGatewayConnectionProtocol

Protocolo de conexão usado para essa conexão.

VnetLocalRouteOverrideCriteria

Parâmetro que determina se a VNET NVA no spoke é ignorada para tráfego com destino na vnet spoke.

VnetRoute

Lista de rotas que controlam o roteamento do VirtualHub para uma conexão de rede virtual.

VpnConnection

Recurso VpnConnection.

VpnConnectionStatus

O estado atual da conexão vpn.

VpnLinkConnectionMode

Modo de conexão de link vpn.

VpnSiteLinkConnection

Recurso VpnSiteLinkConnection.

CloudError

Uma resposta de erro do serviço.

Nome Tipo Description
error

CloudErrorBody

Corpo do erro de nuvem.

CloudErrorBody

Uma resposta de erro do serviço.

Nome Tipo Description
code

string

Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.

details

CloudErrorBody[]

Uma lista de detalhes adicionais sobre o erro.

message

string

Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

target

string

O destino do erro específico. Por exemplo, o nome da propriedade em erro.

DhGroup

Os grupos de DH usados na Fase 1 do IKE para SA inicial.

Valor Description
DHGroup1
DHGroup14
DHGroup2
DHGroup2048
DHGroup24
ECP256
ECP384
None

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration para uma conexão de gateway de rede virtual.

Nome Tipo Description
customBgpIpAddress

string

O BgpPeeringAddress personalizado que pertence a IpconfigurationId.

ipConfigurationId

string

A IpconfigurationId de ipconfiguration que pertence ao gateway.

IkeEncryption

O algoritmo de criptografia IKE (fase 2 do IKE).

Valor Description
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES256

IkeIntegrity

O algoritmo de integridade IKE (fase 2 do IKE).

Valor Description
GCMAES128
GCMAES256
MD5
SHA1
SHA256
SHA384

IpsecEncryption

O algoritmo de criptografia IPSec (fase 1 do IKE).

Valor Description
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES192
GCMAES256
None

IpsecIntegrity

O algoritmo de integridade IPSec (IKE fase 1).

Valor Description
GCMAES128
GCMAES192
GCMAES256
MD5
SHA1
SHA256

IpsecPolicy

Uma configuração de Política IPSec para uma conexão de gateway de rede virtual.

Nome Tipo Description
dhGroup

DhGroup

O grupo DH usado na Fase 1 do IKE para SA inicial.

ikeEncryption

IkeEncryption

O algoritmo de criptografia IKE (fase 2 do IKE).

ikeIntegrity

IkeIntegrity

O algoritmo de integridade IKE (fase 2 do IKE).

ipsecEncryption

IpsecEncryption

O algoritmo de criptografia IPSec (fase 1 do IKE).

ipsecIntegrity

IpsecIntegrity

O algoritmo de integridade IPSec (IKE fase 1).

pfsGroup

PfsGroup

O Grupo de Pfs usado na Fase 2 do IKE para a NOVA SA filho.

saDataSizeKilobytes

integer (int32)

O tamanho da carga da Associação de Segurança IPSec (também chamado de Modo Rápido ou SA fase 2) em KB para um túnel VPN site a site.

saLifeTimeSeconds

integer (int32)

A Associação de Segurança ipsec (também chamada de modo rápido ou sa fase 2) tempo de vida em segundos para um túnel VPN site a site.

ListVpnConnectionsResult

Resultado da solicitação para listar todas as conexões vpn para um gateway de vpn de wan virtual. Ele contém uma lista de Conexões Vpn e uma URL nextLink para obter o próximo conjunto de resultados.

Nome Tipo Description
nextLink

string

URL para obter o próximo conjunto de resultados da lista de operações, se houver algum.

value

VpnConnection[]

Lista de conexões vpn.

PfsGroup

Os Grupos de Pfs usados na Fase 2 do IKE para a NOVA SA filho.

Valor Description
ECP256
ECP384
None
PFS1
PFS14
PFS2
PFS2048
PFS24
PFSMM

PropagatedRouteTable

A lista de RouteTables para a qual anunciar as rotas.

Nome Tipo Description
ids

SubResource[]

A lista de IDs de recurso de todas as RouteTables.

labels

string[]

A lista de rótulos.

ProvisioningState

O estado de provisionamento atual.

Valor Description
Deleting
Failed
Succeeded
Updating

RoutingConfiguration

Configuração de roteamento que indica as tabelas de rotas associadas e propagadas para essa conexão.

Nome Tipo Description
associatedRouteTable

SubResource

A ID do recurso RouteTable associada a esse RoutingConfiguration.

inboundRouteMap

SubResource

A ID de recurso do RouteMap associado a esse RoutingConfiguration para rotas aprendidas de entrada.

outboundRouteMap

SubResource

A ID de recurso do TheRouteMap associada a esse RoutingConfiguration para rotas anunciadas de saída.

propagatedRouteTables

PropagatedRouteTable

A lista de RouteTables para a qual anunciar as rotas.

vnetRoutes

VnetRoute

Lista de rotas que controlam o roteamento do VirtualHub para uma conexão de rede virtual.

StaticRoute

Lista de todas as rotas estáticas.

Nome Tipo Description
addressPrefixes

string[]

Lista de todos os prefixos de endereço.

name

string

O nome do StaticRoute exclusivo em um VnetRoute.

nextHopIpAddress

string

O endereço ip do próximo salto.

StaticRoutesConfig

Configuração para rotas estáticas neste HubVnetConnectionConfiguration para rotas estáticas neste HubVnetConnection.

Nome Tipo Description
propagateStaticRoutes

boolean

Booliano que indica se as rotas estáticas nessa conexão são propagadas automaticamente para tabelas de rotas para as quais essa conexão se propaga.

vnetLocalRouteOverrideCriteria

VnetLocalRouteOverrideCriteria

Parâmetro que determina se a rede virtual NVA no spoke é ignorada para tráfego com destino no spoke.

SubResource

Referência a outro sub-recurso.

Nome Tipo Description
id

string

ID do recurso.

TrafficSelectorPolicy

Uma política de seletor de tráfego para uma conexão de gateway de rede virtual.

Nome Tipo Description
localAddressRanges

string[]

Uma coleção de espaços de endereço local no formato CIDR.

remoteAddressRanges

string[]

Uma coleção de espaços de endereço remoto no formato CIDR.

VirtualNetworkGatewayConnectionProtocol

Protocolo de conexão usado para essa conexão.

Valor Description
IKEv1
IKEv2

VnetLocalRouteOverrideCriteria

Parâmetro que determina se a VNET NVA no spoke é ignorada para tráfego com destino na vnet spoke.

Valor Description
Contains
Equal

VnetRoute

Lista de rotas que controlam o roteamento do VirtualHub para uma conexão de rede virtual.

Nome Tipo Description
bgpConnections

SubResource[]

A lista de referências a objetos HubBgpConnection.

staticRoutes

StaticRoute[]

Lista de todas as rotas estáticas.

staticRoutesConfig

StaticRoutesConfig

Configuração para rotas estáticas neste HubVnetConnection.

VpnConnection

Recurso VpnConnection.

Nome Tipo Description
etag

string

Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.

id

string

ID do recurso.

name

string

O nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.

properties.connectionBandwidth

integer (int32)

Largura de banda esperada no MBPS.

properties.connectionStatus

VpnConnectionStatus

O status da conexão.

properties.dpdTimeoutSeconds

integer (int32)

Tempo limite de DPD em segundos para conexão vpn.

properties.egressBytesTransferred

integer (int64)

Bytes de saída transferidos.

properties.enableBgp

boolean

Sinalizador EnableBgp.

properties.enableInternetSecurity

boolean

Habilitar a segurança da Internet.

properties.enableRateLimiting

boolean

Sinalizador EnableBgp.

properties.ingressBytesTransferred

integer (int64)

Bytes de entrada transferidos.

properties.ipsecPolicies

IpsecPolicy[]

As Políticas IPSec a serem consideradas por essa conexão.

properties.provisioningState

ProvisioningState

O estado de provisionamento do recurso de conexão VPN.

properties.remoteVpnSite

SubResource

ID do site de VPN conectado.

properties.routingConfiguration

RoutingConfiguration

A Configuração de Roteamento que indica as tabelas de rotas associadas e propagadas nessa conexão.

properties.routingWeight

integer (int32)

Peso de roteamento para conexão vpn.

properties.sharedKey

string

SharedKey para a conexão vpn.

properties.trafficSelectorPolicies

TrafficSelectorPolicy[]

As Políticas do Seletor de Tráfego a serem consideradas por essa conexão.

properties.useLocalAzureIpAddress

boolean

Use o ip do azure local para iniciar a conexão.

properties.usePolicyBasedTrafficSelectors

boolean

Habilitar seletores de tráfego baseados em política.

properties.vpnConnectionProtocolType

VirtualNetworkGatewayConnectionProtocol

Protocolo de conexão usado para essa conexão.

properties.vpnLinkConnections

VpnSiteLinkConnection[]

Lista de todas as conexões de link de site vpn para o gateway.

VpnConnectionStatus

O estado atual da conexão vpn.

Valor Description
Connected
Connecting
NotConnected
Unknown

VpnLinkConnectionMode

Modo de conexão de link vpn.

Valor Description
Default
InitiatorOnly
ResponderOnly

VpnSiteLinkConnection

Recurso VpnSiteLinkConnection.

Nome Tipo Description
etag

string

Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.

id

string

ID do recurso.

name

string

O nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.

properties.connectionBandwidth

integer (int32)

Largura de banda esperada no MBPS.

properties.connectionStatus

VpnConnectionStatus

O status da conexão.

properties.dpdTimeoutSeconds

integer (int32)

Tempo limite de Detecção de Pares Mortos em segundos para a conexão VpnLink.

properties.egressBytesTransferred

integer (int64)

Bytes de saída transferidos.

properties.egressNatRules

SubResource[]

Lista de NatRules de saída.

properties.enableBgp

boolean

Sinalizador EnableBgp.

properties.enableRateLimiting

boolean

Sinalizador EnableBgp.

properties.ingressBytesTransferred

integer (int64)

Bytes de entrada transferidos.

properties.ingressNatRules

SubResource[]

Lista de NatRules de entrada.

properties.ipsecPolicies

IpsecPolicy[]

As Políticas IPSec a serem consideradas por essa conexão.

properties.provisioningState

ProvisioningState

O estado de provisionamento do recurso de conexão de link do site VPN.

properties.routingWeight

integer (int32)

Peso de roteamento para conexão vpn.

properties.sharedKey

string

SharedKey para a conexão vpn.

properties.useLocalAzureIpAddress

boolean

Use o ip do azure local para iniciar a conexão.

properties.usePolicyBasedTrafficSelectors

boolean

Habilitar seletores de tráfego baseados em política.

properties.vpnConnectionProtocolType

VirtualNetworkGatewayConnectionProtocol

Protocolo de conexão usado para essa conexão.

properties.vpnGatewayCustomBgpAddresses

GatewayCustomBgpIpAddressIpConfiguration[]

vpnGatewayCustomBgpAddresses usados por essa conexão.

properties.vpnLinkConnectionMode

VpnLinkConnectionMode

Modo de conexão de link vpn.

properties.vpnSiteLink

SubResource

ID do link do site vpn conectado.

type

string

Tipo de recurso.