Compartilhar via


az network vnet-gateway

Usar um gateway de Rede Virtual do Azure para estabelecer conectividade segura entre locais.

Para saber mais sobre os Gateways de Rede Virtual do Azure, visite https://learn.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-site-to-site-resource-manager-cli.

Comandos

Nome Description Tipo Status
az network vnet-gateway aad

Gerencie a autenticação do AAD (Azure Active Directory) de um gateway de rede virtual.

Core GA
az network vnet-gateway aad assign

Atribuir/atualizar a autenticação do AAD (Azure Active Directory) a um gateway de rede virtual.

Core GA
az network vnet-gateway aad remove

Remova a autenticação do AAD (Azure Active Directory) de um gateway de rede virtual.

Core GA
az network vnet-gateway aad show

Mostrar autenticação AAD (Azure Active Directory) de um gateway de rede virtual.

Core GA
az network vnet-gateway aad wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

Core GA
az network vnet-gateway create

Crie um gateway de rede virtual.

Core GA
az network vnet-gateway delete

Exclua um gateway de rede virtual.

Core GA
az network vnet-gateway disconnect-vpn-connections

Desconecte as conexões vpn do gateway de rede virtual.

Core Preview
az network vnet-gateway get-failover-all-tests-detail

Essa operação recupera os detalhes de todos os testes de failover executados no gateway para diferentes locais de emparelhamento.

Core GA
az network vnet-gateway get-failover-single-test-detail

Esta operação recupera os detalhes de um teste de failover específico executado no gateway com base no Guid de teste.

Core GA
az network vnet-gateway get-resiliency-information

Essa operação recupera as informações de resiliência de um Gateway de Rota Expressa, incluindo a pontuação de resiliência atual do gateway e recomendações para melhorar ainda mais a pontuação.

Core GA
az network vnet-gateway get-routes-information

Esta operação recupera as informações do conjunto de rotas para um Gateway de Rota Expressa com base em sua resiliência.

Core GA
az network vnet-gateway ipsec-policy

Gerenciar políticas IPSec do gateway de rede virtual.

Core GA
az network vnet-gateway ipsec-policy add

Adicione uma diretiva IPSec de gateway de rede virtual.

Core GA
az network vnet-gateway ipsec-policy clear

Exclua todas as políticas IPsec em um gateway de rede virtual.

Core GA
az network vnet-gateway ipsec-policy list

Listar as diretivas IPSec associadas a um gateway de rede virtual.

Core GA
az network vnet-gateway ipsec-policy wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

Core GA
az network vnet-gateway list

Listar gateways de rede virtual.

Core GA
az network vnet-gateway list-advertised-routes

Liste as rotas de um gateway de rede virtual anunciado para o par especificado.

Core GA
az network vnet-gateway list-bgp-peer-status

Recupere o status dos pares BGP.

Core GA
az network vnet-gateway list-learned-routes

Essa operação recupera uma lista de rotas que o gateway de rede virtual aprendeu, incluindo rotas aprendidas com pares BGP.

Core GA
az network vnet-gateway migration

Migre o gateway de VPN do CSES ip básico para a implantação de VMSS baseada em IP Padrão.

Core GA
az network vnet-gateway migration abort

Dispare a migração de anulação para o gateway de rede virtual.

Core GA
az network vnet-gateway migration commit

Dispare a migração de confirmação para o gateway de rede virtual.

Core GA
az network vnet-gateway migration execute

Dispare a migração de execução para o gateway de rede virtual.

Core GA
az network vnet-gateway migration prepare

Dispare a migração de preparação para o gateway de rede virtual.

Core GA
az network vnet-gateway nat-rule

Gerenciar regra nat em um gateway de rede virtual.

Core GA
az network vnet-gateway nat-rule add

Adicione a regra nat em um gateway de rede virtual.

Core Preview
az network vnet-gateway nat-rule list

Liste a regra nat para um gateway de rede virtual.

Core Preview
az network vnet-gateway nat-rule remove

Remova a regra nat de um gateway de rede virtual.

Core Preview
az network vnet-gateway nat-rule wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

