LinuxUserConfiguration Class

Package:

com.azure.compute.batch.models

Maven Artifact:

com.azure:azure-compute-batch:1.0.0-beta.5

• java.lang.Object
• • com.azure.compute.batch.models.LinuxUserConfiguration

Implements

JsonSerializable<LinuxUserConfiguration>

public final class LinuxUserConfiguration
implements JsonSerializable<LinuxUserConfiguration>

Properties used to create a user Account on a Linux Compute Node.

Constructor Summary

Constructor	Description
LinuxUserConfiguration()	Creates an instance of LinuxUserConfiguration class.

Method Summary

Modifier and Type	Method and Description
static LinuxUserConfiguration	fromJson(JsonReader jsonReader) Reads an instance of LinuxUserConfiguration from the JsonReader.
Integer	getGid() Get the gid property: The group ID for the user Account.
String	getSshPrivateKey() Get the sshPrivateKey property: The SSH private key for the user Account.
Integer	getUid() Get the uid property: The user ID of the user Account.
LinuxUserConfiguration	setGid(Integer gid) Set the gid property: The group ID for the user Account.
LinuxUserConfiguration	setSshPrivateKey(String sshPrivateKey) Set the sshPrivateKey property: The SSH private key for the user Account.
LinuxUserConfiguration	setUid(Integer uid) Set the uid property: The user ID of the user Account.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

LinuxUserConfiguration

public LinuxUserConfiguration()

Creates an instance of LinuxUserConfiguration class.

Method Details

fromJson

public static LinuxUserConfiguration fromJson(JsonReader jsonReader)

Reads an instance of LinuxUserConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of LinuxUserConfiguration if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the LinuxUserConfiguration.

getGid

public Integer getGid()

Get the gid property: The group ID for the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.

Returns:

the gid value.

getSshPrivateKey

public String getSshPrivateKey()

Get the sshPrivateKey property: The SSH private key for the user Account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done).

Returns:

the sshPrivateKey value.

getUid

public Integer getUid()

Get the uid property: The user ID of the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.

Returns:

the uid value.

setGid

public LinuxUserConfiguration setGid(Integer gid)

Set the gid property: The group ID for the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.

Parameters:

gid - the gid value to set.

Returns:

the LinuxUserConfiguration object itself.

setSshPrivateKey

public LinuxUserConfiguration setSshPrivateKey(String sshPrivateKey)

Set the sshPrivateKey property: The SSH private key for the user Account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done).

Parameters:

sshPrivateKey - the sshPrivateKey value to set.

Returns:

the LinuxUserConfiguration object itself.

setUid

public LinuxUserConfiguration setUid(Integer uid)

Set the uid property: The user ID of the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.

Parameters:

uid - the uid value to set.

Returns:

the LinuxUserConfiguration object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException