Compartilhar via

az network vpn-connection

  • Referência

Gerenciar conexões VPN.

Para obter mais informações sobre conexões site a site, visite https://learn.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-site-to-site-resource-manager-cli. Para obter mais informações sobre conexões Vnet-to-Vnet, visite https://learn.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-vnet-vnet-cli.

Comandos

Nome Description Tipo Status
az network vpn-connection create

Crie uma conexão VPN.

 Núcleo GA
az network vpn-connection delete

Excluir uma conexão VPN.

 Núcleo GA
az network vpn-connection ipsec-policy

Gerenciar políticas IPSec de conexão VPN.

 Núcleo GA
az network vpn-connection ipsec-policy add

Adicione uma política IPSec de conexão VPN.

 Núcleo GA
az network vpn-connection ipsec-policy clear

Exclua todas as políticas IPsec em uma conexão VPN.

 Núcleo GA
az network vpn-connection ipsec-policy list

Listar políticas IPSec associadas a uma conexão VPN.

 Núcleo GA
az network vpn-connection ipsec-policy wait

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

 Núcleo GA
az network vpn-connection list

Listar todas as conexões VPN.

 Núcleo GA
az network vpn-connection list-ike-sas

Listar associações de segurança IKE para uma conexão VPN.

 Núcleo Visualizar
az network vpn-connection packet-capture

Gerenciar a captura de pacotes em uma conexão VPN.

 Núcleo GA
az network vpn-connection packet-capture start

Inicie a captura de pacotes em uma conexão VPN.

 Núcleo GA
az network vpn-connection packet-capture stop

Interromper a captura de pacotes em uma conexão VPN.

 Núcleo Visualizar
az network vpn-connection packet-capture wait

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

 Núcleo GA
az network vpn-connection shared-key

Gerenciar chaves compartilhadas VPN.

 Núcleo GA
az network vpn-connection shared-key reset

Redefina uma chave compartilhada de conexão VPN.

 Núcleo GA
az network vpn-connection shared-key show

Recuperar uma chave compartilhada de conexão VPN.

 Núcleo GA
az network vpn-connection shared-key update

Atualize uma chave compartilhada de conexão VPN.

 Núcleo GA
az network vpn-connection show

Obtenha os detalhes de uma conexão VPN.

 Núcleo GA
az network vpn-connection show-device-config-script

Obtenha uma representação de formato XML para o script de configuração do dispositivo de conexão VPN.

 Núcleo Visualizar
az network vpn-connection update

Atualize uma conexão VPN.

 Núcleo GA
az network vpn-connection wait

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

 Núcleo GA

az network vpn-connection create

Editar

Crie uma conexão VPN.

O Gateway de VPN e o Gateway de Rede Local devem ser provisionados antes de criar a conexão entre eles.

az network vpn-connection create --name
                                 --resource-group
                                 --vnet-gateway1
                                 [--authorization-key]
                                 [--egress-nat-rule]
                                 [--enable-bgp]
                                 [--express-route-circuit2]
                                 [--express-route-gateway-bypass {false, true}]
                                 [--ingress-nat-rule]
                                 [--local-gateway2]
                                 [--location]
                                 [--routing-weight]
                                 [--shared-key]
                                 [--tags]
                                 [--use-policy-based-traffic-selectors {false, true}]
                                 [--validate]
                                 [--vnet-gateway2]

Exemplos

Crie uma conexão site a site entre uma rede virtual do Azure e um gateway de rede local.

az network vpn-connection create -g MyResourceGroup -n MyConnection --vnet-gateway1 MyVnetGateway --local-gateway2 MyLocalGateway --shared-key Abc123

Crie uma conexão VPN com --ingress-nat-rule.

az network vpn-connection create -g MyResourceGroup -n MyConnection --vnet-gateway1 MyVnetGateway --local-gateway2 MyLocalGateway --shared-key Abc123 --ingress-nat-rule /subscriptions/000/resourceGroups/TestBGPRG1/providers/Microsoft.Network/virtualNetworkGateways/gwx/natRules/nat

Crie uma conexão VPN. (gerado automaticamente)

az network vpn-connection create --location westus2 --name MyConnection --resource-group MyResourceGroup --shared-key Abc123 --vnet-gateway1 MyVnetGateway --vnet-gateway2 /subscriptions/{subscriptionID}/resourceGroups/TestBGPRG1/providers/Microsoft.Network/virtualNetworkGateways/VNet1GW

Crie uma conexão VPN. (gerado automaticamente)

az network vpn-connection create --local-gateway2 MyLocalGateway --location westus2 --name MyConnection --resource-group MyResourceGroup --shared-key Abc123 --vnet-gateway1 MyVnetGateway

Parâmetros Exigidos

--name -n

Nome da conexão.

--resource-group -g

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

--vnet-gateway1

Nome ou ID do gateway de rede virtual de origem.

Parâmetros Opcionais

--authorization-key

A chave de autorização para a conexão VPN.

--egress-nat-rule
Versão Prévia

Lista de NatRules de saída.

--enable-bgp

Habilite o BGP para essa conexão VPN.

Valor padrão: False
--express-route-circuit2

Nome ou ID do ExpressRoute de destino ao qual se conectar usando uma conexão 'ExpressRoute'.

--express-route-gateway-bypass

