PoolOperations.DeleteComputeNodeUser Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

PoolOperations.cs

Deletes the specified user account from the specified compute node.

public void DeleteComputeNodeUser (string poolId, string computeNodeId, string userName, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);

member this.DeleteComputeNodeUser : string * string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit

Public Sub DeleteComputeNodeUser (poolId As String, computeNodeId As String, userName As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)

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.

Remarks

You can delete a user account from a compute node only when it is in the Idle or Running state.

This is a blocking operation. For a non-blocking equivalent, see DeleteComputeNodeUserAsync(String, String, String, IEnumerable<BatchClientBehavior>, CancellationToken).