198 строки
15 KiB
YAML
198 строки
15 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.batch.models.UserAccount"
|
|
fullName: "com.azure.resourcemanager.batch.models.UserAccount"
|
|
name: "UserAccount"
|
|
nameWithType: "UserAccount"
|
|
summary: "Properties used to create a user on an Azure Batch node."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **UserAccount**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.batch.models.UserAccount?alt=com.azure.resourcemanager.batch.models.UserAccount&text=UserAccount\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.batch.models.UserAccount.UserAccount()"
|
|
fullName: "com.azure.resourcemanager.batch.models.UserAccount.UserAccount()"
|
|
name: "UserAccount()"
|
|
nameWithType: "UserAccount.UserAccount()"
|
|
summary: "Creates an instance of User<wbr>Account class."
|
|
syntax: "public UserAccount()"
|
|
desc: "Creates an instance of UserAccount class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.batch.models.UserAccount.elevationLevel()"
|
|
fullName: "com.azure.resourcemanager.batch.models.UserAccount.elevationLevel()"
|
|
name: "elevationLevel()"
|
|
nameWithType: "UserAccount.elevationLevel()"
|
|
summary: "Get the elevation<wbr>Level property: non<wbr>Admin - The auto user is a standard user without elevated access."
|
|
syntax: "public ElevationLevel elevationLevel()"
|
|
desc: "Get the elevationLevel property: 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:
|
|
description: "the elevationLevel value."
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.ElevationLevel?alt=com.azure.resourcemanager.batch.models.ElevationLevel&text=ElevationLevel\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.batch.models.UserAccount.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.batch.models.UserAccount.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "UserAccount.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of User<wbr>Account from the Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static UserAccount fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If the deserialized JSON object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of UserAccount from the JsonReader."
|
|
returns:
|
|
description: "An instance of UserAccount if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.UserAccount?alt=com.azure.resourcemanager.batch.models.UserAccount&text=UserAccount\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.batch.models.UserAccount.linuxUserConfiguration()"
|
|
fullName: "com.azure.resourcemanager.batch.models.UserAccount.linuxUserConfiguration()"
|
|
name: "linuxUserConfiguration()"
|
|
nameWithType: "UserAccount.linuxUserConfiguration()"
|
|
summary: "Get the linux<wbr>User<wbr>Configuration property: This property is ignored if specified on a Windows pool."
|
|
syntax: "public LinuxUserConfiguration linuxUserConfiguration()"
|
|
desc: "Get the linuxUserConfiguration property: This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options."
|
|
returns:
|
|
description: "the linuxUserConfiguration value."
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.LinuxUserConfiguration?alt=com.azure.resourcemanager.batch.models.LinuxUserConfiguration&text=LinuxUserConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.batch.models.UserAccount.name()"
|
|
fullName: "com.azure.resourcemanager.batch.models.UserAccount.name()"
|
|
name: "name()"
|
|
nameWithType: "UserAccount.name()"
|
|
summary: "Get the name property: The name of the user account."
|
|
syntax: "public String name()"
|
|
desc: "Get the name property: The name of the user account. Names can contain any Unicode characters up to a maximum length of 20."
|
|
returns:
|
|
description: "the name value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.batch.models.UserAccount.password()"
|
|
fullName: "com.azure.resourcemanager.batch.models.UserAccount.password()"
|
|
name: "password()"
|
|
nameWithType: "UserAccount.password()"
|
|
summary: "Get the password property: The password for the user account."
|
|
syntax: "public String password()"
|
|
desc: "Get the password property: The password for the user account."
|
|
returns:
|
|
description: "the password value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.batch.models.UserAccount.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.batch.models.UserAccount.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "UserAccount.toJson(JsonWriter jsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.batch.models.UserAccount.validate()"
|
|
fullName: "com.azure.resourcemanager.batch.models.UserAccount.validate()"
|
|
name: "validate()"
|
|
nameWithType: "UserAccount.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.batch.models.UserAccount.windowsUserConfiguration()"
|
|
fullName: "com.azure.resourcemanager.batch.models.UserAccount.windowsUserConfiguration()"
|
|
name: "windowsUserConfiguration()"
|
|
nameWithType: "UserAccount.windowsUserConfiguration()"
|
|
summary: "Get the windows<wbr>User<wbr>Configuration property: This property can only be specified if the user is on a Windows pool."
|
|
syntax: "public WindowsUserConfiguration windowsUserConfiguration()"
|
|
desc: "Get the windowsUserConfiguration property: 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:
|
|
description: "the windowsUserConfiguration value."
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.WindowsUserConfiguration?alt=com.azure.resourcemanager.batch.models.WindowsUserConfiguration&text=WindowsUserConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.batch.models.UserAccount.withElevationLevel(com.azure.resourcemanager.batch.models.ElevationLevel)"
|
|
fullName: "com.azure.resourcemanager.batch.models.UserAccount.withElevationLevel(ElevationLevel elevationLevel)"
|
|
name: "withElevationLevel(ElevationLevel elevationLevel)"
|
|
nameWithType: "UserAccount.withElevationLevel(ElevationLevel elevationLevel)"
|
|
summary: "Set the elevation<wbr>Level property: non<wbr>Admin - The auto user is a standard user without elevated access."
|
|
parameters:
|
|
- description: "the elevationLevel value to set."
|
|
name: "elevationLevel"
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.ElevationLevel?alt=com.azure.resourcemanager.batch.models.ElevationLevel&text=ElevationLevel\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public UserAccount withElevationLevel(ElevationLevel elevationLevel)"
|
|
desc: "Set the elevationLevel property: 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:
|
|
description: "the UserAccount object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.UserAccount?alt=com.azure.resourcemanager.batch.models.UserAccount&text=UserAccount\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.batch.models.UserAccount.withLinuxUserConfiguration(com.azure.resourcemanager.batch.models.LinuxUserConfiguration)"
|
|
fullName: "com.azure.resourcemanager.batch.models.UserAccount.withLinuxUserConfiguration(LinuxUserConfiguration linuxUserConfiguration)"
|
|
name: "withLinuxUserConfiguration(LinuxUserConfiguration linuxUserConfiguration)"
|
|
nameWithType: "UserAccount.withLinuxUserConfiguration(LinuxUserConfiguration linuxUserConfiguration)"
|
|
summary: "Set the linux<wbr>User<wbr>Configuration property: This property is ignored if specified on a Windows pool."
|
|
parameters:
|
|
- description: "the linuxUserConfiguration value to set."
|
|
name: "linuxUserConfiguration"
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.LinuxUserConfiguration?alt=com.azure.resourcemanager.batch.models.LinuxUserConfiguration&text=LinuxUserConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public UserAccount withLinuxUserConfiguration(LinuxUserConfiguration linuxUserConfiguration)"
|
|
desc: "Set the linuxUserConfiguration property: This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options."
|
|
returns:
|
|
description: "the UserAccount object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.UserAccount?alt=com.azure.resourcemanager.batch.models.UserAccount&text=UserAccount\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.batch.models.UserAccount.withName(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.batch.models.UserAccount.withName(String name)"
|
|
name: "withName(String name)"
|
|
nameWithType: "UserAccount.withName(String name)"
|
|
summary: "Set the name property: The name of the user account."
|
|
parameters:
|
|
- description: "the name value to set."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public UserAccount withName(String name)"
|
|
desc: "Set the name property: The name of the user account. Names can contain any Unicode characters up to a maximum length of 20."
|
|
returns:
|
|
description: "the UserAccount object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.UserAccount?alt=com.azure.resourcemanager.batch.models.UserAccount&text=UserAccount\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.batch.models.UserAccount.withPassword(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.batch.models.UserAccount.withPassword(String password)"
|
|
name: "withPassword(String password)"
|
|
nameWithType: "UserAccount.withPassword(String password)"
|
|
summary: "Set the password property: The password for the user account."
|
|
parameters:
|
|
- description: "the password value to set."
|
|
name: "password"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public UserAccount withPassword(String password)"
|
|
desc: "Set the password property: The password for the user account."
|
|
returns:
|
|
description: "the UserAccount object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.UserAccount?alt=com.azure.resourcemanager.batch.models.UserAccount&text=UserAccount\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.batch.models.UserAccount.withWindowsUserConfiguration(com.azure.resourcemanager.batch.models.WindowsUserConfiguration)"
|
|
fullName: "com.azure.resourcemanager.batch.models.UserAccount.withWindowsUserConfiguration(WindowsUserConfiguration windowsUserConfiguration)"
|
|
name: "withWindowsUserConfiguration(WindowsUserConfiguration windowsUserConfiguration)"
|
|
nameWithType: "UserAccount.withWindowsUserConfiguration(WindowsUserConfiguration windowsUserConfiguration)"
|
|
summary: "Set the windows<wbr>User<wbr>Configuration property: This property can only be specified if the user is on a Windows pool."
|
|
parameters:
|
|
- description: "the windowsUserConfiguration value to set."
|
|
name: "windowsUserConfiguration"
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.WindowsUserConfiguration?alt=com.azure.resourcemanager.batch.models.WindowsUserConfiguration&text=WindowsUserConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public UserAccount withWindowsUserConfiguration(WindowsUserConfiguration windowsUserConfiguration)"
|
|
desc: "Set the windowsUserConfiguration property: 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:
|
|
description: "the UserAccount object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.UserAccount?alt=com.azure.resourcemanager.batch.models.UserAccount&text=UserAccount\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Properties used to create a user on an Azure Batch node."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.batch.models.UserAccount?alt=com.azure.resourcemanager.batch.models.UserAccount&text=UserAccount\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.batch.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-batch:2.0.0
|