ComputeNodeUser interface

Package:

@azure/batch

An interface representing ComputeNodeUser.

Properties

expiryTime	The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day.
isAdmin	Whether the Account should be an administrator on the Compute Node. The default value is false.
name	The user name of the Account.
password	The password of the Account. 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.
sshPublicKey	The SSH public key that can be used for remote login to the Compute Node. 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).

Property Details

expiryTime

The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day.

expiryTime?: Date

Property Value

Date

isAdmin

Whether the Account should be an administrator on the Compute Node. The default value is false.

isAdmin?: boolean

Property Value

boolean

name

The user name of the Account.

name: string

Property Value

string

password

The password of the Account. 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.

password?: string

Property Value

string

sshPublicKey

The SSH public key that can be used for remote login to the Compute Node. 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).

sshPublicKey?: string

Property Value

string