Package com.azure.resourcemanager.batch.models

Class LinuxUserConfiguration

java.lang.Object
com.azure.resourcemanager.batch.models.LinuxUserConfiguration
public final class LinuxUserConfiguration extends Object
Properties used to create a user account on a Linux node.

  • Constructor Details

    • LinuxUserConfiguration

      public LinuxUserConfiguration()
      Creates an instance of LinuxUserConfiguration class.

  • Method Details

    • uid

      public Integer uid()
      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.

    • withUid

      public LinuxUserConfiguration withUid(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.

    • gid

      public Integer gid()
      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.

    • withGid

      public LinuxUserConfiguration withGid(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.

    • sshPrivateKey

      public String sshPrivateKey()
      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 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.

    • withSshPrivateKey

      public LinuxUserConfiguration withSshPrivateKey(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 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.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.