Vpn Connections - List By Vpn Gateway
Recupera todas as conexões vpn para um gateway vpn 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 do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
gateway
|
path | True |
string |
O nome do gateway. |
resource
|
path | True |
string |
O nome do grupo de recursos do VpnGateway. |
subscription
|
path | True |
string |
As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço. |
api-version
|
query | True |
string |
Versão da API do cliente. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Pedido bem-sucedido. Retorna todas as conexões Vpn para um gateway vpn wan virtual. |
|
Other Status Codes |
Resposta de erro descrevendo por que a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Ative Directory.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | personificar a sua conta de utilizador |
Exemplos
VpnConnectionList
Pedido de amostra
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections?api-version=2024-05-01
Resposta da amostra
[
{
"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
Name | Description |
---|---|
Cloud |
Uma resposta de erro do serviço. |
Cloud |
Uma resposta de erro do serviço. |
Dh |
Os Grupos DH utilizados na Fase 1 do IKE para a SA inicial. |
Gateway |
GatewayCustomBgpIpAddressIpConfiguration para uma conexão de gateway de rede virtual. |
Ike |
O algoritmo de encriptação IKE (fase 2 IKE). |
Ike |
O algoritmo de integridade IKE (fase 2 do IKE). |
Ipsec |
O algoritmo de encriptação IPSec (IKE fase 1). |
Ipsec |
O algoritmo de integridade IPSec (IKE fase 1). |
Ipsec |
Uma configuração de Diretiva IPSec para uma conexão de gateway de rede virtual. |
List |
Resultado da solicitação para listar todas as conexões vpn para um gateway vpn wan virtual. Ele contém uma lista de conexões Vpn e um URL nextLink para obter o próximo conjunto de resultados. |
Pfs |
Os Grupos Pfs usados na Fase 2 do IKE para a nova SA infantil. |
Propagated |
A lista de RouteTables para anunciar as rotas. |
Provisioning |
O estado de provisionamento atual. |
Routing |
Configuração de Roteamento indicando as tabelas de rotas associadas e propagadas para essa conexão. |
Static |
Lista de todas as rotas estáticas. |
Static |
Configuração para rotas estáticas neste HubVnetConnectionConfiguration para rotas estáticas neste HubVnetConnection. |
Sub |
Referência a outro subrecurso. |
Traffic |
Uma política de seletor de tráfego para uma conexão de gateway de rede virtual. |
Virtual |
Protocolo de conexão usado para essa conexão. |
Vnet |
Parâmetro que determina se o NVA no spoke vnet é ignorado para o tráfego com destino no spoke vnet. |
Vnet |
Lista de rotas que controlam o roteamento do VirtualHub para uma conexão de rede virtual. |
Vpn |
Recurso VpnConnection. |
Vpn |
O estado atual da conexão vpn. |
Vpn |
Modo de conexão de link vpn. |
Vpn |
Recurso VpnSiteLinkConnection. |
CloudError
Uma resposta de erro do serviço.
Name | Tipo | Description |
---|---|---|
error |
Corpo do erro na nuvem. |
CloudErrorBody
Uma resposta de erro do serviço.
Name | Tipo | Description |
---|---|---|
code |
string |
Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente. |
details |
Uma lista de detalhes adicionais sobre o erro. |
|
message |
string |
Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário. |
target |
string |
O alvo do erro específico. Por exemplo, o nome da propriedade em erro. |
DhGroup
Os Grupos DH utilizados na Fase 1 do IKE para a SA inicial.
Name | Tipo | Description |
---|---|---|
DHGroup1 |
string |
|
DHGroup14 |
string |
|
DHGroup2 |
string |
|
DHGroup2048 |
string |
|
DHGroup24 |
string |
|
ECP256 |
string |
|
ECP384 |
string |
|
None |
string |
GatewayCustomBgpIpAddressIpConfiguration
GatewayCustomBgpIpAddressIpConfiguration para uma conexão de gateway de rede virtual.
Name | Tipo | Description |
---|---|---|
customBgpIpAddress |
string |
O BgpPeeringAddress personalizado que pertence a IpconfigurationId. |
ipConfigurationId |
string |
O IpconfigurationId de ipconfiguration que pertence ao gateway. |
IkeEncryption
O algoritmo de encriptação IKE (fase 2 IKE).
Name | Tipo | Description |
---|---|---|
AES128 |
string |
|
AES192 |
string |
|
AES256 |
string |
|
DES |
string |
|
DES3 |
string |
|
GCMAES128 |
string |
|
GCMAES256 |
string |
IkeIntegrity
O algoritmo de integridade IKE (fase 2 do IKE).
Name | Tipo | Description |
---|---|---|
GCMAES128 |
string |
|
GCMAES256 |
string |
|
MD5 |
string |
|
SHA1 |
string |
|
SHA256 |
string |
|
SHA384 |
string |
IpsecEncryption
O algoritmo de encriptação IPSec (IKE fase 1).
Name | Tipo | Description |
---|---|---|
AES128 |
string |
|
AES192 |
string |
|
AES256 |
string |
|
DES |
string |
|
DES3 |
string |
|
GCMAES128 |
string |
|
GCMAES192 |
string |
|
GCMAES256 |
string |
|
None |
string |
IpsecIntegrity
O algoritmo de integridade IPSec (IKE fase 1).
Name | Tipo | Description |
---|---|---|
GCMAES128 |
string |
|
GCMAES192 |
string |
|
GCMAES256 |
string |
|
MD5 |
string |
|
SHA1 |
string |
|
SHA256 |
string |
IpsecPolicy
Uma configuração de Diretiva IPSec para uma conexão de gateway de rede virtual.
Name | Tipo | Description |
---|---|---|
dhGroup |
O Grupo DH utilizado na Fase 1 do IKE para a SA inicial. |
|
ikeEncryption |
O algoritmo de encriptação IKE (fase 2 IKE). |
|
ikeIntegrity |
O algoritmo de integridade IKE (fase 2 do IKE). |
|
ipsecEncryption |
O algoritmo de encriptação IPSec (IKE fase 1). |
|
ipsecIntegrity |
O algoritmo de integridade IPSec (IKE fase 1). |
|
pfsGroup |
O Grupo Pfs usado na Fase 2 do IKE para a nova criança SA. |
|
saDataSizeKilobytes |
integer |
O tamanho da carga útil da Associação de Segurança IPSec (também chamada de Modo Rápido ou SA de Fase 2) em KB para um túnel VPN site a site. |
saLifeTimeSeconds |
integer |
O tempo de vida da Associação de Segurança IPSec (também chamado de Modo Rápido ou SA de Fase 2) é executado 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 vpn wan virtual. Ele contém uma lista de conexões Vpn e um URL nextLink para obter o próximo conjunto de resultados.
Name | Tipo | Description |
---|---|---|
nextLink |
string |
URL para obter o próximo conjunto de resultados da lista de operações, se houver. |
value |
Lista de conexões vpn. |
PfsGroup
Os Grupos Pfs usados na Fase 2 do IKE para a nova SA infantil.
Name | Tipo | Description |
---|---|---|
ECP256 |
string |
|
ECP384 |
string |
|
None |
string |
|
PFS1 |
string |
|
PFS14 |
string |
|
PFS2 |
string |
|
PFS2048 |
string |
|
PFS24 |
string |
|
PFSMM |
string |
PropagatedRouteTable
A lista de RouteTables para anunciar as rotas.
Name | Tipo | Description |
---|---|---|
ids |
A lista de ids de recursos de todas as RouteTables. |
|
labels |
string[] |
A lista de rótulos. |
ProvisioningState
O estado de provisionamento atual.
Name | Tipo | Description |
---|---|---|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
RoutingConfiguration
Configuração de Roteamento indicando as tabelas de rotas associadas e propagadas para essa conexão.
Name | Tipo | Description |
---|---|---|
associatedRouteTable |
A id do recurso RouteTable associada a esta RoutingConfiguration. |
|
inboundRouteMap |
A id de recurso do RouteMap associada a esta RoutingConfiguration para rotas aprendidas de entrada. |
|
outboundRouteMap |
A id de recurso do RouteMap associada a esta RoutingConfiguration para rotas anunciadas de saída. |
|
propagatedRouteTables |
A lista de RouteTables para anunciar as rotas. |
|
vnetRoutes |
Lista de rotas que controlam o roteamento do VirtualHub para uma conexão de rede virtual. |
StaticRoute
Lista de todas as rotas estáticas.
Name | Tipo | Description |
---|---|---|
addressPrefixes |
string[] |
Lista de todos os prefixos de endereço. |
name |
string |
O nome do StaticRoute que é exclusivo dentro de 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.
Name | Tipo | Description |
---|---|---|
propagateStaticRoutes |
boolean |
Booleano indicando se as rotas estáticas nesta conexão são propagadas automaticamente para tabelas de rotas para as quais essa conexão se propaga. |
vnetLocalRouteOverrideCriteria |
Parâmetro que determina se o NVA na vnet spoke é ignorado para o tráfego com destino em spoke. |
SubResource
Referência a outro subrecurso.
Name | 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.
Name | 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.
Name | Tipo | Description |
---|---|---|
IKEv1 |
string |
|
IKEv2 |
string |
VnetLocalRouteOverrideCriteria
Parâmetro que determina se o NVA no spoke vnet é ignorado para o tráfego com destino no spoke vnet.
Name | Tipo | Description |
---|---|---|
Contains |
string |
|
Equal |
string |
VnetRoute
Lista de rotas que controlam o roteamento do VirtualHub para uma conexão de rede virtual.
Name | Tipo | Description |
---|---|---|
bgpConnections |
A lista de referências a objetos HubBgpConnection. |
|
staticRoutes |
Lista de todas as rotas estáticas. |
|
staticRoutesConfig |
Configuração para rotas estáticas neste HubVnetConnection. |
VpnConnection
Recurso VpnConnection.
Name | Tipo | Description |
---|---|---|
etag |
string |
Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado. |
id |
string |
ID do recurso. |
name |
string |
O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. |
properties.connectionBandwidth |
integer |
Largura de banda esperada em MBPS. |
properties.connectionStatus |
O status da conexão. |
|
properties.dpdTimeoutSeconds |
integer |
Tempo limite do DPD em segundos para conexão vpn. |
properties.egressBytesTransferred |
integer |
Bytes de saída transferidos. |
properties.enableBgp |
boolean |
Sinalizador EnableBgp. |
properties.enableInternetSecurity |
boolean |
Habilite a segurança na Internet. |
properties.enableRateLimiting |
boolean |
Sinalizador EnableBgp. |
properties.ingressBytesTransferred |
integer |
Entrada de bytes transferidos. |
properties.ipsecPolicies |
As políticas IPSec a serem consideradas por esta ligação. |
|
properties.provisioningState |
O estado de provisionamento do recurso de conexão VPN. |
|
properties.remoteVpnSite |
ID do site vpn conectado. |
|
properties.routingConfiguration |
A Configuração de Roteamento indica as tabelas de rotas associadas e propagadas nessa conexão. |
|
properties.routingWeight |
integer |
Peso de roteamento para conexão vpn. |
properties.sharedKey |
string |
SharedKey para a conexão vpn. |
properties.trafficSelectorPolicies |
As Políticas do Seletor de Tráfego a serem consideradas por essa conexão. |
|
properties.useLocalAzureIpAddress |
boolean |
Use o azure ip local para iniciar a conexão. |
properties.usePolicyBasedTrafficSelectors |
boolean |
Habilite seletores de tráfego baseados em políticas. |
properties.vpnConnectionProtocolType |
Protocolo de conexão usado para essa conexão. |
|
properties.vpnLinkConnections |
Lista de todas as conexões de link de site vpn para o gateway. |
VpnConnectionStatus
O estado atual da conexão vpn.
Name | Tipo | Description |
---|---|---|
Connected |
string |
|
Connecting |
string |
|
NotConnected |
string |
|
Unknown |
string |
VpnLinkConnectionMode
Modo de conexão de link vpn.
Name | Tipo | Description |
---|---|---|
Default |
string |
|
InitiatorOnly |
string |
|
ResponderOnly |
string |
VpnSiteLinkConnection
Recurso VpnSiteLinkConnection.
Name | Tipo | Description |
---|---|---|
etag |
string |
Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado. |
id |
string |
ID do recurso. |
name |
string |
O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. |
properties.connectionBandwidth |
integer |
Largura de banda esperada em MBPS. |
properties.connectionStatus |
O status da conexão. |
|
properties.dpdTimeoutSeconds |
integer |
Tempo limite de deteção de peer inativo em segundos para conexão VpnLink. |
properties.egressBytesTransferred |
integer |
Bytes de saída transferidos. |
properties.egressNatRules |
Lista de NatRules de saída. |
|
properties.enableBgp |
boolean |
Sinalizador EnableBgp. |
properties.enableRateLimiting |
boolean |
Sinalizador EnableBgp. |
properties.ingressBytesTransferred |
integer |
Entrada de bytes transferidos. |
properties.ingressNatRules |
Lista de ingress NatRules. |
|
properties.ipsecPolicies |
As políticas IPSec a serem consideradas por esta ligação. |
|
properties.provisioningState |
O estado de provisionamento do recurso de conexão de link de site VPN. |
|
properties.routingWeight |
integer |
Peso de roteamento para conexão vpn. |
properties.sharedKey |
string |
SharedKey para a conexão vpn. |
properties.useLocalAzureIpAddress |
boolean |
Use o azure ip local para iniciar a conexão. |
properties.usePolicyBasedTrafficSelectors |
boolean |
Habilite seletores de tráfego baseados em políticas. |
properties.vpnConnectionProtocolType |
Protocolo de conexão usado para essa conexão. |
|
properties.vpnGatewayCustomBgpAddresses |
vpnGatewayCustomBgpAddresses usado por esta conexão. |
|
properties.vpnLinkConnectionMode |
Modo de conexão de link vpn. |
|
properties.vpnSiteLink |
ID do link do site vpn conectado. |
|
type |
string |
Tipo de recurso. |