PoolOperations.DeleteComputeNodeUserAsync Method (String, String, String, IEnumerable<BatchClientBehavior>)

Deletes the specified user account from the specified compute node.

Namespace:   Microsoft.Azure.Batch
Assembly:  Microsoft.Azure.Batch (in Microsoft.Azure.Batch.dll)

Syntax

public Task DeleteComputeNodeUserAsync(
    string poolId,
    string computeNodeId,
    string userName,
    IEnumerable<BatchClientBehavior> additionalBehaviors = null
)

public:
Task^ DeleteComputeNodeUserAsync(
    String^ poolId,
    String^ computeNodeId,
    String^ userName,
    IEnumerable<BatchClientBehavior^>^ additionalBehaviors = null
)

member DeleteComputeNodeUserAsync : 
        poolId:string *
        computeNodeId:string *
        userName:string *
        additionalBehaviors:IEnumerable<BatchClientBehavior> = null -> Task

Public Function DeleteComputeNodeUserAsync (
    poolId As String,
    computeNodeId As String,
    userName As String,
    additionalBehaviors As IEnumerable(Of BatchClientBehavior)
) As Task

Parameters

• poolId
  Type: System.String

  The id of the pool that contains the compute node.

• computeNodeId
  Type: System.String

  The id of the compute node from which you want to delete the user account.

• userName
  Type: System.String

  The name of the user account to be deleted.

• additionalBehaviors
  Type: System.Collections.Generic.IEnumerable<BatchClientBehavior>

  A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.

Return Value

Type: System.Threading.Tasks.Task

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.

See Also

PoolOperations Class
Microsoft.Azure.Batch Namespace

Return to top