ComputeBatchModelFactory.BatchNodeUserUpdateOptions Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Parameters for updating a user account for RDP or SSH access on an Azure Batch Compute Node.
public static Azure.Compute.Batch.BatchNodeUserUpdateOptions BatchNodeUserUpdateOptions(string password = default, DateTimeOffset? expiryTime = default, string sshPublicKey = default);static member BatchNodeUserUpdateOptions : string * Nullable<DateTimeOffset> * string -> Azure.Compute.Batch.BatchNodeUserUpdateOptionsPublic Shared Function BatchNodeUserUpdateOptions (Optional password As String = Nothing, Optional expiryTime As Nullable(Of DateTimeOffset) = Nothing, Optional sshPublicKey As String = Nothing) As BatchNodeUserUpdateOptionsParameters
- password
- String
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.
- expiryTime
- Nullable<DateTimeOffset>
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.
- sshPublicKey
- String
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
A new BatchNodeUserUpdateOptions instance for mocking.
