Share via

ComputeNodeUser Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.ComputeNodeUser

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).
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.
ComputeNodeUser withIsAdmin(Boolean isAdmin)

Set the default value is false.
ComputeNodeUser withName(String name)

Set the name value.
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.
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).

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

isAdmin

public Boolean isAdmin()

Get the default value is false.

Returns:

the isAdmin value

name

public String name()

Get the name value.

Returns:

the name value

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:

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 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:

the sshPublicKey value

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:

expiryTime - the expiryTime value to set

Returns:

the ComputeNodeUser object itself.

withIsAdmin

public ComputeNodeUser withIsAdmin(Boolean isAdmin)

Set the default value is false.

Parameters:

isAdmin - the isAdmin value to set

Returns:

the ComputeNodeUser object itself.

withName

public ComputeNodeUser withName(String name)

Set the name value.

Parameters:

name - the name value to set

Returns:

the ComputeNodeUser object itself.

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:

password - the password value to set

Returns:

the ComputeNodeUser object itself.

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:

sshPublicKey - the sshPublicKey value to set

Returns:

the ComputeNodeUser object itself.

Applies to