BatchClient.DisableNodeScheduling Method

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

Azure.Compute.Batch v1.0.0-beta.1

Overloads

DisableNodeScheduling(String, String, BatchNodeDisableSchedulingContent, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken)

Disables Task scheduling on the specified Compute Node.

DisableNodeScheduling(String, String, RequestContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestContext)

[Protocol Method] Disables Task scheduling on the specified Compute Node. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler DisableNodeScheduling(String, String, BatchNodeDisableSchedulingContent, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken) convenience overload with strongly typed models first.

DisableNodeScheduling(String, String, BatchNodeDisableSchedulingContent, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken)

Source:

BatchClient.cs

Disables Task scheduling on the specified Compute Node.

public virtual Azure.Response DisableNodeScheduling (string poolId, string nodeId, Azure.Compute.Batch.BatchNodeDisableSchedulingContent parameters = default, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DisableNodeScheduling : string * string * Azure.Compute.Batch.BatchNodeDisableSchedulingContent * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> Azure.Response
override this.DisableNodeScheduling : string * string * Azure.Compute.Batch.BatchNodeDisableSchedulingContent * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> Azure.Response

Public Overridable Function DisableNodeScheduling (poolId As String, nodeId As String, Optional parameters As BatchNodeDisableSchedulingContent = Nothing, Optional timeOutInSeconds As Nullable(Of Integer) = Nothing, Optional ocpdate As Nullable(Of DateTimeOffset) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response

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.

parameters

BatchNodeDisableSchedulingContent

The options to use for disabling scheduling on the Compute Node.

timeOutInSeconds

Nullable<Int32>

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".

ocpdate

Nullable<DateTimeOffset>

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response

Exceptions

ArgumentNullException

poolId or nodeId is null.

ArgumentException

poolId or nodeId is an empty string, and was expected to be non-empty.

Examples

This sample shows how to call DisableNodeScheduling.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

Response response = client.DisableNodeScheduling("<poolId>", "<nodeId>");

This sample shows how to call DisableNodeScheduling with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

BatchNodeDisableSchedulingContent parameters = new BatchNodeDisableSchedulingContent
{
    NodeDisableSchedulingOption = BatchNodeDisableSchedulingOption.Requeue,
};
Response response = client.DisableNodeScheduling("<poolId>", "<nodeId>", parameters: parameters, timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"));

Remarks

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

DisableNodeScheduling(String, String, RequestContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestContext)

Source:

BatchClient.cs

[Protocol Method] Disables Task scheduling on the specified Compute Node.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler DisableNodeScheduling(String, String, BatchNodeDisableSchedulingContent, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response DisableNodeScheduling (string poolId, string nodeId, Azure.Core.RequestContent content, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, Azure.RequestContext context = default);

abstract member DisableNodeScheduling : string * string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestContext -> Azure.Response
override this.DisableNodeScheduling : string * string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestContext -> Azure.Response

Public Overridable Function DisableNodeScheduling (poolId As String, nodeId As String, content As RequestContent, Optional timeOutInSeconds As Nullable(Of Integer) = Nothing, Optional ocpdate As Nullable(Of DateTimeOffset) = Nothing, Optional context As RequestContext = Nothing) As Response

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.

content

RequestContent

The content to send as the body of the request.

timeOutInSeconds

Nullable<Int32>

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".

ocpdate

Nullable<DateTimeOffset>

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

poolId or nodeId is null.

ArgumentException

poolId or nodeId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call DisableNodeScheduling.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

using RequestContent content = null;
Response response = client.DisableNodeScheduling("<poolId>", "<nodeId>", content);

Console.WriteLine(response.Status);

This sample shows how to call DisableNodeScheduling with all parameters and request content.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

using RequestContent content = RequestContent.Create(new
{
    nodeDisableSchedulingOption = "requeue",
});
Response response = client.DisableNodeScheduling("<poolId>", "<nodeId>", content, timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"));

Console.WriteLine(response.Status);