BatchAutoPoolSpecification Class

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

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

Source:

BatchAutoPoolSpecification.cs

Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted.

public class BatchAutoPoolSpecification : System.ClientModel.Primitives.IJsonModel<Azure.Compute.Batch.BatchAutoPoolSpecification>, System.ClientModel.Primitives.IPersistableModel<Azure.Compute.Batch.BatchAutoPoolSpecification>

type BatchAutoPoolSpecification = class
    interface IJsonModel<BatchAutoPoolSpecification>
    interface IPersistableModel<BatchAutoPoolSpecification>

Public Class BatchAutoPoolSpecification
Implements IJsonModel(Of BatchAutoPoolSpecification), IPersistableModel(Of BatchAutoPoolSpecification)

Inheritance

Object

BatchAutoPoolSpecification

Implements

IJsonModel<BatchAutoPoolSpecification> IPersistableModel<BatchAutoPoolSpecification> IPersistableModel<T>

Constructors

BatchAutoPoolSpecification(BatchPoolLifetimeOption)

Initializes a new instance of BatchAutoPoolSpecification.

Properties

AutoPoolIdPrefix	A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long.
KeepAlive	Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option.
Pool	The Pool specification for the auto Pool.
PoolLifetimeOption	The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools.

Explicit Interface Implementations

IJsonModel<BatchAutoPoolSpecification>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<BatchAutoPoolSpecification>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<BatchAutoPoolSpecification>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<BatchAutoPoolSpecification>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<BatchAutoPoolSpecification>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.