BatchAutoPoolSpecification interface

Package:

@azure-rest/batch

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

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. Possible values: "jobschedule", "job"

Property Details

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.

autoPoolIdPrefix?: string

Property Value

string

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.

keepAlive?: boolean

Property Value

boolean

pool

The Pool specification for the auto Pool.

pool?: BatchPoolSpecification

Property Value

BatchPoolSpecification

poolLifetimeOption

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

Possible values: "jobschedule", "job"

poolLifetimeOption: string

Property Value

string