az ssh

  • Référence

Remarque

Cette référence fait partie de l’extension ssh pour Azure CLI (version 2.45.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande az ssh . En savoir plus sur les extensions.

Ssh dans des ressources (machines virtuelles Azure, serveurs Arc, etc.) à l’aide de certificats AAD émis ouvre des certificats.

SSH dans des serveurs avec Arc sans nécessiter d’adresse IP publique ou SSH dans Azure Machines Virtuelles. AAD émis ouvre des certificats d’authentification pour l’authentification actuellement uniquement pris en charge pour Linux.

Commandes

Nom Description Type Statut
az ssh arc

SSH dans les serveurs Azure Arc.

 Extension GA
az ssh cert

Créez un certificat SSH RSA signé par AAD.

 Extension GA
az ssh config

Créez une configuration SSH pour les ressources (machines virtuelles Azure, serveurs Arc, etc.) qui peuvent ensuite être utilisées par les clients qui prennent en charge les configurations et certificats OpenSSH.

 Extension GA
az ssh vm

SSH dans des machines virtuelles Azure ou des serveurs Arc.

 Extension GA

az ssh arc

SSH dans les serveurs Azure Arc.

Les utilisateurs peuvent se connecter à l’aide de certificats émis par AAD ou à l’aide d’informations d’identification utilisateur locales. Nous vous recommandons de vous connecter à l’aide de certificats émis par AAD. Pour ssh à l’aide d’informations d’identification utilisateur locales, vous devez fournir le nom d’utilisateur local à l’aide du paramètre --local-user.

az ssh arc [--certificate-file]
           [--local-user]
           [--name]
           [--port]
           [--private-key-file]
           [--public-key-file]
           [--rdp]
           [--resource-group]
           [--resource-type]
           [--ssh-client-folder]
           [--ssh-proxy-folder]
           [--yes]
           [<SSH_ARGS>]

Exemples

Donnez un nom de groupe de ressources et un nom d’ordinateur à SSH à l’aide de certificats émis par AAD

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

Utilisation d’un fichier de clé privée personnalisé

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

Utilisation d’arguments ssh supplémentaires

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

Donnez un nom d’utilisateur local à SSH avec les informations d’identification de l’utilisateur local à l’aide de l’authentification basée sur un certificat.

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

Attribuez un nom d’utilisateur local à SSH avec les informations d’identification de l’utilisateur local à l’aide de l’authentification basée sur des clés.

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

Donnez un nom d’utilisateur local à SSH avec les informations d’identification de l’utilisateur local à l’aide de l’authentification par mot de passe.

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

Donnez un dossier client SSH pour utiliser les exécutables SSH dans ce dossier, comme ssh-keygen.exe et ssh.exe. Si elle n’est pas fournie, l’extension tente d’utiliser le client OpenSSH préinstallé (sur Windows, l’extension recherche des exécutables préinstallés sous C :\Windows\System32\OpenSSH).

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

Ouvrez la connexion RDP via SSH. Utile pour la connexion via RDP à Des serveurs Arc sans adresse IP publique. Actuellement uniquement pris en charge pour les clients Windows.

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

Paramètres facultatifs

--certificate-file -c

Chemin d’accès au fichier de certificat.

--local-user

Nom d’utilisateur d’un utilisateur local.

--name --vm-name -n

Nom du serveur Arc.

--port

Port vers lequel se connecter sur l’hôte distant.

--private-key-file -i

Chemin du fichier de clé privée RSA.

--public-key-file -p

Chemin du fichier de clé publique RSA.

--rdp --winrdp

Démarrez la connexion RDP via SSH.

valeur par défaut: False
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--resource-type

Le type de ressource doit être Microsoft.HybridCompute/machines ou Microsoft. Connecter edVMwareSphere/virtualMachines.

--ssh-client-folder

Chemin d’accès du dossier qui contient des exécutables ssh (ssh.exe, ssh-keygen.exe, etc.). Par défaut, ssh préinstallé s’il n’est pas fourni.

--ssh-proxy-folder

Chemin d’accès au dossier dans lequel le proxy ssh doit être enregistré. La valeur par défaut est le dossier .clientsshproxy dans le répertoire de base de l’utilisateur s’il n’est pas fourni.

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

Mettez à jour la configuration du service sans inviter l’utilisateur.

valeur par défaut: False
<SSH_ARGS>

Arguments supplémentaires passés à OpenSSH.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az ssh cert

Créez un certificat SSH RSA signé par AAD.

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

Exemples

Créer un certificat SSH de courte durée signé par AAD

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

Donnez un dossier client SSH pour utiliser les exécutables SSH dans ce dossier, comme ssh-keygen.exe. Si elle n’est pas fournie, l’extension tente d’utiliser le client OpenSSH préinstallé (sur Windows, l’extension recherche des exécutables préinstallés sous C :\Windows\System32\OpenSSH).

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

Paramètres facultatifs

--file -f

Le chemin d’accès au fichier pour écrire le certificat SSH, est défini par défaut sur le chemin de la clé publique avec -aadcert.pub appened.

--public-key-file -p

Chemin du fichier de clé publique RSA. Si elle n’est pas fournie, la paire de clés générée est stockée dans le même répertoire que --file.

--ssh-client-folder

Chemin d’accès du dossier qui contient des exécutables ssh (ssh.exe, ssh-keygen.exe, etc.). Par défaut, ssh préinstallé s’il n’est pas fourni.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az ssh config

Créez une configuration SSH pour les ressources (machines virtuelles Azure, serveurs Arc, etc.) qui peuvent ensuite être utilisées par les clients qui prennent en charge les configurations et certificats OpenSSH.

D’autres logiciels (git/rsync/etc) qui prennent en charge la définition d’une commande SSH peuvent être définis pour utiliser le fichier de configuration en définissant la commande sur « ssh -F /path/to/config », par exemple rsync -e « ssh -F /path/to/config ». Les utilisateurs peuvent créer des fichiers de configuration SSH qui utilisent des certificats émis par AAD ou des informations d’identification utilisateur locales.

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

Exemples

Donnez le nom du groupe de ressources et de l’ordinateur pour lequel créer une configuration à l’aide de certificats émis par AAD, enregistrez-les dans un fichier local, puis connectez-vous à cette ressource.

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

Donnez l’adresse IP publique (ou le nom d’hôte) d’une machine virtuelle Azure pour laquelle créer une configuration, puis ssh dans cette machine virtuelle

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

Donner à un utilisateur local de créer une configuration à l’aide des informations d’identification de l’utilisateur local, enregistrer dans le fichier local, puis ssh dans cette ressource

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

Donnez au dossier de destination des clés pour stocker les clés et certificats générés. S’il n’est pas fourni, les clés SSH sont stockées dans le nouveau dossier « az_ssh_config » en regard du fichier de configuration.

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

Créer une configuration générique à utiliser avec n’importe quel hôte

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

Exemples avec d’autres logiciels

#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

Donnez un dossier client SSH pour utiliser les exécutables SSH dans ce dossier, comme ssh-keygen.exe. Si elle n’est pas fournie, l’extension tente d’utiliser le client OpenSSH préinstallé (sur Windows, l’extension recherche des exécutables préinstallés sous C :\Windows\System32\OpenSSH).

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

Donnez le type de ressource de la cible. Utile lorsqu’il existe une machine virtuelle Azure et un serveur Arc portant le même nom dans le même groupe de ressources. Le type de ressource peut être « Microsoft.HybridCompute » pour les serveurs Arc ou « Microsoft.Compute » pour Azure Machines Virtuelles.

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

Paramètres obligatoires

--file -f

Chemin d’accès au fichier dans lequel écrire la configuration SSH.

Paramètres facultatifs

--certificate-file -c

Chemin d’accès au fichier de certificat.

--ip

Adresse IP publique (ou nom d’hôte) de la machine virtuelle.

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

Dossier dans lequel les nouvelles clés générées seront stockées.

--local-user

Nom d’utilisateur d’un utilisateur local.

--name --vm-name -n

nom de la machine virtuelle.

--overwrite

Remplace le fichier de configuration si cet indicateur est défini.

valeur par défaut: False
--port

Port SSH.

--prefer-private-ip

Utilise une adresse IP privée si disponible. Par défaut, seules les adresses IP publiques sont utilisées.

valeur par défaut: False
--private-key-file -i

Chemin du fichier de clé privée RSA.

--public-key-file -p

Chemin du fichier de clé publique RSA.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--resource-type

Le type de ressource doit être Microsoft.Compute/virtualMachines, Microsoft.HybridCompute/machines ou Microsoft. Connecter edVMwareSphere/virtualMachines.

--ssh-client-folder

Chemin d’accès du dossier qui contient des exécutables ssh (ssh.exe, ssh-keygen.exe, etc.). Par défaut, ssh préinstallé s’il n’est pas fourni.

--ssh-proxy-folder

Chemin d’accès au dossier dans lequel le proxy ssh doit être enregistré. La valeur par défaut est le dossier .clientsshproxy dans le répertoire de base de l’utilisateur s’il n’est pas fourni.

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

Mettez à jour la configuration du service sans inviter l’utilisateur.

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az ssh vm

SSH dans des machines virtuelles Azure ou des serveurs Arc.

Les utilisateurs peuvent se connecter à l’aide de certificats émis par AAD ou à l’aide d’informations d’identification utilisateur locales. Nous vous recommandons de vous connecter à l’aide de certificats émis par AAD. Pour ssh à l’aide des informations d’identification de l’utilisateur local, vous devez fournir le nom d’utilisateur local à l’aide du paramètre --local-user.

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

Exemples

Donnez un nom de groupe de ressources et un nom d’ordinateur à SSH à l’aide de certificats émis par AAD

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

Donnez l’adresse IP publique (ou le nom d’hôte) d’une machine virtuelle à SSH à l’aide de certificats émis par AAD

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

Utilisation d’un fichier de clé privée personnalisé

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

Utilisation d’arguments ssh supplémentaires

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

Donnez le type de ressource de la cible. Utile lorsqu’il existe une machine virtuelle Azure et un serveur Arc portant le même nom dans le même groupe de ressources. Le type de ressource peut être « Microsoft.HybridCompute » pour les serveurs Arc ou « Microsoft.Compute » pour Azure Machines Virtuelles.

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

Donnez un nom d’utilisateur local à SSH avec les informations d’identification de l’utilisateur local à l’aide de l’authentification basée sur un certificat.

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

Attribuez un nom d’utilisateur local à SSH avec les informations d’identification de l’utilisateur local à l’aide de l’authentification basée sur des clés.

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

Donnez un nom d’utilisateur local à SSH avec les informations d’identification de l’utilisateur local à l’aide de l’authentification par mot de passe.

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

Donnez un dossier client SSH pour utiliser les exécutables SSH dans ce dossier, comme ssh-keygen.exe et ssh.exe. Si elle n’est pas fournie, l’extension tente d’utiliser le client OpenSSH préinstallé (sur Windows, l’extension recherche des exécutables préinstallés sous C :\Windows\System32\OpenSSH).

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

Ouvrez la connexion RDP via SSH. Utile pour la connexion via RDP à Des serveurs Arc sans adresse IP publique. Actuellement uniquement pris en charge pour les clients Windows.

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

Paramètres facultatifs

--certificate-file -c

Chemin d’accès à un fichier de certificat utilisé pour l’authentification lors de l’utilisation des informations d’identification de l’utilisateur local.

--hostname --ip

Adresse IP publique (ou privée accessible) (ou nom d’hôte) de la machine virtuelle.

--local-user

Nom d’utilisateur d’un utilisateur local.

--name --vm-name -n

nom de la machine virtuelle.

--port

Port SSH.

--prefer-private-ip

Préférera l’adresse IP privée. Nécessite une connectivité à l’adresse IP privée.

valeur par défaut: False
--private-key-file -i

Chemin du fichier de clé privée RSA.

--public-key-file -p

Chemin du fichier de clé publique RSA.

--rdp --winrdp

Démarrez la connexion RDP via SSH.

valeur par défaut: False
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--resource-type

Le type de ressource doit être Microsoft.Compute/virtualMachines, Microsoft.HybridCompute/machines ou Microsoft. Connecter edVMwareSphere/virtualMachines.

--ssh-client-folder

Chemin d’accès du dossier qui contient des exécutables ssh (ssh.exe, ssh-keygen.exe, etc.). Par défaut, ssh préinstallé s’il n’est pas fourni.

--ssh-proxy-folder

Chemin d’accès au dossier dans lequel le proxy ssh doit être enregistré. La valeur par défaut est le dossier .clientsshproxy dans le répertoire de base de l’utilisateur s’il n’est pas fourni.

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

Mettez à jour la configuration du service sans inviter l’utilisateur.

valeur par défaut: False
<SSH_ARGS>

Arguments supplémentaires passés à OpenSSH.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.