Core GA
az network vnet-gateway packet-capture

Gerenciar a captura de pacotes em um gateway de rede virtual.

Core GA
az network vnet-gateway packet-capture start

Inicie a captura de pacotes em um gateway de rede virtual.

Core Preview
az network vnet-gateway packet-capture stop

Pare a captura de pacotes em um gateway de rede virtual.

Core Preview
az network vnet-gateway packet-capture wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

Core GA
az network vnet-gateway reset

Redefinir um gateway de rede virtual.

Core GA
az network vnet-gateway revoked-cert

Gerenciar certificados revogados em um gateway de rede virtual. Impedir que os computadores que usam esse certificado acessem o Azure por meio desse gateway.

Core GA
az network vnet-gateway revoked-cert create

Revogar um certificado.

Core GA
az network vnet-gateway revoked-cert delete

Exclua um certificado revogado.

Core GA
az network vnet-gateway revoked-cert wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

Core GA
az network vnet-gateway root-cert

Gerenciar certificados raiz de um gateway de rede virtual.

Core GA
az network vnet-gateway root-cert create

Faça upload de um certificado raiz.

Core GA
az network vnet-gateway root-cert delete

Exclua um certificado raiz.

Core GA
az network vnet-gateway root-cert wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

Core GA
az network vnet-gateway show

Obtenha os detalhes de um gateway de rede virtual.

Core GA
az network vnet-gateway show-supported-devices

Obtenha uma representação no formato xml para dispositivos vpn compatíveis.

Core Preview
az network vnet-gateway start-site-failover-test

Esta operação inicia a simulação de failover no gateway para o local de emparelhamento especificado.

Core GA
az network vnet-gateway stop-site-failover-test

Essa operação interrompe a simulação de failover no gateway para o local de emparelhamento especificado.

Core GA
az network vnet-gateway update

Atualize um gateway de rede virtual.

Core GA
az network vnet-gateway vpn-client

Baixe uma configuração de cliente VPN necessária para se conectar ao Azure por meio de ponto a site.

Core GA
az network vnet-gateway vpn-client generate

Gerar configuração do cliente VPN.

Core GA
az network vnet-gateway vpn-client ipsec-policy

Gerencie a conexão do cliente VPN ipsec-policy para conexão de cliente P2S do gateway de rede virtual.

Core GA
az network vnet-gateway vpn-client ipsec-policy set

Defina a política ipsec de conexão do cliente VPN por conexão de cliente P2S do gateway de rede virtual.

Core Preview
az network vnet-gateway vpn-client ipsec-policy show

Obtenha a política ipsec de conexão do cliente VPN por conexão de cliente P2S do gateway de rede virtual.

Core Preview
az network vnet-gateway vpn-client ipsec-policy wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

Core GA
az network vnet-gateway vpn-client show-health

Obtenha os detalhes de integridade da conexão do cliente VPN por conexão de cliente P2S do gateway de rede virtual.

Core Preview
az network vnet-gateway vpn-client show-url

Recupere uma configuração de cliente VPN pré-gerada.

Core GA
az network vnet-gateway wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

Core GA

az network vnet-gateway create

Crie um gateway de rede virtual.

