Package com.azure.compute.batch.models

Class BatchNodeUserUpdateContent

java.lang.Object
com.azure.compute.batch.models.BatchNodeUserUpdateContent
All Implemented Interfaces:
com.azure.json.JsonSerializable<BatchNodeUserUpdateContent>
public final class BatchNodeUserUpdateContent extends Object implements com.azure.json.JsonSerializable<BatchNodeUserUpdateContent>
Parameters for updating a user account for RDP or SSH access on an Azure Batch Compute Node.

  • Constructor Details

    • BatchNodeUserUpdateContent

      public BatchNodeUserUpdateContent()
      Creates an instance of BatchNodeUserUpdateContent class.

  • Method Details

    • 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.

    • setPassword

      public BatchNodeUserUpdateContent 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 BatchNodeUserUpdateContent object itself.

    • 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.

    • setExpiryTime

      public BatchNodeUserUpdateContent 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 BatchNodeUserUpdateContent object itself.

    • 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.

    • setSshPublicKey

      public BatchNodeUserUpdateContent 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 BatchNodeUserUpdateContent object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<BatchNodeUserUpdateContent>
      Throws:
      IOException

    • fromJson

      public static BatchNodeUserUpdateContent fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of BatchNodeUserUpdateContent from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of BatchNodeUserUpdateContent 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 BatchNodeUserUpdateContent.