StartTaskInformation interface

パッケージ:

@azure/batch

StartTaskInformation を表すインターフェイス。

プロパティ

containerInfo	タスクが実行されているコンテナーに関する情報。 このプロパティは、タスクがコンテナー コンテキストで実行される場合にのみ設定されます。
endTime	StartTask が実行を停止した時刻。 これは、実行が完了した場合 (その実行が失敗し、再試行が保留中の場合でも) StartTask の最新の実行の終了時刻です。 StartTask が現在実行中の場合、この要素は存在しません。
exitCode	StartTask コマンド ラインで指定されたプログラムの終了コード。 このプロパティは、StartTask が完了状態の場合にのみ設定されます。 一般に、プロセスの終了コードには、そのプロセスに対してアプリケーション開発者によって実装された特定の規則が反映されます。 終了コード値を使用してコード内で決定を行う場合は、アプリケーション プロセスで使用される終了コード規則がわかっていることを確認してください。 ただし、Batch サービスが StartTask を終了した場合 (タイムアウトのため、または API を介したユーザー終了が原因)、オペレーティング システムで定義された終了コードが表示されることがあります。
failureInfo	タスクの失敗を説明する情報 (存在する場合)。 このプロパティは、Task が完了状態でエラーが発生した場合にのみ設定されます。
lastRetryTime	タスクの再試行が実行を開始した最新の時刻。 この要素は、Task が再試行された場合にのみ存在します (つまり、retryCount は 0 以外です)。 存在する場合、これは通常、startTime と同じですが、再試行以外の理由でタスクが再起動された場合は異なる場合があります。たとえば、再試行中にコンピューティング ノードが再起動された場合、startTime は更新されますが、lastRetryTime は更新されません。
result	タスク実行の結果。 値が 'failed' の場合は、failureInfo プロパティでエラーの詳細を確認できます。 使用可能な値は、'success'、'failure' です。
retryCount	Batch サービスによってタスクが再試行された回数。 タスク アプリケーションエラー (0 以外の終了コード) が再試行され、前処理エラー (タスクを実行できませんでした)、ファイルアップロードエラーは再試行されません。 Batch サービスは、制約で指定された制限までタスクを再試行します。
startTime	StartTask の実行が開始された時刻。 この値は、タスクが再起動または再試行されるたびにリセットされます (つまり、StartTask が実行を開始した最新の時刻です)。
state	コンピューティング ノード上の StartTask の状態。 使用可能な値は次のとおりです: 'running'、'completed'

プロパティの詳細

containerInfo

タスクが実行されているコンテナーに関する情報。 このプロパティは、タスクがコンテナー コンテキストで実行される場合にのみ設定されます。

containerInfo?: TaskContainerExecutionInformation

プロパティ値

TaskContainerExecutionInformation

endTime

StartTask が実行を停止した時刻。 これは、実行が完了した場合 (その実行が失敗し、再試行が保留中の場合でも) StartTask の最新の実行の終了時刻です。 StartTask が現在実行中の場合、この要素は存在しません。

endTime?: Date

プロパティ値

Date

exitCode

StartTask コマンド ラインで指定されたプログラムの終了コード。 このプロパティは、StartTask が完了状態の場合にのみ設定されます。 一般に、プロセスの終了コードには、そのプロセスに対してアプリケーション開発者によって実装された特定の規則が反映されます。 終了コード値を使用してコード内で決定を行う場合は、アプリケーション プロセスで使用される終了コード規則がわかっていることを確認してください。 ただし、Batch サービスが StartTask を終了した場合 (タイムアウトのため、または API を介したユーザー終了が原因)、オペレーティング システムで定義された終了コードが表示されることがあります。

exitCode?: number

プロパティ値

number

failureInfo

タスクの失敗を説明する情報 (存在する場合)。 このプロパティは、Task が完了状態でエラーが発生した場合にのみ設定されます。

failureInfo?: TaskFailureInformation

プロパティ値

TaskFailureInformation

lastRetryTime

タスクの再試行が実行を開始した最新の時刻。 この要素は、Task が再試行された場合にのみ存在します (つまり、retryCount は 0 以外です)。 存在する場合、これは通常、startTime と同じですが、再試行以外の理由でタスクが再起動された場合は異なる場合があります。たとえば、再試行中にコンピューティング ノードが再起動された場合、startTime は更新されますが、lastRetryTime は更新されません。

lastRetryTime?: Date

プロパティ値

Date

result

タスク実行の結果。 値が 'failed' の場合は、failureInfo プロパティでエラーの詳細を確認できます。 使用可能な値は、'success'、'failure' です。

result?: TaskExecutionResult

プロパティ値

TaskExecutionResult

retryCount

Batch サービスによってタスクが再試行された回数。 タスク アプリケーションエラー (0 以外の終了コード) が再試行され、前処理エラー (タスクを実行できませんでした)、ファイルアップロードエラーは再試行されません。 Batch サービスは、制約で指定された制限までタスクを再試行します。

retryCount: number

プロパティ値

number

startTime

StartTask の実行が開始された時刻。 この値は、タスクが再起動または再試行されるたびにリセットされます (つまり、StartTask が実行を開始した最新の時刻です)。

startTime: Date

プロパティ値

Date

state

コンピューティング ノード上の StartTask の状態。 使用可能な値は次のとおりです: 'running'、'completed'

state: StartTaskState

プロパティ値

StartTaskState