az network vnet-gateway create --name
                               --resource-group
                               --vnet
                               [--aad-audience]
                               [--aad-issuer]
                               [--aad-tenant]
                               [--address-prefix --address-prefixes]
                               [--allow-remote-vnet-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                               [--allow-vwan-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                               [--asn]
                               [--bgp-peering-address]
                               [--client-protocol]
                               [--custom-routes]
                               [--edge-zone]
                               [--edge-zone-vnet-id]
                               [--enable-high-bandwidth --enable-high-bandwidth-vpn-gateway {0, 1, f, false, n, no, t, true, y, yes}]
                               [--enable-private-ip {0, 1, f, false, n, no, t, true, y, yes}]
                               [--gateway-default-site]
                               [--gateway-type {ExpressRoute, LocalGateway, Vpn}]
                               [--location]
                               [--max-scale-unit]
                               [--min-scale-unit]
                               [--nat-rule --nat-rules]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--peer-weight]
                               [--public-ip-address --public-ip-addresses]
                               [--radius-secret]
                               [--radius-server]
                               [--resiliency-model {MultiHomed, SingleHomed}]
                               [--root-cert-data]
                               [--root-cert-name]
                               [--sku {Basic, ErGw1AZ, ErGw2AZ, ErGw3AZ, ErGwScale, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw1AZ, VpnGw2, VpnGw2AZ, VpnGw3, VpnGw3AZ, VpnGw4, VpnGw4AZ, VpnGw5, VpnGw5AZ}]
                               [--tags]
                               [--vpn-auth-type]
                               [--vpn-gateway-generation {Generation1, Generation2, None}]
                               [--vpn-type {PolicyBased, RouteBased}]

Exemplos

Crie um gateway de rede virtual básico para conectividade site a site.

az network vnet-gateway create -g MyResourceGroup -n MyVnetGateway --public-ip-address MyGatewayIp --vnet MyVnet --gateway-type Vpn --sku VpnGw1 --vpn-type RouteBased --no-wait

Crie um gateway de rede virtual básico que forneça conectividade ponto a site com um segredo RADIUS que corresponda ao que está configurado em um servidor RADIUS.

az network vnet-gateway create -g MyResourceGroup -n MyVnetGateway --public-ip-address MyGatewayIp --vnet MyVnet --gateway-type Vpn --sku VpnGw1 --vpn-type RouteBased --address-prefixes 40.1.0.0/24 --client-protocol IkeV2 SSTP --radius-secret 111_aaa --radius-server 30.1.1.15 --vpn-gateway-generation Generation1

Criar um gateway de rede virtual básico com autenticação múltipla

az network vnet-gateway create -g MyResourceGroup -n MyVnetGateway --public-ip-address MyGatewayIp --vnet MyVnet --gateway-type Vpn --sku VpnGw1 --vpn-type RouteBased --address-prefixes 40.1.0.0/24 --client-protocol OpenVPN --radius-secret 111_aaa --radius-server 30.1.1.15 --aad-issuer https://sts.windows.net/00000-000000-00000-0000-000/ --aad-tenant https://login.microsoftonline.com/000 --aad-audience 0000-000 --root-cert-name root-cert --root-cert-data "root-cert.cer" --vpn-auth-type AAD Certificate Radius

Crie um gateway de rede virtual.

az network vnet-gateway create --gateway-type Vpn --location westus2 --name MyVnetGateway --no-wait --public-ip-addresses myVGPublicIPAddress --resource-group MyResourceGroup --sku Basic --vnet MyVnet --vpn-type PolicyBased

Parâmetros Exigidos

--name -n

Nome do gateway de VNet.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--vnet

Nome ou ID de uma rede virtual existente que tem uma sub-rede chamada 'GatewaySubnet'.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--aad-audience

A ID do AADAudience do VirtualNetworkGateway.

Propriedade Valor
Grupo de parâmetros: AAD Authentication Arguments
--aad-issuer

O URI do Emissor do AAD do VirtualNetworkGateway.

Propriedade Valor
Grupo de parâmetros: AAD Authentication Arguments
--aad-tenant

O URI do Locatário do AAD do VirtualNetworkGateway.

Propriedade Valor
Grupo de parâmetros: AAD Authentication Arguments
--address-prefix --address-prefixes

Lista separada por espaço de prefixos CIDR que representam o espaço de endereço para o Vpnclient P2S. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais. Sinalizadores singulares: --address-prefix.

Propriedade Valor
Grupo de parâmetros: VPN Client Arguments
--allow-remote-vnet-traffic

Configure esse gateway para aceitar o tráfego de outras Redes Virtuais do Azure. Essa configuração não dá suporte à conectividade com a WAN Virtual do Azure.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--allow-vwan-traffic

Configura esse gateway para aceitar o tráfego de redes wan virtuais remotas.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--asn

Número do sistema autônomo a ser usado para as configurações do BGP.

Propriedade Valor
Grupo de parâmetros: BGP Peering Arguments
--bgp-peering-address

Endereço IP a ser usado para emparelhamento BGP.

Propriedade Valor
Grupo de parâmetros: BGP Peering Arguments
--client-protocol

Protocolos a serem usados para conexão. Valores permitidos: IkeV2, OpenVPN, SSTP. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: VPN Client Arguments
--custom-routes

Lista separada por espaço de prefixos CIDR que representam o espaço de endereço de rotas personalizadas especificado pelo cliente para VpnClient. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: VPN Client Arguments
--edge-zone

O nome da zona de borda.

--edge-zone-vnet-id

A ID de recurso de vnet estendida do gateway local.

--enable-high-bandwidth --enable-high-bandwidth-vpn-gateway

Para habilitar o recurso conectividade avançada para o gateway de VPN.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--enable-private-ip

Se o IP privado precisa ser habilitado neste gateway para conexões ou não.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--gateway-default-site

Nome ou ID de um gateway de rede local que representa um site de rede local com rotas padrão.

--gateway-type

O tipo de gateway.

Propriedade Valor
Valor padrão: Vpn
Valores aceitos: ExpressRoute, LocalGateway, Vpn
--location -l

Location. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--max-scale-unit

Unidades de escala máxima para configuração de dimensionamento automático.

--min-scale-unit

Unidades de escala mínimas para configuração de dimensionamento automático.

--nat-rule --nat-rules

Recurso VirtualNetworkGatewayNatRule. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais. Sinalizadores singulares: --nat-rule.

Propriedade Valor
Grupo de parâmetros: Nat Rule Arguments
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--peer-weight

Peso (0-100) adicionado às rotas aprendidas por meio do emparelhamento BGP.

Propriedade Valor
Grupo de parâmetros: BGP Peering Arguments
--public-ip-address --public-ip-addresses

Especifique um único IP público (nome ou ID) para um gateway ativo em espera. Especifique dois IPs públicos separados por espaço para um gateway ativo-ativo. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--radius-secret

Segredo radius a ser usado para autenticação.

Propriedade Valor
Grupo de parâmetros: VPN Client Arguments
--radius-server

Endereço do servidor Radius ao qual se conectar.

Propriedade Valor
Grupo de parâmetros: VPN Client Arguments
--resiliency-model

Indica se o Gateway de Rota Expressa tem um modelo de resiliência de MultiHomed ou SingleHomed.

Propriedade Valor
Valores aceitos: MultiHomed, SingleHomed
--root-cert-data

Conteúdo base64 do arquivo de certificado raiz ou caminho do arquivo.

Propriedade Valor
Grupo de parâmetros: Root Cert Authentication Arguments
--root-cert-name

Nome do certificado raiz.

Propriedade Valor
Grupo de parâmetros: Root Cert Authentication Arguments
--sku

SKU do gateway de VNet.

Propriedade Valor
Valor padrão: Basic
Valores aceitos: Basic, ErGw1AZ, ErGw2AZ, ErGw3AZ, ErGwScale, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw1AZ, VpnGw2, VpnGw2AZ, VpnGw3, VpnGw3AZ, VpnGw4, VpnGw4AZ, VpnGw5, VpnGw5AZ
--tags

Marcas separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar marcas existentes. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--vpn-auth-type

Tipos de autenticação VPN habilitados para o gateway de rede virtual. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--vpn-gateway-generation

A geração do gateway de rede virtual. vpn_gateway_generation não deverá ser fornecido se gateway_type não for Vpn.

Propriedade Valor
Valores aceitos: Generation1, Generation2, None
--vpn-type

Tipo de roteamento VPN.

Propriedade Valor
Valor padrão: RouteBased
Valores aceitos: PolicyBased, RouteBased
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway delete

Exclua um gateway de rede virtual.

Para excluir um Gateway de Rede Virtual, primeiro você deve excluir TODOS os objetos de conexão no Azure que estão conectados ao gateway. Depois de eliminar o Gateway, prossiga para eliminar outros recursos que já não estão a ser utilizados. Para obter mais informações, siga a ordem das instruções nesta página: https://learn.microsoft.com/azure/vpn-gateway/vpn-gateway-delete-vnet-gateway-portal.

az network vnet-gateway delete [--ids]
                               [--name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--resource-group]
                               [--subscription]

Exemplos

Exclua um gateway de rede virtual.

az network vnet-gateway delete -g MyResourceGroup -n MyVnetGateway

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome do gateway de VNet.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway disconnect-vpn-connections

Versão Prévia

Esse comando está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Desconecte as conexões vpn do gateway de rede virtual.

az network vnet-gateway disconnect-vpn-connections [--ids]
                                                   [--name]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--vpn-connections]

