Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FixedScaleSettings

Package version

interface

An interface representing FixedScaleSettings.

summary

Fixed scale settings for the pool.

Hierarchy

  • FixedScaleSettings

Index

Properties

Optional nodeDeallocationOption

nodeDeallocationOption: ComputeNodeDeallocationOption
member

{ComputeNodeDeallocationOption} [nodeDeallocationOption] Determines what to do with a node and its running task(s) if the pool size is decreasing. If omitted, the default value is Requeue. Possible values include: 'Requeue', 'Terminate', 'TaskCompletion', 'RetainedData'

Optional resizeTimeout

resizeTimeout: undefined | string
member

{string} [resizeTimeout] The timeout for allocation of compute nodes to the pool. The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Optional targetDedicatedNodes

targetDedicatedNodes: undefined | number
member

{number} [targetDedicatedNodes] The desired number of dedicated compute nodes in the pool. At least one of targetDedicatedNodes, targetLowPriority nodes must be set.

Optional targetLowPriorityNodes

targetLowPriorityNodes: undefined | number
member

{number} [targetLowPriorityNodes] The desired number of low-priority compute nodes in the pool. At least one of targetDedicatedNodes, targetLowPriority nodes must be set.

Generated using TypeDoc