UserAccount Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
Maven Artifact:
com.microsoft.azure:azure-batch:11.2.0
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.UserAccount

public class UserAccount

Properties used to create a user used to execute Tasks on an Azure Batch Compute Node.

Constructor Summary

Constructor Description
UserAccount()

Method Summary

Modifier and Type Method and Description
ElevationLevel elevationLevel()

Get the default value is nonAdmin.
LinuxUserConfiguration linuxUserConfiguration()

Get this property is ignored if specified on a Windows Pool.
String name()

Get the name value.
String password()

Get the password value.
WindowsUserConfiguration windowsUserConfiguration()

Get this property can only be specified if the user is on a Windows Pool.
UserAccount withElevationLevel(ElevationLevel elevationLevel)

Set the default value is nonAdmin.
UserAccount withLinuxUserConfiguration(LinuxUserConfiguration linuxUserConfiguration)

Set this property is ignored if specified on a Windows Pool.
UserAccount withName(String name)

Set the name value.
UserAccount withPassword(String password)

Set the password value.
UserAccount withWindowsUserConfiguration(WindowsUserConfiguration windowsUserConfiguration)

Set this property can only be specified if the user is on a Windows Pool.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

UserAccount

public UserAccount()

Method Details

elevationLevel

public ElevationLevel elevationLevel()

Get the default value is nonAdmin. Possible values include: 'nonAdmin', 'admin'.

Returns:

the elevationLevel value

linuxUserConfiguration

public LinuxUserConfiguration linuxUserConfiguration()

Get 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 value.

Returns:

the name value

password

public String password()

Get the password value.

Returns:

the password value

windowsUserConfiguration

public WindowsUserConfiguration windowsUserConfiguration()

Get 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 default value is nonAdmin. Possible values include: 'nonAdmin', 'admin'.

Parameters:

elevationLevel - the elevationLevel value to set

Returns:

the UserAccount object itself.

withLinuxUserConfiguration

public UserAccount withLinuxUserConfiguration(LinuxUserConfiguration linuxUserConfiguration)

Set 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 value.

Parameters:

name - the name value to set

Returns:

the UserAccount object itself.

withPassword

public UserAccount withPassword(String password)

Set the password value.

Parameters:

password - the password value to set

Returns:

the UserAccount object itself.

withWindowsUserConfiguration

public UserAccount withWindowsUserConfiguration(WindowsUserConfiguration windowsUserConfiguration)

Set 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