CmdID / az / az ssh

az ssh config

Create an SSH config for resources (Azure VMs, Arc Servers, etc) which can then be used by clients that support OpenSSH configs and certificates Azure CLI extensions reference

15 options Its page in the Azure CLI extensions reference

Options

15 in the Azure CLI extensions reference

--certificate-file, -cPath to certificate file

--file, -fThe file path to write the SSH config to

--ipThe public IP address (or hostname) of the VM

--keys-destination-folder, --keys-dest-folderFolder where new generated keys will be stored.

--local-userThe username for a local user

--overwriteOverwrites the config file if this flag is set

--portSSH Port

--prefer-private-ipWill use a private IP if available.

--private-key-file, -iThe RSA private key file path

--public-key-file, -pThe RSA public key file path

--resource-typeResource type should be either Microsoft.Compute/virtualMachines, Microsoft.HybridCompute/machines, or Microsoft.ConnectedVMwareSphere/virtualMachines.

--ssh-client-folderFolder path that contains ssh executables (ssh.exe, ssh-keygen.exe, etc).

--ssh-proxy-folderPath to the folder where the ssh proxy should be saved.

--vm-name, --name, -nThe name of the VM

--yes-without-prompt, --yes, -yUpdate service configuration without prompting user