Exemplos

Desconecte as conexões vpn do gateway de rede virtual.

az network vnet-gateway disconnect-vpn-connections -g MyResourceGroup -n MyVnetGateway --vpn-connections MyConnetion1ByName MyConnection2ByID

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome do gateway de VNet.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--vpn-connections

Lista de nome ou ID de conexões VPN. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway get-failover-all-tests-detail

Essa operação recupera os detalhes de todos os testes de failover executados no gateway para diferentes locais de emparelhamento.

az network vnet-gateway get-failover-all-tests-detail --fetch-latest {0, 1, f, false, n, no, t, true, y, yes}
                                                      --type
                                                      [--ids]
                                                      [--name --virtual-network-gateway-name]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--resource-group]
                                                      [--subscription]

Exemplos

VirtualNetworkGatewayGetFailoverAllTestsDetails

az network vnet-gateway get-failover-all-tests-detail --resource-group rg1 --virtual-network-gateway-name ergw --type SingleSiteFailover --fetch-latest true

Parâmetros Exigidos

--fetch-latest

Busque apenas os testes mais recentes para cada local de emparelhamento.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--type

O tipo de teste de failover.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name --virtual-network-gateway-name

O nome do gateway de rede virtual.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway get-failover-single-test-detail

Esta operação recupera os detalhes de um teste de failover específico executado no gateway com base no Guid de teste.

