Partilhar via

az network vpn-connection

  • Referência

Gerencie conexões VPN.

Para obter mais informações sobre conexões site a site, visite https://docs.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://docs.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-vnet-vnet-cli.

Comandos

Name Description Tipo Status
az network vpn-connection create

Crie uma conexão VPN.

 Principal GA
az network vpn-connection delete

Exclua uma conexão VPN.

 Principal GA
az network vpn-connection ipsec-policy

Gerencie políticas IPSec de conexão VPN.

 Principal GA
az network vpn-connection ipsec-policy add

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

 Principal GA
az network vpn-connection ipsec-policy clear

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

 Principal GA
az network vpn-connection ipsec-policy list

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

 Principal GA
az network vpn-connection ipsec-policy wait

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

 Principal GA
az network vpn-connection list

Liste todas as conexões VPN.

 Principal GA
az network vpn-connection list-ike-sas

Liste Associações de Segurança IKE para uma conexão VPN.

 Principal Pré-visualizar
az network vpn-connection packet-capture

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

 Principal GA
az network vpn-connection packet-capture start

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

 Principal GA
az network vpn-connection packet-capture stop

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

 Principal Pré-visualizar
az network vpn-connection packet-capture wait

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

 Principal GA
az network vpn-connection shared-key

Gerencie chaves compartilhadas VPN.

 Principal GA
az network vpn-connection shared-key reset

Redefina uma chave compartilhada de conexão VPN.

 Principal GA
az network vpn-connection shared-key show

Recupere uma chave compartilhada de conexão VPN.

 Principal GA
az network vpn-connection shared-key update

Atualize uma chave compartilhada de conexão VPN.

 Principal GA
az network vpn-connection show

Obtenha os detalhes de uma conexão VPN.

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

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

 Principal Pré-visualizar
az network vpn-connection update

Atualize uma conexão VPN.

 Principal GA
az network vpn-connection wait

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

 Principal GA

az network vpn-connection create

Editar

Crie uma conexão VPN.

O Gateway 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 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 Obrigatórios

--name -n

Nome da conexão.

--resource-group -g

o 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
Pré-visualizar

Lista de NatRules de saída.

--enable-bgp

Habilite o BGP para esta conexão VPN.

Default value: False
--express-route-circuit2

Nome ou ID da Rota Expressa de destino à qual se conectar usando uma conexão 'ExpressRoute'.

--express-route-gateway-bypass

Ignore o gateway de Rota Expressa para encaminhamento de dados.

Valores aceites: false, true
--ingress-nat-rule
Pré-visualizar

Lista de ingress NatRules.

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

Default value: 10
--shared-key

Chave IPSec partilhada.

--tags

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

--use-policy-based-traffic-selectors

Habilite seletores de tráfego baseados em políticas.

Valores aceites: false, true
Default value: False
--validate

Exiba e valide o modelo ARM, mas não crie recursos.

Default value: False
--vnet-gateway2

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

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az network vpn-connection delete

Editar

Exclua 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

Exclua uma conexão VPN.

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

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome da conexão.

--no-wait

Não espere que a operação de longa duração termine.

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

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az network vpn-connection list

Editar

Liste todas as conexões VPN.

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

Exemplos

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

az network vpn-connection list -g MyResourceGroup

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

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

Parâmetros Obrigatórios

--resource-group -g

o 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 rede virtual.

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az network vpn-connection list-ike-sas

Editar
Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Liste 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

Liste 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

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome da conexão.

--no-wait

Não espere que a operação de longa duração termine.

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

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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

Veja os detalhes de uma conexão VPN.

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

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome da conexão.

--resource-group -g

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

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

Editar
Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Obtenha uma representação em formato XML para script de configuração de 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 em formato XML para script de configuração de 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 Obrigatórios

--device-family

A família de dispositivos para o dispositivo vpn.

--firmware-version

A versão de firmware para o dispositivo vpn.

--vendor

O fornecedor do dispositivo vpn.

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome da conexão.

--resource-group -g

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 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 ou JSON string>.

--enable-bgp

Habilite o BGP (Border Gateway Protocol).

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

Ignore o gateway de Rota Expressa para encaminhamento de dados.

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

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

Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome da conexão.

--no-wait

Não espere que a operação de longa duração termine.

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

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

--resource-group -g

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

--shared-key

Chave IPSec partilhada.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--use-policy-based-traffic-selectors

Habilite seletores de tráfego baseados em políticas.

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

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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'.

Default value: False
--custom

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

--deleted

Aguarde até ser excluído.

Default value: False
--exists

Aguarde até que o recurso exista.

Default value: False
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--interval

Intervalo de sondagem em segundos.

Default value: 30
--name -n

Nome da conexão.

--resource-group -g

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--timeout

Espera máxima em segundos.

Default value: 3600
--updated

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

Default value: False
Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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