Share via


BatchNodeRemoveOptions Class

Definition

Parameters for removing nodes from an Azure Batch Pool.

public class BatchNodeRemoveOptions : System.ClientModel.Primitives.IJsonModel<Azure.Compute.Batch.BatchNodeRemoveOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.Compute.Batch.BatchNodeRemoveOptions>
type BatchNodeRemoveOptions = class
    interface IJsonModel<BatchNodeRemoveOptions>
    interface IPersistableModel<BatchNodeRemoveOptions>
Public Class BatchNodeRemoveOptions
Implements IJsonModel(Of BatchNodeRemoveOptions), IPersistableModel(Of BatchNodeRemoveOptions)
Inheritance
BatchNodeRemoveOptions
Implements

Constructors

BatchNodeRemoveOptions(IEnumerable<String>)

Initializes a new instance of BatchNodeRemoveOptions.

Properties

NodeDeallocationOption

Determines what to do with a Compute Node and its running task(s) after it has been selected for deallocation. The default value is requeue.

NodeIds

A list containing the IDs of the Compute Nodes to be removed from the specified Pool. A maximum of 100 nodes may be removed per request.

ResizeTimeout

The timeout for removal of Compute Nodes to the Pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<BatchNodeRemoveOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<BatchNodeRemoveOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<BatchNodeRemoveOptions>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<BatchNodeRemoveOptions>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<BatchNodeRemoveOptions>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to