az network vnet-gateway get-failover-single-test-detail --failover-test-id
                                                        --peering-location
                                                        [--ids]
                                                        [--name --virtual-network-gateway-name]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--resource-group]
                                                        [--subscription]

Exemplos

VirtualNetworkGatewayGetFailoverSingleTestDetails

az network vnet-gateway get-failover-single-test-detail --resource-group rg1 --virtual-network-gateway-name ergw --peering-location Vancouver --failover-test-id fe458ae8-d2ae-4520-a104-44bc233bde7e

Parâmetros Exigidos

--failover-test-id

O valor exclusivo do Guid que identifica o teste.

--peering-location

Local de emparelhamento do teste.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name --virtual-network-gateway-name

O nome do gateway de rede virtual.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway get-resiliency-information

Essa operação recupera as informações de resiliência de um Gateway de Rota Expressa, incluindo a pontuação de resiliência atual do gateway e recomendações para melhorar ainda mais a pontuação.

az network vnet-gateway get-resiliency-information [--attempt-refresh {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--ids]
                                                   [--name --virtual-network-gateway-name]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--resource-group]
                                                   [--subscription]

Exemplos

GetVirtualNetworkGatewayResiliencyInformation

az network vnet-gateway get-resiliency-information --resource-group rg1 --virtual-network-gateway-name vpngw --attempt-refresh True

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--attempt-refresh

Tente recalcular as Informações de Resiliência para o gateway.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name --virtual-network-gateway-name

O nome do gateway de rede virtual.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway get-routes-information

Esta operação recupera as informações do conjunto de rotas para um Gateway de Rota Expressa com base em sua resiliência.

az network vnet-gateway get-routes-information [--attempt-refresh {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--ids]
                                               [--name --virtual-network-gateway-name]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--resource-group]
                                               [--subscription]

Exemplos

GetVirtualNetworkGatewayRoutesInformation

az network vnet-gateway get-routes-information --resource-group rg1 --virtual-network-gateway-name vpngw --attempt-refresh False

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--attempt-refresh

