ComputeBatchModelFactory.BatchAutoPoolSpecification Method

Definition

Namespace:: Azure.Compute.Batch

Assembly:: Azure.Compute.Batch.dll

Package:: Azure.Compute.Batch v1.0.0-beta.5

Source:: ComputeBatchModelFactory.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public static Azure.Compute.Batch.BatchAutoPoolSpecification BatchAutoPoolSpecification(string autoPoolIdPrefix = default, Azure.Compute.Batch.BatchPoolLifetimeOption poolLifetimeOption = default, bool? keepAlive = default, Azure.Compute.Batch.BatchPoolSpecification pool = default);

static member BatchAutoPoolSpecification : string * Azure.Compute.Batch.BatchPoolLifetimeOption * Nullable<bool> * Azure.Compute.Batch.BatchPoolSpecification -> Azure.Compute.Batch.BatchAutoPoolSpecification

Public Shared Function BatchAutoPoolSpecification (Optional autoPoolIdPrefix As String = Nothing, Optional poolLifetimeOption As BatchPoolLifetimeOption = Nothing, Optional keepAlive As Nullable(Of Boolean) = Nothing, Optional pool As BatchPoolSpecification = Nothing) As BatchAutoPoolSpecification

Parameters

autoPoolIdPrefix: String

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.

poolLifetimeOption: BatchPoolLifetimeOption

The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools.

keepAlive: Nullable<Boolean>

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.