ComputeNodeUser Class

A user Account for RDP or SSH access on a Compute Node.

All required parameters must be populated in order to send to Azure.

Inheritance
Model
ComputeNodeUser

Constructor

ComputeNodeUser(*, name: str, is_admin: bool = None, expiry_time=None, password: str = None, ssh_public_key: str = None, **kwargs) -> None

Parameters

name
str

Required. The user name of the Account.

is_admin
bool

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

expiry_time
datetime

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.

password
str

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.

ssh_public_key
str

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).