ComputeNodeOperationsExtensions.DisableScheduling(IComputeNodeOperations, String, String, Nullable<DisableComputeNodeSchedulingOption>, ComputeNodeDisableSchedulingOptions) Method

Definition

Disables Task scheduling on the specified Compute Node.

public static Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDisableSchedulingHeaders DisableScheduling (this Microsoft.Azure.Batch.Protocol.IComputeNodeOperations operations, string poolId, string nodeId, Microsoft.Azure.Batch.Protocol.Models.DisableComputeNodeSchedulingOption? nodeDisableSchedulingOption = default, Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDisableSchedulingOptions computeNodeDisableSchedulingOptions = default);
static member DisableScheduling : Microsoft.Azure.Batch.Protocol.IComputeNodeOperations * string * string * Nullable<Microsoft.Azure.Batch.Protocol.Models.DisableComputeNodeSchedulingOption> * Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDisableSchedulingOptions -> Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDisableSchedulingHeaders
<Extension()>
Public Function DisableScheduling (operations As IComputeNodeOperations, poolId As String, nodeId As String, Optional nodeDisableSchedulingOption As Nullable(Of DisableComputeNodeSchedulingOption) = Nothing, Optional computeNodeDisableSchedulingOptions As ComputeNodeDisableSchedulingOptions = Nothing) As ComputeNodeDisableSchedulingHeaders

Parameters

operations
IComputeNodeOperations

The operations group for this extension method.

poolId
System.String

The ID of the Pool that contains the Compute Node.

nodeId
System.String

The ID of the Compute Node on which you want to disable Task scheduling.

nodeDisableSchedulingOption
System.Nullable<DisableComputeNodeSchedulingOption>

What to do with currently running Tasks when disabling Task scheduling on the Compute Node. The default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion'

computeNodeDisableSchedulingOptions
ComputeNodeDisableSchedulingOptions

Additional parameters for the operation

Returns

ComputeNodeDisableSchedulingHeaders

Remarks

You can disable Task scheduling on a Compute Node only if its current scheduling state is enabled.

Applies to