Compartilhar via

az ssh

Note

Essa referência faz parte da extensão ssh da CLI do Azure (versão 2.45.0 ou superior). A extensão instalará automaticamente na primeira vez que você executar um comando az ssh . Saiba mais sobre extensões.

SSH em recursos (VMs do Azure, servidores Arc etc.) usando certificados openssh emitidos pelo AAD.

SSH em servidores habilitados para Arc sem exigir um endereço IP público ou SSH em Máquinas Virtuais do Azure. O AAD emitiu certificados openssh para autenticação atualmente com suporte apenas para Linux.

Comandos

Nome Description Tipo Status
az ssh arc

SSH nos Servidores do Azure Arc.

 Extension GA
az ssh cert

Crie um certificado RSA SSH assinado pelo AAD.

 Extension GA
az ssh config

Crie uma configuração SSH para recursos (VMs do Azure, Servidores Arc etc. ) que podem ser usados por clientes que dão suporte a configurações e certificados OpenSSH.

 Extension GA
az ssh vm

SSH em VMs do Azure ou servidores Arc.

 Extension GA

az ssh arc

SSH nos Servidores do Azure Arc.

Os usuários podem fazer logon usando certificados emitidos pelo AAD ou usando credenciais de usuário local. É recomendável fazer logon usando certificados emitidos pelo AAD. Para SSH usando credenciais de usuário local, você deve fornecer o nome de usuário local usando o parâmetro --local-user.

az ssh arc [--certificate-file]
           [--local-user]
           [--name --vm-name]
           [--port]
           [--private-key-file]
           [--public-key-file]
           [--rdp --winrdp]
           [--resource-group]
           [--resource-type]
           [--ssh-client-folder]
           [--ssh-proxy-folder]
           [--yes --yes-without-prompt]
           []

Exemplos

Dar um nome de grupo de recursos e um nome de computador ao SSH usando certificados emitidos pelo AAD

az ssh arc --resource-group myResourceGroup --name myMachine

Usando um arquivo de chave privada personalizado

az ssh arc --resource-group myResourceGroup --name myMachine --private-key-file key --public-key-file key.pub

Usando argumentos ssh adicionais

az ssh arc --resource-group myResourceGroup --name myMachine -- -A -o ForwardX11=yes

Dê um nome de usuário local ao SSH com credenciais de usuário local usando a autenticação baseada em certificado.

az ssh arc --local-user username --resource-group myResourceGroup --name myMachine --certificate-file cert.pub --private-key-file key

Dê um nome de usuário local ao SSH com credenciais de usuário local usando a autenticação baseada em chave.

az ssh arc --local-user username --resource-group myResourceGroup --name myMachine --private-key-file key

Dê um nome de usuário local ao SSH com credenciais de usuário local usando a autenticação baseada em senha.

az ssh arc --local-user username --resource-group myResourceGroup --name myMachine

Forneça uma pasta de cliente SSH para usar os executáveis ssh nessa pasta, como ssh-keygen.exe e ssh.exe. Se não for fornecido, a extensão tentará usar o cliente OpenSSH pré-instalado (no Windows, a extensão procura executáveis pré-instalados em C:\Windows\System32\OpenSSH).

az ssh arc --resource-group myResourceGroup --name myMachine --ssh-client-folder "C:\Program Files\OpenSSH"

Abra a conexão RDP por SSH. Útil para se conectar via RDP a servidores Arc sem endereço IP público. Atualmente, só há suporte para clientes Windows.

az ssh arc --resource-group myResourceGroup --name myVM --local-user username --rdp

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.

--certificate-file -c

Caminho para o arquivo de certificado.

--local-user

O nome de usuário de um usuário local.

--name --vm-name -n

O nome do Servidor Arc.

--port

Porta à qual se conectar no host remoto.

--private-key-file -i

O caminho do arquivo de chave privada RSA.

--public-key-file -p

O caminho do arquivo de chave pública RSA.

--rdp --winrdp

Inicie a conexão RDP por SSH.

Propriedade Valor
Valor padrão: False
--resource-group -g

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

