UserAccount interface
Properties used to create a user on an Azure Batch node.
Properties
elevation |
nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. |
linux |
This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. |
name | The name of the user account. Names can contain any Unicode characters up to a maximum length of 20. |
password | The password for the user account. |
windows |
This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options. |
Property Details
elevationLevel
nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.
elevationLevel?: ElevationLevel
Property Value
linuxUserConfiguration
This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.
linuxUserConfiguration?: LinuxUserConfiguration
Property Value
name
The name of the user account. Names can contain any Unicode characters up to a maximum length of 20.
name: string
Property Value
string
password
The password for the user account.
password: string
Property Value
string
windowsUserConfiguration
This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.
windowsUserConfiguration?: WindowsUserConfiguration