Share via

UserAccount Class

  • Reference

Properties used to create a user on an Azure Batch node.

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

Inheritance
azure.mgmt.batch._serialization.Model
UserAccount

Constructor

UserAccount(*, name: str, password: str, elevation_level: str | _models.ElevationLevel | None = None, linux_user_configuration: _models.LinuxUserConfiguration | None = None, windows_user_configuration: _models.WindowsUserConfiguration | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
name
str

The name of the user account. Names can contain any Unicode characters up to a maximum length of 20. Required.
password
str

The password for the user account. Required.
elevation_level
str or 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. Known values are: "NonAdmin" and "Admin".
linux_user_configuration
LinuxUserConfiguration

This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.
windows_user_configuration
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.

Variables

Name Description
name
str

The name of the user account. Names can contain any Unicode characters up to a maximum length of 20. Required.
password
str

The password for the user account. Required.
elevation_level
str or 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. Known values are: "NonAdmin" and "Admin".
linux_user_configuration
LinuxUserConfiguration

This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.
windows_user_configuration
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.