--resource-type

O tipo de recurso deve ser Microsoft.HybridCompute/machines ou Microsoft.ConnectedVMwareSphere/virtualMachines.

--ssh-client-folder

Caminho da pasta que contém executáveis ssh (ssh.exe, ssh-keygen.exe, etc. Padrão para ssh pré-instalado se não for fornecido.

--ssh-proxy-folder

Caminho para a pasta em que o proxy ssh deve ser salvo. Padrão para a pasta .clientsshproxy no diretório base do usuário, se não for fornecido.

--yes --yes-without-prompt -y

Atualize a configuração do serviço sem solicitar ao usuário.

Propriedade Valor
Valor padrão: False
<SSH_ARGS>

Argumentos adicionais passados para OpenSSH.

Propriedade Valor
Grupo de parâmetros: Positional
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 ssh cert

Crie um certificado RSA SSH assinado pelo AAD.

az ssh cert [--file]
            [--public-key-file]
            [--ssh-client-folder]

Exemplos

Criar um certificado ssh de curta duração assinado pelo AAD

az ssh cert --public-key-file ./id_rsa.pub --file ./id_rsa-aadcert.pub

Forneça uma pasta de cliente SSH para usar os executáveis ssh nessa pasta, como ssh-keygen.exe. Se não for fornecido, a extensão tentará usar o cliente OpenSSH pré-instalado (no Windows, a extensão procura executáveis pré-instalados em C:\Windows\System32\OpenSSH).

az ssh cert --file ./id_rsa-aadcert.pub --ssh-client-folder "C:\Program Files\OpenSSH"

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.

--file -f

O caminho do arquivo para o qual gravar o certificado SSH, usa como padrão o caminho da chave pública com -aadcert.pub acrescentado.

--public-key-file -p

O caminho do arquivo de chave pública RSA. Se não for fornecido, o par de chaves gerado será armazenado no mesmo diretório que --file.

--ssh-client-folder

Caminho da pasta que contém executáveis ssh (ssh.exe, ssh-keygen.exe, etc. Padrão para ssh pré-instalado se não for fornecido.

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 ssh config

Crie uma configuração SSH para recursos (VMs do Azure, Servidores Arc etc. ) que podem ser usados por clientes que dão suporte a configurações e certificados OpenSSH.

Outros softwares (git/rsync/etc) que dão suporte à configuração de um comando SSH podem ser definidos para usar o arquivo de configuração definindo o comando como 'ssh -F /path/to/config', por exemplo, rsync -e 'ssh -F /path/to/config'. Os usuários podem criar arquivos de configuração ssh que usam certificados emitidos pelo AAD ou credenciais de usuário local.

az ssh config --file
              [--certificate-file]
              [--ip]
              [--keys-dest-folder --keys-destination-folder]
              [--local-user]
              [--name --vm-name]
              [--overwrite]
              [--port]
              [--prefer-private-ip]
              [--private-key-file]
              [--public-key-file]
              [--resource-group]
              [--resource-type]
              [--ssh-client-folder]
              [--ssh-proxy-folder]
              [--yes --yes-without-prompt]

Exemplos

Forneça o grupo de recursos e o nome do computador para o qual criar uma configuração usando certificados emitidos pelo AAD, salve em um arquivo local e, em seguida, ssh nesse recurso

az ssh config --resource-group myResourceGroup --name myVm --file ./sshconfig
ssh -F ./sshconfig myResourceGroup-myVM

Forneça o IP público (ou nome do host) de uma VM do Azure para a qual criar uma configuração e, em seguida, ssh nessa VM

az ssh config --ip 1.2.3.4 --file ./sshconfig
ssh -F ./sshconfig 1.2.3.4

Dê a um usuário local para criar uma configuração usando credenciais de usuário local, salvar no arquivo local e, em seguida, ssh nesse recurso

az ssh config --resource-group myResourceGroup --name myMachine --local-user username --certificate-file cert --private-key-file key --file ./sshconfig
ssh -F ./sshconfig MyResourceGroup-myMachine-username

Dê à Pasta de Destino chaves para armazenar as chaves e certificados gerados. Se não for fornecido, as chaves SSH serão armazenadas na nova pasta "az_ssh_config" ao lado do arquivo de configuração.

az ssh config --ip 1.2.3.4 --file ./sshconfig --keys-destination-folder /home/user/mykeys

Criar uma configuração genérica para uso com qualquer host

#Bash
az ssh config --ip \* --file ./sshconfig
#PowerShell
az ssh config --ip * --file ./sshconfig

Exemplos com outros softwares

#Bash
az ssh config --ip \* --file ./sshconfig
rsync -e 'ssh -F ./sshconfig' -avP directory/ myvm:~/directory
GIT_SSH_COMMAND="ssh -F ./sshconfig" git clone myvm:~/gitrepo

Forneça uma pasta de cliente SSH para usar os executáveis ssh nessa pasta, como ssh-keygen.exe. Se não for fornecido, a extensão tentará usar o cliente OpenSSH pré-instalado (no Windows, a extensão procura executáveis pré-instalados em C:\Windows\System32\OpenSSH).

az ssh config --file ./myconfig --resource-group myResourceGroup --name myVM --ssh-client-folder "C:\Program Files\OpenSSH"

Forneça o tipo de recurso do destino. Útil quando há uma VM do Azure e um Servidor Arc com o mesmo nome no mesmo grupo de recursos. O tipo de recurso pode ser "Microsoft.HybridCompute" para Servidores Arc ou "Microsoft.Compute" para Máquinas Virtuais do Azure.

az ssh config --resource-type [Microsoft.Compute/virtualMachines|Microsoft.HybridCompute/machines] --resource-group myResourceGroup --name myVM --file ./myconfig

Parâmetros Exigidos

--file -f

O caminho do arquivo para o qual gravar a configuração SSH.

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.

--certificate-file -c

Caminho para o arquivo de certificado.

--ip

O endereço IP público (ou nome do host) da VM.

--keys-dest-folder --keys-destination-folder

Pasta em que novas chaves geradas serão armazenadas.

--local-user

O nome de usuário de um usuário local.

--name --vm-name -n

O nome da VM.

--overwrite

Substituirá o arquivo de configuração se esse sinalizador estiver definido.

Propriedade Valor
Valor padrão: False
--port

Porta SSH.

--prefer-private-ip

Usará um IP privado se disponível. Por padrão, somente IPs públicos são usados.

Propriedade Valor
Valor padrão: False
--private-key-file -i

O caminho do arquivo de chave privada RSA.

--public-key-file -p

O caminho do arquivo de chave pública RSA.

--resource-group -g

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

--resource-type

O tipo de recurso deve ser Microsoft.Compute/virtualMachines, Microsoft.HybridCompute/machines ou Microsoft.ConnectedVMwareSphere/virtualMachines.

--ssh-client-folder

Caminho da pasta que contém executáveis ssh (ssh.exe, ssh-keygen.exe, etc. Padrão para ssh pré-instalado se não for fornecido.

--ssh-proxy-folder

Caminho para a pasta em que o proxy ssh deve ser salvo. Padrão para a pasta .clientsshproxy no diretório base do usuário, se não for fornecido.

--yes --yes-without-prompt -y

Atualize a configuração do serviço sem solicitar ao usuário.

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

--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 ssh vm

SSH em VMs do Azure ou servidores Arc.

Os usuários podem fazer logon usando certificados emitidos pelo AAD ou usando credenciais de usuário local. É recomendável fazer logon usando certificados emitidos pelo AAD. Para SSH usando credenciais de usuário local, você deve fornecer o nome de usuário local usando o parâmetro --local-user.

az ssh vm [--certificate-file]
          [--hostname --ip]
          [--local-user]
          [--name --vm-name]
          [--port]
          [--prefer-private-ip]
          [--private-key-file]
          [--public-key-file]
          [--rdp --winrdp]
          [--resource-group]
          [--resource-type]
          [--ssh-client-folder]
          [--ssh-proxy-folder]
          [--yes --yes-without-prompt]
          []

Exemplos

Dar um nome de grupo de recursos e um nome de computador ao SSH usando certificados emitidos pelo AAD

az ssh vm --resource-group myResourceGroup --name myVM

Forneça o IP público (ou nome do host) de uma VM ao SSH usando certificados emitidos pelo AAD

az ssh vm --ip 1.2.3.4
az ssh vm --hostname example.com

Usando um arquivo de chave privada personalizado

az ssh vm --ip 1.2.3.4 --private-key-file key --public-key-file key.pub

Usando argumentos ssh adicionais

az ssh vm --ip 1.2.3.4 -- -A -o ForwardX11=yes

Forneça o tipo de recurso do destino. Útil quando há uma VM do Azure e um Servidor Arc com o mesmo nome no mesmo grupo de recursos. O tipo de recurso pode ser "Microsoft.HybridCompute" para Servidores Arc ou "Microsoft.Compute" para Máquinas Virtuais do Azure.

az ssh vm --resource-type [Microsoft.Compute/virtualMachines|Microsoft.HybridCompute/machines] --resource-group myResourceGroup --name myVM

Dê um nome de usuário local ao SSH com credenciais de usuário local usando a autenticação baseada em certificado.

az ssh vm --local-user username --ip 1.2.3.4 --certificate-file cert.pub --private-key-file key

Dê um nome de usuário local ao SSH com credenciais de usuário local usando a autenticação baseada em chave.

az ssh vm --local-user username --resource-group myResourceGroup --name myVM --private-key-file key

Dê um nome de usuário local ao SSH com credenciais de usuário local usando a autenticação baseada em senha.

az ssh vm --local-user username --resource-group myResourceGroup --name myArcServer

Forneça uma pasta de cliente SSH para usar os executáveis ssh nessa pasta, como ssh-keygen.exe e ssh.exe. Se não for fornecido, a extensão tentará usar o cliente OpenSSH pré-instalado (no Windows, a extensão procura executáveis pré-instalados em C:\Windows\System32\OpenSSH).

az ssh vm --resource-group myResourceGroup --name myVM --ssh-client-folder "C:\Program Files\OpenSSH"

Abra a conexão RDP por SSH. Útil para se conectar via RDP a servidores Arc sem endereço IP público. Atualmente, só há suporte para clientes Windows.

az ssh vm --resource-group myResourceGroup --name myVM --local-user username --rdp

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.

--certificate-file -c

Caminho para um arquivo de certificado usado para autenticação ao usar credenciais de usuário local.

--hostname --ip

O endereço IP público (ou privado acessível) (ou nome do host) da VM.

--local-user

O nome de usuário de um usuário local.

--name --vm-name -n

O nome da VM.

--port

Porta SSH.

--prefer-private-ip

Preferirá IP privado. Requer conectividade com o IP privado.

Propriedade Valor
Valor padrão: False
--private-key-file -i

O caminho do arquivo de chave privada RSA.

--public-key-file -p

O caminho do arquivo de chave pública RSA.

--rdp --winrdp

Inicie a conexão RDP por SSH.

Propriedade Valor
Valor padrão: False
--resource-group -g

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

--resource-type

O tipo de recurso deve ser Microsoft.Compute/virtualMachines, Microsoft.HybridCompute/machines ou Microsoft.ConnectedVMwareSphere/virtualMachines.

--ssh-client-folder

Caminho da pasta que contém executáveis ssh (ssh.exe, ssh-keygen.exe, etc. Padrão para ssh pré-instalado se não for fornecido.

--ssh-proxy-folder

Caminho para a pasta em que o proxy ssh deve ser salvo. Padrão para a pasta .clientsshproxy no diretório base do usuário, se não for fornecido.

--yes --yes-without-prompt -y

Atualize a configuração do serviço sem solicitar ao usuário.

Propriedade Valor
Valor padrão: False
<SSH_ARGS>

Argumentos adicionais passados para OpenSSH.

Propriedade Valor
Grupo de parâmetros: Positional
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