BatchNodeUserUpdateParameters Class

Package:
com.azure.compute.batch.models
Maven Artifact:
com.azure:azure-compute-batch:1.0.0-beta.6
  • java.lang.Object
    • com.azure.compute.batch.models.BatchNodeUserUpdateParameters

Implements

JsonSerializable<BatchNodeUserUpdateParameters>

public final class BatchNodeUserUpdateParameters
implements JsonSerializable<BatchNodeUserUpdateParameters>

Parameters for updating a user account for RDP or SSH access on an Azure Batch Compute Node.

Constructor Summary

Constructor Description
BatchNodeUserUpdateParameters()

Creates an instance of BatchNodeUserUpdateParameters class.

Method Summary

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

Reads an instance of BatchNodeUserUpdateParameters from the JsonReader.
OffsetDateTime getExpiryTime()

Get the expiryTime property: The time at which the Account should expire.
String getPassword()

Get the password property: The password of the Account.
String getSshPublicKey()

Get the sshPublicKey property: The SSH public key that can be used for remote login to the Compute Node.
BatchNodeUserUpdateParameters setExpiryTime(OffsetDateTime expiryTime)

Set the expiryTime property: The time at which the Account should expire.
BatchNodeUserUpdateParameters setPassword(String password)

Set the password property: The password of the Account.
BatchNodeUserUpdateParameters setSshPublicKey(String sshPublicKey)

Set the sshPublicKey property: The SSH public key that can be used for remote login to the Compute Node.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BatchNodeUserUpdateParameters

public BatchNodeUserUpdateParameters()

Creates an instance of BatchNodeUserUpdateParameters class.

Method Details

fromJson

public static BatchNodeUserUpdateParameters fromJson(JsonReader jsonReader)

Reads an instance of BatchNodeUserUpdateParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BatchNodeUserUpdateParameters 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 BatchNodeUserUpdateParameters.

getExpiryTime

public OffsetDateTime getExpiryTime()

Get the expiryTime property: The time at which the Account should expire. 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:

the expiryTime value.

getPassword

public String getPassword()

Get the password property: The password of the Account. The password is required for Windows Compute Nodes. For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property. If omitted, any existing password is removed.

Returns:

the password value.

getSshPublicKey

public String getSshPublicKey()

Get the sshPublicKey property: The SSH public key that can be used for remote login to the Compute Node. 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). If omitted, any existing SSH public key is removed.

Returns:

the sshPublicKey value.

setExpiryTime

public BatchNodeUserUpdateParameters setExpiryTime(OffsetDateTime expiryTime)

Set the expiryTime property: The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day.

Parameters:

expiryTime - the expiryTime value to set.

Returns:

the BatchNodeUserUpdateParameters object itself.

setPassword

public BatchNodeUserUpdateParameters setPassword(String password)

Set the password property: The password of the Account. The password is required for Windows Compute Nodes. For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property. If omitted, any existing password is removed.

Parameters:

password - the password value to set.

Returns:

the BatchNodeUserUpdateParameters object itself.

setSshPublicKey

public BatchNodeUserUpdateParameters setSshPublicKey(String sshPublicKey)

Set the sshPublicKey property: The SSH public key that can be used for remote login to the Compute Node. 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). If omitted, any existing SSH public key is removed.

Parameters:

sshPublicKey - the sshPublicKey value to set.

Returns:

the BatchNodeUserUpdateParameters object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to