BatchPoolInfo Class

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

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

Source:

BatchPoolInfo.cs

Specifies how a Job should be assigned to a Pool.

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

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

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

Inheritance

Object

BatchPoolInfo

Implements

IJsonModel<BatchPoolInfo> IPersistableModel<BatchPoolInfo> IPersistableModel<T>

Constructors

BatchPoolInfo()

Initializes a new instance of BatchPoolInfo.

Properties

AutoPoolSpecification

Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. If auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both.

PoolId

The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both.

Explicit Interface Implementations

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