com.microsoft.azure.management.compute

Class SshPublicKey

java.lang.Object

com.microsoft.azure.management.compute.SshPublicKey

public class SshPublicKey
extends Object

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

Constructor Summary

Constructors

Constructor and Description
SshPublicKey()

Method Summary

Modifier and Type	Method and Description
String	keyData() Get sSH public key certificate used to authenticate with the VM through ssh.
String	path() Get specifies the full path on the created VM where ssh public key is stored.
SshPublicKey	withKeyData(String keyData) Set sSH public key certificate used to authenticate with the VM through ssh.
SshPublicKey	withPath(String path) Set specifies the full path on the created VM where ssh public key is stored.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SshPublicKey

public SshPublicKey()

Method Detail

path

public String path()

Get specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys.

Returns:

the path value

withPath

public SshPublicKey withPath(String path)

Set specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys.

Parameters:

path - the path value to set

Returns:

the SshPublicKey object itself.

keyData

public String keyData()

Get sSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. <br><br> For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).

Returns:

the keyData value

withKeyData

public SshPublicKey withKeyData(String keyData)

Set sSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. <br><br> For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).

Parameters:

keyData - the keyData value to set

Returns:

the SshPublicKey object itself.