ComputeNodeUser Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. ComputeNodeUser
- com.
public class ComputeNodeUser
A user account for RDP or SSH access on a compute 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. |
Boolean |
isAdmin()
Get the default value is false. |
String |
name()
Get the name value. |
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. |
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). |
Compute |
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. |
Compute |
withIsAdmin(Boolean isAdmin)
Set the default value is false. |
Compute |
withName(String name)
Set the name value. |
Compute |
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. |
Compute |
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). |
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:
isAdmin
public Boolean isAdmin()
Get the default value is false.
Returns:
name
public String name()
Get the name value.
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.
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).
Returns:
withExpiryTime
public ComputeNodeUser 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:
withIsAdmin
public ComputeNodeUser withIsAdmin(Boolean isAdmin)
Set the default value is false.
Parameters:
Returns:
withName
public ComputeNodeUser withName(String name)
Set the name value.
Parameters:
Returns:
withPassword
public ComputeNodeUser 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.
Parameters:
Returns:
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 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).
Parameters:
Returns:
Applies to
Azure SDK for Java