Export-AzSshConfig

Export-AzSshConfig
    -ResourceGroupName <String>
    -Name <String>
    -ConfigFilePath <String>
    [-PublicKeyFile <String>]
    [-PrivateKeyFile <String>]
    [-UsePrivateIp]
    [-LocalUser <String>]
    [-Port <String>]
    [-ResourceType <String>]
    [-CertificateFile <String>]
    [-Overwrite]
    [-KeysDestinationFolder <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Export-AzSshConfig
    -Ip <String>
    -ConfigFilePath <String>
    [-PublicKeyFile <String>]
    [-PrivateKeyFile <String>]
    [-LocalUser <String>]
    [-Port <String>]
    [-CertificateFile <String>]
    [-Overwrite]
    [-KeysDestinationFolder <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Export-AzSshConfig
    -ResourceId <String>
    -ConfigFilePath <String>
    [-PublicKeyFile <String>]
    [-PrivateKeyFile <String>]
    [-UsePrivateIp]
    [-LocalUser <String>]
    [-Port <String>]
    [-CertificateFile <String>]
    [-Overwrite]
    [-KeysDestinationFolder <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Le fichier de configuration SSH exporté peut être utilisé pour se connecter aux ressources Azure par les applications clientes qui prennent en charge la configuration et les certificats OpenSSH. Les applications telles que git et rsync peuvent 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 Microsoft Entra ID ou des informations d’identification utilisateur locales. Remarque importante : lors de la connexion aux ressources Azure Arc, cette applet de commande nécessite que le module Az.Ssh.ArcProxy soit également installé sur la machine cliente. L’applet de commande tente d’installer le module à partir de PowerShell Gallery, mais l’utilisateur a également la possibilité de l’installer lui-même. Il est important que l’utilisateur dispose également de l’autorisation d’exécuter les fichiers proxy dans le module Az.Ssh.ArcProxy, ou que la connexion échoue. Vous trouverez le module Az.Ssh.ArcServer dans PowerShell Gallery : https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy.

Export-AzSshConfig -ResourceGroupName myRg -Name myMachine -ConfigFilePath ./sshconfig.config

Lorsqu’un -LocalUser n’est pas fourni, l’applet de commande tente de créer un certificat pour se connecter à l’aide de l’ID Microsoft Entra. Cela est actuellement uniquement pris en charge pour les ressources exécutant le système d’exploitation Linux. Lorsque vous utilisez l’ID Microsoft Entra pour vous connecter à la ressource, le nom d’hôte dans l’entrée de configuration est « {nom du groupe de ressources}-{nom de ressource} » ou « {adresse IP} » pour les machines virtuelles Azure.

Export-AzSshConfig -Ip 1.2.3.4 -ConfigFilePath ./sshconfig.config

Export-AzSshConfig -ResourceGroupName myRg -Name myVm -LocalUser azureuser -CertificateFile ./cert -PrivateKeyFile ./id_rsa -ConfigFilePath ./sshconfig.config

Lorsque vous utilisez des informations d’identification utilisateur locales pour vous connecter, le nom d’hôte dans l’entrée de configuration est « {nom du groupe de ressources}-{nom_ressource}-{nom_utilisateur} » ou « {adresse IP}-{nom_utilisateur} » pour les machines virtuelles Azure.

Export-AzSshConfig -ResourceGroupName myRg -Name myVm -LocalUser azureuser -PrivateKeyFile ./id_rsa -ConfigFilePath ./sshconfig.config

Export-AzSshConfig -ResourceGroupName myRg -Name myVm -LocalUser azureuser -ConfigFilePath ./sshconfig.config

Export-AzSshConfig -ResourceGroupName myRg -Name myVm -KeysDestinationFolder /home/user/mykeys -ConfigFilePath ./sshconfig.config

Les clés et certificats générés sont, par défaut, stockés dans le répertoire « az_ssh_config » dans le même répertoire que le fichier config. Le paramètre -KeysDestinationFolder permet à l’utilisateur de décider où les clés seront stockées.

Export-AzSshConfig -Ip * -ConfigFilePath ./sshconfig.config

Export-AzSshConfig -ResourceGroupName myRg -Name myVm -ResourceType Microsoft.Compute/virtualMachines -ConfigFilePath ./sshconfig.config

Ce paramètre est utile lorsqu’il existe plusieurs ressources prises en charge portant le même nom dans le groupe de ressources.

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.