UserAccount Class

  • java.lang.Object
    • com.azure.resourcemanager.batch.models.UserAccount

public final class UserAccount

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

Constructor Summary

Constructor Description
UserAccount()

Creates an instance of UserAccount class.

Method Summary

Modifier and Type Method and Description
ElevationLevel elevationLevel()

Get the elevationLevel property: The elevation level of the user.

LinuxUserConfiguration linuxUserConfiguration()

Get the linuxUserConfiguration property: Properties used to create a user account on a Linux node.

String name()

Get the name property: The name of the user account.

String password()

Get the password property: The password for the user account.

void validate()

Validates the instance.

WindowsUserConfiguration windowsUserConfiguration()

Get the windowsUserConfiguration property: Properties used to create a user account on a Windows node.

UserAccount withElevationLevel(ElevationLevel elevationLevel)

Set the elevationLevel property: The elevation level of the user.

UserAccount withLinuxUserConfiguration(LinuxUserConfiguration linuxUserConfiguration)

Set the linuxUserConfiguration property: Properties used to create a user account on a Linux node.

UserAccount withName(String name)

Set the name property: The name of the user account.

UserAccount withPassword(String password)

Set the password property: The password for the user account.

UserAccount withWindowsUserConfiguration(WindowsUserConfiguration windowsUserConfiguration)

Set the windowsUserConfiguration property: Properties used to create a user account on a Windows node.

Methods inherited from java.lang.Object

Constructor Details

UserAccount

public UserAccount()

Creates an instance of UserAccount class.

Method Details

elevationLevel

public ElevationLevel elevationLevel()

Get the elevationLevel property: The elevation level of the user. 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.

Returns:

the elevationLevel value.

linuxUserConfiguration

public LinuxUserConfiguration linuxUserConfiguration()

Get the linuxUserConfiguration property: Properties used to create a user account on a Linux node. This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.

Returns:

the linuxUserConfiguration value.

name

public String name()

Get the name property: The name of the user account. Names can contain any Unicode characters up to a maximum length of 20.

Returns:

the name value.

password

public String password()

Get the password property: The password for the user account.

Returns:

the password value.

validate

public void validate()

Validates the instance.

windowsUserConfiguration

public WindowsUserConfiguration windowsUserConfiguration()

Get the windowsUserConfiguration property: Properties used to create a user account on a Windows node. 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.

Returns:

the windowsUserConfiguration value.

withElevationLevel

public UserAccount withElevationLevel(ElevationLevel elevationLevel)

Set the elevationLevel property: The elevation level of the user. 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.

Parameters:

elevationLevel - the elevationLevel value to set.

Returns:

the UserAccount object itself.

withLinuxUserConfiguration

public UserAccount withLinuxUserConfiguration(LinuxUserConfiguration linuxUserConfiguration)

Set the linuxUserConfiguration property: Properties used to create a user account on a Linux node. This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.

Parameters:

linuxUserConfiguration - the linuxUserConfiguration value to set.

Returns:

the UserAccount object itself.

withName

public UserAccount withName(String name)

Set the name property: The name of the user account. Names can contain any Unicode characters up to a maximum length of 20.

Parameters:

name - the name value to set.

Returns:

the UserAccount object itself.

withPassword

public UserAccount withPassword(String password)

Set the password property: The password for the user account.

Parameters:

password - the password value to set.

Returns:

the UserAccount object itself.

withWindowsUserConfiguration

public UserAccount withWindowsUserConfiguration(WindowsUserConfiguration windowsUserConfiguration)

Set the windowsUserConfiguration property: Properties used to create a user account on a Windows node. 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.

Parameters:

windowsUserConfiguration - the windowsUserConfiguration value to set.

Returns:

the UserAccount object itself.

Applies to