LinuxUserConfiguration Class

Package:

com.azure.resourcemanager.batch.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-batch:2.0.0

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

Implements

JsonSerializable<LinuxUserConfiguration>

public final class LinuxUserConfiguration
implements JsonSerializable<LinuxUserConfiguration>

Properties used to create a user account on a Linux 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	gid() Get the gid property: The uid and gid properties must be specified together or not at all.
String	sshPrivateKey() Get the sshPrivateKey property: The private key must not be password protected.
JsonWriter	toJson(JsonWriter jsonWriter)
Integer	uid() Get the uid property: The uid and gid properties must be specified together or not at all.
void	validate() Validates the instance.
LinuxUserConfiguration	withGid(Integer gid) Set the gid property: The uid and gid properties must be specified together or not at all.
LinuxUserConfiguration	withSshPrivateKey(String sshPrivateKey) Set the sshPrivateKey property: The private key must not be password protected.
LinuxUserConfiguration	withUid(Integer uid) Set the uid property: The uid and gid properties must be specified together or not at all.

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.

gid

public Integer gid()

Get the gid property: 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.

sshPrivateKey

public String sshPrivateKey()

Get the sshPrivateKey property: The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between 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 nodes (no modification of the user's .ssh directory is done).

Returns:

the sshPrivateKey value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

uid

public Integer uid()

Get the uid property: 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.

validate

public void validate()

Validates the instance.

withGid

public LinuxUserConfiguration withGid(Integer gid)

Set the gid property: 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.

withSshPrivateKey

public LinuxUserConfiguration withSshPrivateKey(String sshPrivateKey)

Set the sshPrivateKey property: The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between 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 nodes (no modification of the user's .ssh directory is done).

Parameters:

sshPrivateKey - the sshPrivateKey value to set.

Returns:

the LinuxUserConfiguration object itself.

withUid

public LinuxUserConfiguration withUid(Integer uid)

Set the uid property: 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.