IComputeNodeOperations.DisableSchedulingWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

Source:: IComputeNodeOperations.cs

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.

Disables Task scheduling on the specified Compute Node.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDisableSchedulingHeaders>> DisableSchedulingWithHttpMessagesAsync (string poolId, string nodeId, Microsoft.Azure.Batch.Protocol.Models.DisableComputeNodeSchedulingOption? nodeDisableSchedulingOption = default, Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDisableSchedulingOptions computeNodeDisableSchedulingOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DisableSchedulingWithHttpMessagesAsync : string * string * Nullable<Microsoft.Azure.Batch.Protocol.Models.DisableComputeNodeSchedulingOption> * Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDisableSchedulingOptions * 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.ComputeNodeDisableSchedulingHeaders>>

Public Function DisableSchedulingWithHttpMessagesAsync (poolId As String, nodeId As String, Optional nodeDisableSchedulingOption As Nullable(Of DisableComputeNodeSchedulingOption) = Nothing, Optional computeNodeDisableSchedulingOptions As ComputeNodeDisableSchedulingOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationHeaderResponse(Of ComputeNodeDisableSchedulingHeaders))

Parameters

poolId: String

The ID of the Pool that contains the Compute Node.

nodeId: String

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

nodeDisableSchedulingOption: 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

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AzureOperationHeaderResponse<ComputeNodeDisableSchedulingHeaders>>

Exceptions

BatchErrorException

Thrown when the operation returned an invalid status code

ValidationException

Thrown when a required parameter is null

Remarks

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

Applies to

Share via