LinuxUserConfiguration | @azure/batch

An interface representing LinuxUserConfiguration.

summary: Properties used to create a user account on a Linux node.

Hierarchy

LinuxUserConfiguration

Index

Properties

Optional gid

gid: undefined | number

The group ID for the user account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.

Optional sshPrivateKey

sshPrivateKey: undefined | string

The SSH private key for the user account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).

Optional uid

uid: undefined | number

The user ID of the user account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.