你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

BatchClient.DisableNodeSchedulingAsync Method

Definition

Overloads

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

Disables Task scheduling on the specified Compute Node.

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

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

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

Source:
BatchClientCustom.cs

Disables Task scheduling on the specified Compute Node.

public virtual System.Threading.Tasks.Task<Azure.Response> DisableNodeSchedulingAsync (string poolId, string nodeId, Azure.Compute.Batch.BatchNodeDisableSchedulingContent parameters = default, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DisableNodeSchedulingAsync : string * string * Azure.Compute.Batch.BatchNodeDisableSchedulingContent * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DisableNodeSchedulingAsync : string * string * Azure.Compute.Batch.BatchNodeDisableSchedulingContent * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function DisableNodeSchedulingAsync (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 Task(Of 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

Exceptions

poolId or nodeId is null.

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

Examples

This sample shows how to call DisableNodeSchedulingAsync.

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

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

This sample shows how to call DisableNodeSchedulingAsync 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 = await client.DisableNodeSchedulingAsync("<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.

Applies to

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

Source:
BatchClientCustom.cs

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

public virtual System.Threading.Tasks.Task<Azure.Response> DisableNodeSchedulingAsync (string poolId, string nodeId, Azure.Core.RequestContent content, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, Azure.RequestContext context = default);
abstract member DisableNodeSchedulingAsync : string * string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DisableNodeSchedulingAsync : string * string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function DisableNodeSchedulingAsync (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 Task(Of 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

The response returned from the service.

Exceptions

poolId or nodeId is null.

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

Service returned a non-success status code.

Examples

This sample shows how to call DisableNodeSchedulingAsync.

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 = await client.DisableNodeSchedulingAsync("<poolId>", "<nodeId>", content);

Console.WriteLine(response.Status);

This sample shows how to call DisableNodeSchedulingAsync 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 = await client.DisableNodeSchedulingAsync("<poolId>", "<nodeId>", content, timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"));

Console.WriteLine(response.Status);

Applies to