Share via

JobTerminateOptionalParams interface

Package:
@azure/batch

Optional Parameters.

Extends
RequestOptionsBase

Properties

jobTerminateOptions

Additional parameters for the operation
terminateReason

The text you want to appear as the Job's TerminateReason. The default is 'UserTerminate'.

Inherited Properties

abortSignal

The signal which can be used to abort requests.
customHeaders

User defined custom request headers that will be applied before the request is sent.
onDownloadProgress

Callback which fires upon download progress.
onUploadProgress

Callback which fires upon upload progress.
timeout

The number of milliseconds a request can take before automatically being terminated.

Property Details

jobTerminateOptions

Additional parameters for the operation

jobTerminateOptions?: JobTerminateOptions

Property Value

JobTerminateOptions

terminateReason

The text you want to appear as the Job's TerminateReason. The default is 'UserTerminate'.

terminateReason?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From msRest.RequestOptionsBase.abortSignal

customHeaders

User defined custom request headers that will be applied before the request is sent.

customHeaders?: {[key: string]: string}

Property Value

{[key: string]: string}

Inherited From msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onUploadProgress

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: number

Property Value

number

Inherited From msRest.RequestOptionsBase.timeout