LinuxUserConfiguration Class

  • java.lang.Object
    • com.microsoft.azure.management.batch.LinuxUserConfiguration

public class LinuxUserConfiguration

Properties used to create a user account on a Linux node.

Method Summary

Modifier and Type Method and Description
Integer gid()

Get the uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.

String sshPrivateKey()

Get 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).

Integer uid()

Get the uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.

LinuxUserConfiguration withGid(Integer gid)

Set the uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.

LinuxUserConfiguration withSshPrivateKey(String sshPrivateKey)

Set 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).

LinuxUserConfiguration withUid(Integer uid)

Set the uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.

Method Details

gid

public Integer gid()

Get 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 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

uid

public Integer uid()

Get 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

withGid

public LinuxUserConfiguration withGid(Integer gid)

Set 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 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 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.

Applies to