Interface ElasticPool

Data and settings for an elastic pool

interface ElasticPool {
    agentInteractiveUI?: boolean;
    azureId?: string;
    desiredIdle?: number;
    desiredSize?: number;
    maxCapacity?: number;
    maxSavedNodeCount?: number;
    offlineSince?: Date;
    orchestrationType?: OrchestrationType;
    osType?: OperatingSystemType;
    poolId?: number;
    recycleAfterEachUse?: boolean;
    serviceEndpointId?: string;
    serviceEndpointScope?: string;
    sizingAttempts?: number;
    state?: ElasticPoolState;
    timeToLiveMinutes?: number;
}

Properties

agentInteractiveUI? azureId? desiredIdle? desiredSize? maxCapacity? maxSavedNodeCount? offlineSince? orchestrationType? osType? poolId? recycleAfterEachUse? serviceEndpointId? serviceEndpointScope? sizingAttempts? state? timeToLiveMinutes?

Properties

OptionalagentInteractiveUI

agentInteractiveUI?: boolean

Set whether agents should be configured to run with interactive UI

OptionalazureId

azureId?: string

Azure string representing to location of the resource

OptionaldesiredIdle

desiredIdle?: number

Number of agents to have ready waiting for jobs

OptionaldesiredSize

desiredSize?: number

The desired size of the pool

OptionalmaxCapacity

maxCapacity?: number

Maximum number of nodes that will exist in the elastic pool

OptionalmaxSavedNodeCount

maxSavedNodeCount?: number

Keep nodes in the pool on failure for investigation

OptionalofflineSince

offlineSince?: Date

Timestamp the pool was first detected to be offline

OptionalorchestrationType

orchestrationType?: OrchestrationType

Operating system type of the nodes in the pool

OptionalosType

osType?: OperatingSystemType

Operating system type of the nodes in the pool

OptionalpoolId

poolId?: number

Id of the associated TaskAgentPool

OptionalrecycleAfterEachUse

recycleAfterEachUse?: boolean

Discard node after each job completes

OptionalserviceEndpointId

serviceEndpointId?: string

Id of the Service Endpoint used to connect to Azure

OptionalserviceEndpointScope

serviceEndpointScope?: string

Scope the Service Endpoint belongs to

OptionalsizingAttempts

sizingAttempts?: number

The number of sizing attempts executed while trying to achieve a desired size

Optionalstate

state?: ElasticPoolState

State of the pool

OptionaltimeToLiveMinutes

timeToLiveMinutes?: number

The minimum time in minutes to keep idle agents alive

Settings

Member Visibility

On This Page

Properties