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

Class NodeUpdateUserParameter

  • public class NodeUpdateUserParameter
extends Object
    The set of changes to be made to a user Account on a Compute Node.

    • Constructor Detail

      • NodeUpdateUserParameter

        public NodeUpdateUserParameter()

    • Method Detail

      • 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. If omitted, any existing password is removed.
        Returns:
        the password value

      • withPassword

        public NodeUpdateUserParameter 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. If omitted, any existing password is removed.
        Parameters:
        password - the password value to set
        Returns:
        the NodeUpdateUserParameter 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 NodeUpdateUserParameter 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 NodeUpdateUserParameter 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). If omitted, any existing SSH public key is removed.
        Returns:
        the sshPublicKey value

      • withSshPublicKey

        public NodeUpdateUserParameter 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). If omitted, any existing SSH public key is removed.
        Parameters:
        sshPublicKey - the sshPublicKey value to set
        Returns:
        the NodeUpdateUserParameter object itself.