PoolOperations.DeleteComputeNodeUserAsync 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.
Deletes the specified user account from the specified compute node.
public System.Threading.Tasks.Task DeleteComputeNodeUserAsync (string poolId, string computeNodeId, string userName, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);
member this.DeleteComputeNodeUserAsync : string * string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function DeleteComputeNodeUserAsync (poolId As String, computeNodeId As String, userName As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task
Parameters
- poolId
- String
The id of the pool that contains the compute node.
- computeNodeId
- String
The id of the compute node from which you want to delete the user account.
- userName
- String
The name of the user account to be deleted.
- additionalBehaviors
- IEnumerable<BatchClientBehavior>
A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.
- cancellationToken
- CancellationToken
A CancellationToken for controlling the lifetime of the asynchronous operation.
Returns
A Task that represents the asynchronous operation.
Remarks
You can delete a user account from a compute node only when it is in the Idle or Running state.
The delete operation runs asynchronously.