Ignorar o gateway do ExpressRoute para encaminhamento de dados.

Valores aceitos: false, true
--ingress-nat-rule
Versão Prévia

Lista de NatRules de entrada.

--local-gateway2

Nome ou ID do gateway de rede local de destino ao qual se conectar usando uma conexão 'IPSec'.

--location -l

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

--routing-weight

Peso do roteamento de conexão.

Valor padrão: 10
--shared-key

Chave IPSec compartilhada.

--tags

Marcas separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar marcas existentes.

--use-policy-based-traffic-selectors

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

Valores aceitos: false, true
Valor padrão: False
--validate

Exiba e valide o modelo do ARM, mas não crie nenhum recurso.

Valor padrão: False
--vnet-gateway2

Nome ou ID do gateway de rede virtual de destino ao qual se conectar usando uma conexão 'Vnet2Vnet'.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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.

az network vpn-connection delete

Editar

Excluir uma conexão VPN.

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

Exemplos

Excluir uma conexão VPN.

az network vpn-connection delete -g MyResourceGroup -n MyConnection

Parâmetros Opcionais

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

--name -n

Nome da conexão.

--no-wait

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

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

--subscription

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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.

az network vpn-connection list

Editar

Listar todas as conexões VPN.

az network vpn-connection list --resource-group
                               [--vnet-gateway]

Exemplos

Listar todas as conexões VPN em um grupo de recursos.

az network vpn-connection list -g MyResourceGroup

Lista todas as conexões VPN em um gateway de rede virtual.

az network vpn-connection list -g MyResourceGroup --vnet-gateway MyVnetGateway

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

--vnet-gateway

Nome do gateway de VNet.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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.

az network vpn-connection list-ike-sas

Editar
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

Listar associações de segurança IKE para uma conexão VPN.

az network vpn-connection list-ike-sas [--ids]
                                       [--name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]

Exemplos

Listar associações de segurança IKE para uma conexão VPN.

az network vpn-connection list-ike-sas -g MyResourceGroup -n MyConnection

Parâmetros Opcionais

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

--name -n

Nome da conexão.

--no-wait

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

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

--subscription

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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.

az network vpn-connection show

Editar

Obtenha os detalhes de uma conexão VPN.

az network vpn-connection show [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]

Exemplos

Exiba os detalhes de uma conexão VPN.

az network vpn-connection show -g MyResourceGroup -n MyConnection

Parâmetros Opcionais

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

--name -n

Nome da conexão.

--resource-group -g

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

--subscription

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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.

az network vpn-connection show-device-config-script

Editar
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 de formato XML para o script de configuração do dispositivo de conexão VPN.

az network vpn-connection show-device-config-script --device-family
                                                    --firmware-version
                                                    --vendor
                                                    [--ids]
                                                    [--name]
                                                    [--resource-group]
                                                    [--subscription]

Exemplos

Obtenha uma representação de formato XML para o script de configuração do dispositivo de conexão VPN.

az network vpn-connection show-device-config-script -g MyResourceGroup -n MyConnection --vendor "Cisco" --device-family "Cisco-ISR(IOS)" --firmware-version "Cisco-ISR-15.x-- IKEv2+BGP"

Parâmetros Exigidos

--device-family

A família de dispositivos para o dispositivo vpn.

--firmware-version

A versão do firmware para o dispositivo vpn.

--vendor

O fornecedor do dispositivo vpn.

Parâmetros Opcionais

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

--name -n

Nome da conexão.

--resource-group -g

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

--subscription

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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.

az network vpn-connection update

Editar

Atualize uma conexão VPN.

az network vpn-connection update [--add]
                                 [--enable-bgp {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--express-route-gateway-bypass {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--ids]
                                 [--name]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--remove]
                                 [--resource-group]
                                 [--routing-weight]
                                 [--set]
                                 [--shared-key]
                                 [--subscription]
                                 [--tags]
                                 [--use-policy-based-traffic-selectors {0, 1, f, false, n, no, t, true, y, yes}]

Exemplos

Adicione o BGP a uma conexão existente.

az network vpn-connection update -g MyResourceGroup -n MyConnection --enable-bgp True

Atualize uma conexão VPN.

az network vpn-connection update --name MyConnection --resource-group MyResourceGroup --use-policy-based-traffic-selectors true

Parâmetros Opcionais

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

--enable-bgp

Habilitar BGP (Border Gateway Protocol).

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--express-route-gateway-bypass

Ignorar o gateway do ExpressRoute para encaminhamento de dados.

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.

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

--name -n

Nome da conexão.

--no-wait

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

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--remove

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

--resource-group -g

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

--routing-weight

Peso do roteamento de conexão.

--set

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

--shared-key

Chave IPSec compartilhada.

--subscription

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

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

--use-policy-based-traffic-selectors

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

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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.

az network vpn-connection wait

Editar

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

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

Parâmetros Opcionais

--created

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

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'].

--deleted

Aguarde até ser excluído.

Valor padrão: False
--exists

Aguarde até que o recurso exista.

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

--interval

Intervalo de sondagem em segundos.

Valor padrão: 30
--name -n

Nome da conexão.

--resource-group -g

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

--subscription

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

--timeout

Espera máxima em segundos.

Valor padrão: 3600
--updated

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

Valor padrão: False
Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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.