Tente recalcular as informações de conjuntos de rotas para o gateway.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name --virtual-network-gateway-name

O nome do gateway de rede virtual.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway list

Listar gateways de rede virtual.

az network vnet-gateway list --resource-group
                             [--max-items]
                             [--next-token]

Exemplos

Listar gateways de rede virtual em um grupo de recursos.

az network vnet-gateway list -g MyResourceGroup

Parâmetros Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token em --next-token argumento de um comando subsequente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--next-token

Token para especificar onde iniciar a paginação. Esse é o valor do token de uma resposta truncada anteriormente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway list-advertised-routes

Liste as rotas de um gateway de rede virtual anunciado para o par especificado.

az network vnet-gateway list-advertised-routes --peer
                                               [--ids]
                                               [--name]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--resource-group]
                                               [--subscription]

Exemplos

Liste as rotas de um gateway de rede virtual anunciado para o par especificado.

az network vnet-gateway list-advertised-routes -g MyResourceGroup -n MyVnetGateway --peer 23.10.10.9

Parâmetros Exigidos

--peer

O endereço IP do par.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome do gateway de VNet.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway list-bgp-peer-status

Recupere o status dos pares BGP.

az network vnet-gateway list-bgp-peer-status [--ids]
                                             [--name]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--peer]
                                             [--resource-group]
                                             [--subscription]

Exemplos

Recupere o status de um par BGP.

az network vnet-gateway list-bgp-peer-status -g MyResourceGroup -n MyVnetGateway --peer 23.10.10.9

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome do gateway de VNet.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--peer

O endereço IP do par do qual recuperar o status. O valor padrão é None.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway list-learned-routes

Essa operação recupera uma lista de rotas que o gateway de rede virtual aprendeu, incluindo rotas aprendidas com pares BGP.

az network vnet-gateway list-learned-routes [--ids]
                                            [--name]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--subscription]

Exemplos

Recupere uma lista de rotas aprendidas.

az network vnet-gateway list-learned-routes -g MyResourceGroup -n MyVnetGateway

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome do gateway de VNet.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway reset

Redefinir um gateway de rede virtual.

az network vnet-gateway reset [--gateway-vip]
                              [--ids]
                              [--name]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--resource-group]
                              [--subscription]

Exemplos

Redefinir um gateway de rede virtual.

az network vnet-gateway reset -g MyResourceGroup -n MyVnetGateway

Redefina um gateway de rede virtual com Active-Active recurso habilitado.

az network vnet-gateway reset -g MyResourceGroup -n MyVnetGateway --gateway-vip MyGatewayIP

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--gateway-vip

Endereço vip do gateway de rede virtual fornecido para iniciar a redefinição do gateway habilitado para recurso ativo-ativo.

Propriedade Valor
Valor padrão: None
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome do gateway de VNet.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway show

Obtenha os detalhes de um gateway de rede virtual.

az network vnet-gateway show [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]

Exemplos

Obtenha os detalhes de um gateway de rede virtual.

az network vnet-gateway show -g MyResourceGroup -n MyVnetGateway

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome do gateway de VNet.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway show-supported-devices

Versão Prévia

Esse comando está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Obtenha uma representação no formato xml para dispositivos vpn compatíveis.

az network vnet-gateway show-supported-devices [--ids]
                                               [--name]
                                               [--resource-group]
                                               [--subscription]

Exemplos

Obtenha uma representação no formato xml para dispositivos vpn compatíveis.

az network vnet-gateway show-supported-devices -g MyResourceGroup -n MyVnetGateway

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome do gateway de VNet.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway start-site-failover-test

Esta operação inicia a simulação de failover no gateway para o local de emparelhamento especificado.

az network vnet-gateway start-site-failover-test --peering-location
                                                 [--ids]
                                                 [--name --virtual-network-gateway-name]
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--resource-group]
                                                 [--subscription]

Exemplos

VirtualNetworkGatewayStartSiteFailoverSimulation

az network vnet-gateway start-site-failover-test --resource-group rg1 --virtual-network-gateway-name ergw --peering-location Vancouver

