NodeUpdateUserParameter Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. NodeUpdateUserParameter
- com.
public class NodeUpdateUserParameter
The set of changes to be made to a user account on a node.
Method Summary
Modifier and Type | Method and Description |
---|---|
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. |
String |
password()
Get the password is required for Windows 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. |
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 nodes. If this is specified for a Windows 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. |
Node |
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. |
Node |
withPassword(String password)
Set the password is required for Windows 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. |
Node |
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 nodes. If this is specified for a Windows 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. |
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:
password
public String password()
Get the password is required for Windows 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:
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 nodes. If this is specified for a Windows 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:
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:
Returns:
withPassword
public NodeUpdateUserParameter withPassword(String password)
Set the password is required for Windows 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:
Returns:
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 nodes. If this is specified for a Windows 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:
Returns:
Applies to
Azure SDK for Java