Compartilhar via


Vpn Gateways - Reset

Redefine o primário do gateway de VPN no grupo de recursos especificado.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/reset?api-version=2024-05-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/reset?ipConfigurationId={ipConfigurationId}&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.

ipConfigurationId
query

string

VpnGateway ipConfigurationId para especificar a instância do gateway.

Respostas

Nome Tipo Description
200 OK

VpnGateway

Solicitação bem-sucedida. A operação redefine o primário do VpnGateway.

202 Accepted

Aceito e a operação será concluída de forma assíncrona.

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

ResetVpnGateway

Solicitação de exemplo

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw/reset?api-version=2024-05-01

Resposta de exemplo

location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}
{
  "name": "vpngw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "type": "Microsoft.Network/vpnGateways",
  "properties": {
    "provisioningState": "Succeeded",
    "virtualHub": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
    },
    "connections": [
      {
        "name": "vpnConnection1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw/vpnConnections/vpnConnection1",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "properties": {
          "provisioningState": "Succeeded",
          "remoteVpnSite": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
          },
          "connectionStatus": "Connected",
          "ingressBytesTransferred": 0,
          "egressBytesTransferred": 0,
          "routingWeight": 0,
          "connectionBandwidth": 100,
          "sharedKey": "key",
          "enableBgp": false,
          "useLocalAzureIpAddress": false,
          "ipsecPolicies": [],
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
            },
            "propagatedRouteTables": {
              "labels": [
                "label1",
                "label2"
              ],
              "ids": [
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
                },
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2"
                },
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3"
                }
              ]
            },
            "vnetRoutes": {
              "staticRoutes": []
            }
          }
        }
      }
    ],
    "bgpSettings": {
      "asn": 65514,
      "bgpPeeringAddress": "10.0.1.30",
      "peerWeight": 0,
      "bgpPeeringAddresses": [
        {
          "ipconfigurationId": "Instance0",
          "defaultBgpIpAddresses": [
            "10.30.0.4"
          ],
          "customBgpIpAddresses": [
            "169.254.21.5"
          ],
          "tunnelIpAddresses": [
            "104.208.48.178"
          ]
        },
        {
          "ipconfigurationId": "Instance1",
          "defaultBgpIpAddresses": [
            "10.30.0.5"
          ],
          "customBgpIpAddresses": [
            "169.254.21.10"
          ],
          "tunnelIpAddresses": [
            "104.208.48.179"
          ]
        }
      ]
    },
    "natRules": [],
    "isRoutingPreferenceInternet": false,
    "enableBgpRouteTranslationForNat": false
  }
}

Definições

Nome Description
BgpSettings

Detalhes das configurações do BGP.

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).

IPConfigurationBgpPeeringAddress

Propriedades de IPConfigurationBgpPeeringAddress.

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.

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.

VpnGateway

Recurso vpnGateway.

VpnGatewayIpConfiguration

Configuração de IP de um recurso de gateway de VPN.

VpnGatewayNatRule

Recurso VpnGatewayNatRule.

VpnLinkConnectionMode

Modo de conexão de link vpn.

VpnNatRuleMapping

Mapeamento do NatRule de Vpn.

VpnNatRuleMode

A direção nat de origem de um NAT VPN.

VpnNatRuleType

O tipo de regra NAT para VPN NAT.

VpnSiteLinkConnection

Recurso VpnSiteLinkConnection.

BgpSettings

Detalhes das configurações do BGP.

Nome Tipo Description
asn

integer

O ASN do alto-falante BGP.

bgpPeeringAddress

string

O endereço de emparelhamento BGP e o identificador BGP desse alto-falante BGP.

bgpPeeringAddresses

IPConfigurationBgpPeeringAddress[]

Endereço de emparelhamento BGP com ID de configuração de IP para gateway de rede virtual.

peerWeight

integer

O peso adicionado às rotas aprendidas com esse alto-falante BGP.

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.

Nome 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.

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).

Nome 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).

Nome Tipo Description
GCMAES128

string

GCMAES256

string

MD5

string

SHA1

string

SHA256

string

SHA384

string

IPConfigurationBgpPeeringAddress

Propriedades de IPConfigurationBgpPeeringAddress.

Nome Tipo Description
customBgpIpAddresses

string[]

A lista de endereços de emparelhamento BGP personalizados que pertencem à configuração de IP.

defaultBgpIpAddresses

string[]

A lista de endereços de emparelhamento BGP padrão que pertencem à configuração de IP.

