Share via

PoolInformation.AutoPoolSpecification Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Batch.Protocol.Models
Assembly:
Microsoft.Azure.Batch.dll
Package:
Microsoft.Azure.Batch v16.3.1
Source:
PoolInformation.cs

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

[Newtonsoft.Json.JsonProperty(PropertyName="autoPoolSpecification")]
public Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification AutoPoolSpecification { get; set; }
[<Newtonsoft.Json.JsonProperty(PropertyName="autoPoolSpecification")>]
member this.AutoPoolSpecification : Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification with get, set
Public Property AutoPoolSpecification As AutoPoolSpecification

Property Value

AutoPoolSpecification
Attributes
Newtonsoft.Json.JsonPropertyAttribute

Remarks

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.

Applies to