Package com.microsoft.azure.batch.protocol.models

Class ComputeNodeUser

  • public class ComputeNodeUser
extends Object
    A user Account for RDP or SSH access on a Compute Node.

    • Constructor Detail

      • ComputeNodeUser

        public ComputeNodeUser()

    • Method Detail

      • name

        public String name()
        Get the name value.
        Returns:
        the name value

      • withName

        public ComputeNodeUser withName​(String name)
        Set the name value.
        Parameters:
        name - the name value to set
        Returns:
        the ComputeNodeUser object itself.

      • isAdmin

        public Boolean isAdmin()
        Get the default value is false.
        Returns:
        the isAdmin value

      • withIsAdmin

        public ComputeNodeUser withIsAdmin​(Boolean isAdmin)
        Set the default value is false.
        Parameters:
        isAdmin - the isAdmin value to set
        Returns:
        the ComputeNodeUser object itself.

      • expiryTime

        public org.joda.time.DateTime expiryTime()
        Get if omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day.
        Returns:
        the expiryTime value

      • withExpiryTime

        public ComputeNodeUser withExpiryTime​(org.joda.time.DateTime expiryTime)
        Set if omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day.
        Parameters:
        expiryTime - the expiryTime value to set
        Returns:
        the ComputeNodeUser object itself.

      • password

        public String password()
        Get the password is required for Windows Compute Nodes (those created with 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows Image reference). For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property.
        Returns:
        the password value

      • withPassword

        public ComputeNodeUser withPassword​(String password)
        Set the password is required for Windows Compute Nodes (those created with 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows Image reference). For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property.
        Parameters:
        password - the password value to set
        Returns:
        the ComputeNodeUser object itself.

      • sshPublicKey

        public String sshPublicKey()
        Get the public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
        Returns:
        the sshPublicKey value

      • withSshPublicKey

        public ComputeNodeUser withSshPublicKey​(String sshPublicKey)
        Set the public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
        Parameters:
        sshPublicKey - the sshPublicKey value to set
        Returns:
        the ComputeNodeUser object itself.