156 строки
10 KiB
YAML
156 строки
10 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser"
|
|
name: "ComputeNodeUser"
|
|
nameWithType: "ComputeNodeUser"
|
|
summary: "A user Account for RDP or SSH access on a Compute 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 class **ComputeNodeUser**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.ComputeNodeUser()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.ComputeNodeUser()"
|
|
name: "ComputeNodeUser()"
|
|
nameWithType: "ComputeNodeUser.ComputeNodeUser()"
|
|
syntax: "public ComputeNodeUser()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.expiryTime()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.expiryTime()"
|
|
name: "expiryTime()"
|
|
nameWithType: "ComputeNodeUser.expiryTime()"
|
|
summary: "Get if omitted, the default is 1 day from the current time."
|
|
syntax: "public DateTime expiryTime()"
|
|
desc: "Get if omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day."
|
|
returns:
|
|
description: "the expiryTime value"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.isAdmin()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.isAdmin()"
|
|
name: "isAdmin()"
|
|
nameWithType: "ComputeNodeUser.isAdmin()"
|
|
summary: "Get the default value is false."
|
|
syntax: "public Boolean isAdmin()"
|
|
desc: "Get the default value is false."
|
|
returns:
|
|
description: "the isAdmin value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.name()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.name()"
|
|
name: "name()"
|
|
nameWithType: "ComputeNodeUser.name()"
|
|
summary: "Get the name value."
|
|
syntax: "public String name()"
|
|
desc: "Get the name value."
|
|
returns:
|
|
description: "the name value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.password()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.password()"
|
|
name: "password()"
|
|
nameWithType: "ComputeNodeUser.password()"
|
|
summary: "Get the password is required for Windows Compute Nodes."
|
|
syntax: "public String password()"
|
|
desc: "Get the password is required for Windows Compute Nodes. For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property."
|
|
returns:
|
|
description: "the password value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.sshPublicKey()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.sshPublicKey()"
|
|
name: "sshPublicKey()"
|
|
nameWithType: "ComputeNodeUser.sshPublicKey()"
|
|
summary: "Get the public key should be compatible with OpenSSH encoding and should be base 64 encoded."
|
|
syntax: "public String sshPublicKey()"
|
|
desc: "Get the public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)."
|
|
returns:
|
|
description: "the sshPublicKey value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.withExpiryTime(org.joda.time.DateTime)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.withExpiryTime(DateTime expiryTime)"
|
|
name: "withExpiryTime(DateTime expiryTime)"
|
|
nameWithType: "ComputeNodeUser.withExpiryTime(DateTime expiryTime)"
|
|
summary: "Set if omitted, the default is 1 day from the current time."
|
|
parameters:
|
|
- description: "the expiryTime value to set"
|
|
name: "expiryTime"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ComputeNodeUser withExpiryTime(DateTime expiryTime)"
|
|
desc: "Set if omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day."
|
|
returns:
|
|
description: "the ComputeNodeUser object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeUser?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeUser&text=ComputeNodeUser\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.withIsAdmin(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.withIsAdmin(Boolean isAdmin)"
|
|
name: "withIsAdmin(Boolean isAdmin)"
|
|
nameWithType: "ComputeNodeUser.withIsAdmin(Boolean isAdmin)"
|
|
summary: "Set the default value is false."
|
|
parameters:
|
|
- description: "the isAdmin value to set"
|
|
name: "isAdmin"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public ComputeNodeUser withIsAdmin(Boolean isAdmin)"
|
|
desc: "Set the default value is false."
|
|
returns:
|
|
description: "the ComputeNodeUser object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeUser?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeUser&text=ComputeNodeUser\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.withName(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.withName(String name)"
|
|
name: "withName(String name)"
|
|
nameWithType: "ComputeNodeUser.withName(String name)"
|
|
summary: "Set the name value."
|
|
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 ComputeNodeUser withName(String name)"
|
|
desc: "Set the name value."
|
|
returns:
|
|
description: "the ComputeNodeUser object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeUser?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeUser&text=ComputeNodeUser\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.withPassword(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.withPassword(String password)"
|
|
name: "withPassword(String password)"
|
|
nameWithType: "ComputeNodeUser.withPassword(String password)"
|
|
summary: "Set the password is required for Windows Compute Nodes."
|
|
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 ComputeNodeUser withPassword(String password)"
|
|
desc: "Set the password is required for Windows Compute Nodes. For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property."
|
|
returns:
|
|
description: "the ComputeNodeUser object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeUser?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeUser&text=ComputeNodeUser\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.withSshPublicKey(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ComputeNodeUser.withSshPublicKey(String sshPublicKey)"
|
|
name: "withSshPublicKey(String sshPublicKey)"
|
|
nameWithType: "ComputeNodeUser.withSshPublicKey(String sshPublicKey)"
|
|
summary: "Set the public key should be compatible with OpenSSH encoding and should be base 64 encoded."
|
|
parameters:
|
|
- description: "the sshPublicKey value to set"
|
|
name: "sshPublicKey"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ComputeNodeUser withSshPublicKey(String sshPublicKey)"
|
|
desc: "Set the public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)."
|
|
returns:
|
|
description: "the ComputeNodeUser object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeUser?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeUser&text=ComputeNodeUser\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A user Account for RDP or SSH access on a Compute Node."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.batch.protocol.models"
|
|
artifact: com.microsoft.azure:azure-batch:11.2.0
|