NodeUpdateUserParameter Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
Maven Artifact:
com.microsoft.azure:azure-batch:11.2.0
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.NodeUpdateUserParameter

public class NodeUpdateUserParameter

The set of changes to be made to a user Account on a Compute Node.

Constructor Summary

Constructor Description
NodeUpdateUserParameter()

Method Summary

Modifier and Type Method and Description
org.joda.time.DateTime expiryTime()

Get if omitted, the default is 1 day from the current time.
String password()

Get the password is required for Windows Compute Nodes.
String sshPublicKey()

Get the public key should be compatible with OpenSSH encoding and should be base 64 encoded.
NodeUpdateUserParameter withExpiryTime(DateTime expiryTime)

Set if omitted, the default is 1 day from the current time.
NodeUpdateUserParameter withPassword(String password)

Set the password is required for Windows Compute Nodes.
NodeUpdateUserParameter withSshPublicKey(String sshPublicKey)

Set the public key should be compatible with OpenSSH encoding and should be base 64 encoded.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

NodeUpdateUserParameter

public NodeUpdateUserParameter()

Method Details

expiryTime

public 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

password

public String password()

Get the password is required for Windows Compute Nodes. 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

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

withExpiryTime

public NodeUpdateUserParameter withExpiryTime(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.

withPassword

public NodeUpdateUserParameter withPassword(String password)

Set the password is required for Windows Compute Nodes. 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.

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.

Applies to