Forrest logo
back to the az tool

az-sshkey:tldr:9a96f

az-sshkey: Upload an existing SSH key.
$ az sshkey create --name ${name} --resource-group ${resource_group} --public-key "${@path-to-key-pub}"
try on your machine

This command is creating an SSH key with the Azure CLI (az) command-line tool.

Here is the breakdown of the command:

  • az sshkey create: This is the main command to create an SSH key.
  • --name ${name}: Specifies the name for the SSH key. The value of ${name} will be substituted with an actual name.
  • --resource-group ${resource_group}: Specifies the resource group where the SSH key will be created. The value of ${resource_group} will be substituted with an actual resource group name.
  • --public-key "${@path-to-key-pub}": Specifies the public key file to use for creating the SSH key. The value of ${@path-to-key-pub} will be substituted with the actual path to the public key file. The public key file is referenced with @ symbol followed by the path.

In summary, this command creates an SSH key with a given name, in a specified resource group, using the public key file provided.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the az tool