BatchClient.RemoveNodesAsync Method

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

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

Overloads

RemoveNodesAsync(String, BatchNodeRemoveContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, CancellationToken)	Removes Compute Nodes from the specified Pool.
RemoveNodesAsync(String, RequestContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, RequestContext)	[Protocol Method] Removes Compute Nodes from the specified Pool. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler RemoveNodesAsync(String, BatchNodeRemoveContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, CancellationToken) convenience overload with strongly typed models first.

RemoveNodesAsync(String, BatchNodeRemoveContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, CancellationToken)

Source:

BatchClientCustom.cs

Removes Compute Nodes from the specified Pool.

public virtual System.Threading.Tasks.Task<Azure.Response> RemoveNodesAsync (string poolId, Azure.Compute.Batch.BatchNodeRemoveContent content, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, Azure.RequestConditions requestConditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member RemoveNodesAsync : string * Azure.Compute.Batch.BatchNodeRemoveContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.RemoveNodesAsync : string * Azure.Compute.Batch.BatchNodeRemoveContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function RemoveNodesAsync (poolId As String, content As BatchNodeRemoveContent, Optional timeOutInSeconds As Nullable(Of Integer) = Nothing, Optional ocpdate As Nullable(Of DateTimeOffset) = Nothing, Optional requestConditions As RequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

poolId

String

The ID of the Pool to get.

content

BatchNodeRemoveContent

The options to use for removing the 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.

requestConditions

RequestConditions

The content to send as the request conditions of the request.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response>

Exceptions

ArgumentNullException

poolId or content is null.

ArgumentException

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

Examples

This sample shows how to call RemoveNodesAsync.

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

BatchNodeRemoveContent content = new BatchNodeRemoveContent(new string[] { "<nodeList>" });
Response response = await client.RemoveNodesAsync("<poolId>", content);

This sample shows how to call RemoveNodesAsync with all parameters.

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

BatchNodeRemoveContent content = new BatchNodeRemoveContent(new string[] { "<nodeList>" })
{
    ResizeTimeout = XmlConvert.ToTimeSpan("PT1H23M45S"),
    NodeDeallocationOption = BatchNodeDeallocationOption.Requeue,
};
Response response = await client.RemoveNodesAsync("<poolId>", content, timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"), requestConditions: null);

Remarks

This operation can only run when the allocation state of the Pool is steady. When this operation runs, the allocation state changes from steady to resizing. Each request may remove up to 100 nodes.

RemoveNodesAsync(String, RequestContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, RequestContext)

Source:

BatchClientCustom.cs

[Protocol Method] Removes Compute Nodes from the specified Pool.

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

public virtual System.Threading.Tasks.Task<Azure.Response> RemoveNodesAsync (string poolId, Azure.Core.RequestContent content, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, Azure.RequestConditions requestConditions = default, Azure.RequestContext context = default);

abstract member RemoveNodesAsync : string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestConditions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.RemoveNodesAsync : string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestConditions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function RemoveNodesAsync (poolId As String, content As RequestContent, Optional timeOutInSeconds As Nullable(Of Integer) = Nothing, Optional ocpdate As Nullable(Of DateTimeOffset) = Nothing, Optional requestConditions As RequestConditions = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

poolId

String

The ID of the Pool to get.

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.

requestConditions

RequestConditions

The content to send as the request conditions of the request.

context

RequestContext

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

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

poolId or content is null.

ArgumentException

poolId 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 RemoveNodesAsync.

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
{
    nodeList = new object[]
    {
        "<nodeList>"
    },
});
Response response = await client.RemoveNodesAsync("<poolId>", content);

Console.WriteLine(response.Status);

This sample shows how to call RemoveNodesAsync 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
{
    nodeList = new object[]
    {
        "<nodeList>"
    },
    resizeTimeout = "PT1H23M45S",
    nodeDeallocationOption = "requeue",
});
Response response = await client.RemoveNodesAsync("<poolId>", content, timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"), requestConditions: null);

Console.WriteLine(response.Status);