Share via


IComputeNodeOperations.UpdateUserWithHttpMessagesAsync Method

Definition

Updates the password and expiration time of a user Account on the specified Compute Node.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeUpdateUserHeaders>> UpdateUserWithHttpMessagesAsync (string poolId, string nodeId, string userName, Microsoft.Azure.Batch.Protocol.Models.NodeUpdateUserParameter nodeUpdateUserParameter, Microsoft.Azure.Batch.Protocol.Models.ComputeNodeUpdateUserOptions computeNodeUpdateUserOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member UpdateUserWithHttpMessagesAsync : string * string * string * Microsoft.Azure.Batch.Protocol.Models.NodeUpdateUserParameter * Microsoft.Azure.Batch.Protocol.Models.ComputeNodeUpdateUserOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeUpdateUserHeaders>>
Public Function UpdateUserWithHttpMessagesAsync (poolId As String, nodeId As String, userName As String, nodeUpdateUserParameter As NodeUpdateUserParameter, Optional computeNodeUpdateUserOptions As ComputeNodeUpdateUserOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationHeaderResponse(Of ComputeNodeUpdateUserHeaders))

Parameters

poolId
String

The ID of the Pool that contains the Compute Node.

nodeId
String

The ID of the machine on which you want to update a user Account.

userName
String

The name of the user Account to update.

nodeUpdateUserParameter
NodeUpdateUserParameter

The parameters for the request.

computeNodeUpdateUserOptions
ComputeNodeUpdateUserOptions

Additional parameters for the operation

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Remarks

This operation replaces of all the updatable properties of the Account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user Account on a Compute Node only when it is in the idle or running state.

Applies to