Share via


AutoUserSpecification Class

  • java.lang.Object
    • com.azure.compute.batch.models.AutoUserSpecification

Implements

public final class AutoUserSpecification
implements JsonSerializable<AutoUserSpecification>

Specifies the options for the auto user that runs an Azure Batch Task.

Constructor Summary

Constructor Description
AutoUserSpecification()

Creates an instance of AutoUserSpecification class.

Method Summary

Modifier and Type Method and Description
static AutoUserSpecification fromJson(JsonReader jsonReader)

Reads an instance of AutoUserSpecification from the JsonReader.

ElevationLevel getElevationLevel()

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

AutoUserScope getScope()

Get the scope property: The scope for the auto user.

AutoUserSpecification setElevationLevel(ElevationLevel elevationLevel)

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

AutoUserSpecification setScope(AutoUserScope scope)

Set the scope property: The scope for the auto user.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Constructor Details

AutoUserSpecification

public AutoUserSpecification()

Creates an instance of AutoUserSpecification class.

Method Details

fromJson

public static AutoUserSpecification fromJson(JsonReader jsonReader)

Reads an instance of AutoUserSpecification from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AutoUserSpecification if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the AutoUserSpecification.

getElevationLevel

public ElevationLevel getElevationLevel()

Get the elevationLevel property: The elevation level of the auto user. The default value is nonAdmin.

Returns:

the elevationLevel value.

getScope

public AutoUserScope getScope()

Get the scope property: The scope for the auto user. The default value is pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by StartTasks.

Returns:

the scope value.

setElevationLevel

public AutoUserSpecification setElevationLevel(ElevationLevel elevationLevel)

Set the elevationLevel property: The elevation level of the auto user. The default value is nonAdmin.

Parameters:

elevationLevel - the elevationLevel value to set.

Returns:

the AutoUserSpecification object itself.

setScope

public AutoUserSpecification setScope(AutoUserScope scope)

Set the scope property: The scope for the auto user. The default value is pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by StartTasks.

Parameters:

scope - the scope value to set.

Returns:

the AutoUserSpecification object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to