ipconfigurationId

string

A ID da configuração de IP que pertence ao gateway.

tunnelIpAddresses

string[]

A lista de endereços IP públicos do túnel que pertencem à configuração de IP.

IpsecEncryption

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

Nome 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).

Nome Tipo Description
GCMAES128

string

GCMAES192

string

GCMAES256

string

MD5

string

SHA1

string

SHA256

string

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

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

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.

PfsGroup

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

Nome 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 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.

Nome Tipo Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

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.

Nome Tipo Description
IKEv1

string

IKEv2

string

VnetLocalRouteOverrideCriteria

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

Nome Tipo Description
Contains

string

Equal

string

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

Largura de banda esperada no MBPS.

properties.connectionStatus

VpnConnectionStatus

O status da conexão.

properties.dpdTimeoutSeconds

integer

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

properties.egressBytesTransferred

integer

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

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

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.

Nome Tipo Description
Connected

string

Connecting

string

NotConnected

string

Unknown

string

VpnGateway

Recurso vpnGateway.

Nome Tipo Description
etag

string

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

id

string

ID do recurso.

location

string

Local do recurso.

name

string

Nome do recurso.

properties.bgpSettings

BgpSettings

Configurações do alto-falante BGP do gateway de rede local.

properties.connections

VpnConnection[]

Lista de todas as conexões vpn com o gateway.

properties.enableBgpRouteTranslationForNat

boolean

Habilite a tradução de rotas BGP para NAT neste VpnGateway.

properties.ipConfigurations

VpnGatewayIpConfiguration[]

Lista de todos os IPs configurados no gateway.

properties.isRoutingPreferenceInternet

boolean

Habilite a propriedade Preferência de Roteamento para a Interface ip pública do VpnGateway.

properties.natRules

VpnGatewayNatRule[]

Lista de todas as regras nat associadas ao gateway.

properties.provisioningState

ProvisioningState

O estado de provisionamento do recurso de gateway de VPN.

properties.virtualHub

SubResource

O VirtualHub ao qual o gateway pertence.

properties.vpnGatewayScaleUnit

integer

A unidade de escala para esse gateway de VPN.

tags

object

Marcas de recurso.

type

string

Tipo de recurso.

VpnGatewayIpConfiguration

Configuração de IP de um recurso de gateway de VPN.

Nome Tipo Description
id

string

O identificador da configuração de IP para um Gateway de VPN.

privateIpAddress

string

O endereço IP privado dessa configuração de IP.

publicIpAddress

string

O endereço IP público dessa configuração de IP.

VpnGatewayNatRule

Recurso VpnGatewayNatRule.

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.egressVpnSiteLinkConnections

SubResource[]

Lista de VpnSiteLinkConnections de saída.

properties.externalMappings

VpnNatRuleMapping[]

O mapeamento externo de endereço IP privado para NAT.

properties.ingressVpnSiteLinkConnections

SubResource[]

Lista de vpnSiteLinkConnections de entrada.

properties.internalMappings

VpnNatRuleMapping[]

O mapeamento interno do endereço IP privado para NAT.

properties.ipConfigurationId

string

A ID de Configuração de IP à qual essa regra NAT se aplica.

properties.mode

VpnNatRuleMode

A direção nat de origem de um NAT VPN.

properties.provisioningState

ProvisioningState

O estado de provisionamento do recurso de regra NAT.

properties.type

VpnNatRuleType

O tipo de regra NAT para VPN NAT.

type

string

Tipo de recurso.

VpnLinkConnectionMode

Modo de conexão de link vpn.

Nome Tipo Description
Default

string

InitiatorOnly

string

ResponderOnly

string

VpnNatRuleMapping

Mapeamento do NatRule de Vpn.

Nome Tipo Description
addressSpace

string

Espaço de endereço para mapeamento de NatRule vpn.

portRange

string

Intervalo de portas para mapeamento de NatRule de Vpn.

VpnNatRuleMode

A direção nat de origem de um NAT VPN.

Nome Tipo Description
EgressSnat

string

IngressSnat

string

VpnNatRuleType

O tipo de regra NAT para VPN NAT.

Nome Tipo Description
Dynamic

string

Static

string

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

Largura de banda esperada no MBPS.

properties.connectionStatus

VpnConnectionStatus

O status da conexão.

properties.dpdTimeoutSeconds

integer

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

properties.egressBytesTransferred

integer

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

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

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.