Parâmetros Exigidos

--peering-location

Local de emparelhamento do teste.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name --virtual-network-gateway-name

O nome do gateway de rede virtual.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway stop-site-failover-test

Essa operação interrompe a simulação de failover no gateway para o local de emparelhamento especificado.

az network vnet-gateway stop-site-failover-test [--details]
                                                [--ids]
                                                [--name --virtual-network-gateway-name]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--peering-location]
                                                [--resource-group]
                                                [--simulation-success --was-simulation-successful {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--subscription]

Exemplos

VirtualNetworkGatewayStopSiteFailoverSimulation

az network vnet-gateway stop-site-failover-test --resource-group rg1 --virtual-network-gateway-name ergw --peering-location Vancouver --was-simulation-successful True --details "[{failover-connection-name:conn1,failover-location:Denver,is-verified:False},{failover-connection-name:conn2,failover-location:Amsterdam,is-verified:True}]"

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--details

Lista de todas as conexões de failover para esse local de emparelhamento Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: StopParameters Arguments
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name --virtual-network-gateway-name

O nome do gateway de rede virtual.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--peering-location

Local de emparelhamento do teste.

Propriedade Valor
Grupo de parâmetros: StopParameters Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--simulation-success --was-simulation-successful

Se a simulação de failover foi bem-sucedida ou não.

Propriedade Valor
Grupo de parâmetros: StopParameters Arguments
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway update

Atualize um gateway de rede virtual.

az network vnet-gateway update [--aad-audience]
                               [--aad-issuer]
                               [--aad-tenant]
                               [--add]
                               [--address-prefix --address-prefixes]
                               [--allow-remote-vnet-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                               [--allow-vwan-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                               [--asn]
                               [--bgp-peering-address]
                               [--client-protocol]
                               [--custom-routes]
                               [--enable-bgp {0, 1, f, false, n, no, t, true, y, yes}]
                               [--enable-private-ip {0, 1, f, false, n, no, t, true, y, yes}]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--gateway-default-site]
                               [--gateway-type {ExpressRoute, LocalGateway, Vpn}]
                               [--ids]
                               [--max-scale-unit]
                               [--min-scale-unit]
                               [--name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--peer-weight]
                               [--public-ip-address --public-ip-addresses]
                               [--radius-secret]
                               [--radius-server]
                               [--remove]
                               [--resiliency-model {MultiHomed, SingleHomed}]
                               [--resource-group]
                               [--root-cert-data]
                               [--root-cert-name]
                               [--set]
                               [--sku {Basic, ErGw1AZ, ErGw2AZ, ErGw3AZ, ErGwScale, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw1AZ, VpnGw2, VpnGw2AZ, VpnGw3, VpnGw3AZ, VpnGw4, VpnGw4AZ, VpnGw5, VpnGw5AZ}]
                               [--subscription]
                               [--tags]
                               [--vnet]
                               [--vpn-auth-type]
                               [--vpn-type {PolicyBased, RouteBased}]

Exemplos

Altere a SKU de um gateway de rede virtual.

az network vnet-gateway update -g MyResourceGroup -n MyVnetGateway --sku VpnGw2

Atualize um gateway de rede virtual.

az network vnet-gateway update --address-prefixes 40.1.0.0/24 --client-protocol IkeV2 --name MyVnetGateway --resource-group MyResourceGroup

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--aad-audience

A ID do AADAudience do VirtualNetworkGateway.

Propriedade Valor
Grupo de parâmetros: AAD Authentication Arguments
--aad-issuer

O URI do Emissor do AAD do VirtualNetworkGateway.

Propriedade Valor
Grupo de parâmetros: AAD Authentication Arguments
--aad-tenant

O URI do Locatário do AAD do VirtualNetworkGateway.

Propriedade Valor
Grupo de parâmetros: AAD Authentication Arguments
--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--address-prefix --address-prefixes

Lista separada por espaço de prefixos CIDR que representam o espaço de endereço para o Vpnclient P2S. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais. Sinalizadores singulares: --address-prefix.

Propriedade Valor
Grupo de parâmetros: VPN Client Arguments
--allow-remote-vnet-traffic

Configure esse gateway para aceitar o tráfego de outras Redes Virtuais do Azure. Essa configuração não dá suporte à conectividade com a WAN Virtual do Azure.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--allow-vwan-traffic

Configura esse gateway para aceitar o tráfego de redes wan virtuais remotas.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--asn

Número do sistema autônomo a ser usado para as configurações do BGP.

Propriedade Valor
Grupo de parâmetros: BGP Peering Arguments
--bgp-peering-address

Endereço IP a ser usado para emparelhamento BGP.

Propriedade Valor
Grupo de parâmetros: BGP Peering Arguments
--client-protocol

Protocolos a serem usados para conexão. Valores permitidos: IkeV2, OpenVPN, SSTP. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: VPN Client Arguments
--custom-routes

Lista separada por espaço de prefixos CIDR que representam o espaço de endereço de rotas personalizadas especificado pelo cliente para VpnClient. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: VPN Client Arguments
--enable-bgp

Habilitar BGP (Border Gateway Protocol).

Propriedade Valor
Grupo de parâmetros: BGP Peering Arguments
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--enable-private-ip

Se o IP privado precisa ser habilitado neste gateway para conexões ou não.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter em JSON.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--gateway-default-site

Nome ou ID de um gateway de rede local que representa um site de rede local com rotas padrão.

--gateway-type

O tipo de gateway.

Propriedade Valor
Valores aceitos: ExpressRoute, LocalGateway, Vpn
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--max-scale-unit

Unidades de escala máxima para configuração de dimensionamento automático.

--min-scale-unit

Unidades de escala mínimas para configuração de dimensionamento automático.

--name -n

Nome do gateway de VNet.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--peer-weight

Peso (0-100) adicionado às rotas aprendidas por meio do emparelhamento BGP.

Propriedade Valor
Grupo de parâmetros: BGP Peering Arguments
--public-ip-address --public-ip-addresses

Especifique um único IP público (nome ou ID) para um gateway ativo em espera. Especifique dois IPs públicos separados por espaço para um gateway ativo-ativo. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--radius-secret

Segredo radius a ser usado para autenticação.

Propriedade Valor
Grupo de parâmetros: VPN Client Arguments
--radius-server

Endereço do servidor Radius ao qual se conectar.

Propriedade Valor
Grupo de parâmetros: VPN Client Arguments
--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--resiliency-model

Indica se o Gateway de Rota Expressa tem um modelo de resiliência de MultiHomed ou SingleHomed.

Propriedade Valor
Valores aceitos: MultiHomed, SingleHomed
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--root-cert-data

Conteúdo base64 do arquivo de certificado raiz ou caminho do arquivo.

Propriedade Valor
Grupo de parâmetros: Root Cert Authentication Arguments
--root-cert-name

Nome do certificado raiz.

Propriedade Valor
Grupo de parâmetros: Root Cert Authentication Arguments
--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--sku

SKU do gateway de VNet.

Propriedade Valor
Valores aceitos: Basic, ErGw1AZ, ErGw2AZ, ErGw3AZ, ErGwScale, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw1AZ, VpnGw2, VpnGw2AZ, VpnGw3, VpnGw3AZ, VpnGw4, VpnGw4AZ, VpnGw5, VpnGw5AZ
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--tags

Marcas separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar marcas existentes. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--vnet

Nome ou ID de uma rede virtual existente que tem uma sub-rede chamada 'GatewaySubnet'.

--vpn-auth-type

Tipos de autenticação VPN habilitados para o gateway de rede virtual. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--vpn-type

Tipo de roteamento VPN.

Propriedade Valor
Valores aceitos: PolicyBased, RouteBased
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az network vnet-gateway wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

az network vnet-gateway wait [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--name]
                             [--resource-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--custom

Aguarde até que a condição atenda a uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
--deleted

Aguarde até ser excluído.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: 30
--name -n

Nome do gateway de VNet.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--timeout

Espera máxima em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False