ExitConditions interface

Package:

@azure/batch

An interface representing ExitConditions.

Properties

default	How the Batch service should respond if the Task fails with an exit condition not covered by any of the other properties. This value is used if the Task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection.
exitCodeRanges	A list of Task exit code ranges and how the Batch service should respond to them.
exitCodes	A list of individual Task exit codes and how the Batch service should respond to them.
fileUploadError	How the Batch service should respond if a file upload error occurs. If the Task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence.
preProcessingError	How the Batch service should respond if the Task fails to start due to an error.

Property Details

default

How the Batch service should respond if the Task fails with an exit condition not covered by any of the other properties. This value is used if the Task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection.

default?: ExitOptions

Property Value

ExitOptions

exitCodeRanges

A list of Task exit code ranges and how the Batch service should respond to them.

exitCodeRanges?: ExitCodeRangeMapping[]

Property Value

ExitCodeRangeMapping[]

exitCodes

A list of individual Task exit codes and how the Batch service should respond to them.

exitCodes?: ExitCodeMapping[]

Property Value

ExitCodeMapping[]

fileUploadError

How the Batch service should respond if a file upload error occurs. If the Task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence.

fileUploadError?: ExitOptions

Property Value

ExitOptions

preProcessingError

How the Batch service should respond if the Task fails to start due to an error.

preProcessingError?: ExitOptions

Property Value

ExitOptions