BatchStartTaskInfo interface

パッケージ:

@azure/batch

コンピューティング ノードで実行されている StartTask に関する情報。

プロパティ

containerInfo	タスクが実行されているコンテナに関する情報。 このプロパティは、タスクがコンテナコンテキストで実行される場合にのみ設定されます。
endTime	StartTaskが停止した時刻。 これは、StartTaskの直近実行が完了した場合(失敗して再試行が保留中であっても)終了時刻です。 この要素は、StartTaskが現在実行されている場合は存在しません。
exitCode	StartTaskコマンドラインで指定されたプログラムの終了コード。 このプロパティは、StartTaskが完了状態にある場合にのみ設定されます。 一般的に、プロセスの終了コードは、そのプロセスに対してアプリケーション開発者が実装した特定の慣習を反映しています。 コード内で判定に出口コードの値を使う場合は、アプリケーションプロセスで使われる出口コードの規則を必ず把握してください。 しかし、バッチサービスがStartTaskを終了した場合(タイムアウトやAPIによるユーザー終了により)、OSが定義した終了コードが表示されることがあります。
failureInfo	タスクの失敗に関する情報(あれば)も含まれます。 このプロパティは、タスクが完了状態にあり、失敗が発生した場合のみ設定されます。
lastRetryTime	タスクの再挑戦が始まった直近の時です。 この要素はタスクが再試行された場合(すなわちretryCountがゼロでない場合)のみ存在します。 もし存在する場合、これは通常startTimeと同じですが、タスクが再試行以外の理由で再起動された場合は異なる場合があります。例えば、リトライ中にコンピュートノードが再起動された場合、startTimeは更新されますがlastRetryTimeは更新されません。
result	タスク実行の結果です。 値が「失敗」の場合、失敗の詳細はfailureInfoプロパティで確認できます。
retryCount	タスクがバッチサービスによって再試された回数。 タスクアプリケーション失敗(ゼロでない終了コード)は再試され、前処理エラー(タスクが実行できなかった)やファイルアップロードエラーは再試されません。 バッチサービスは制約で指定された制限までタスクを再試行します。
startTime	StartTaskが実行を開始した時刻。 この値は、タスクが再起動または再試行されるたびにリセットされます(つまり、StartTaskが実行を開始した直近の時刻です)。
state	計算ノード上のStartTaskの状態。

プロパティの詳細

containerInfo

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

containerInfo?: BatchTaskContainerExecutionInfo

プロパティ値

BatchTaskContainerExecutionInfo

endTime

StartTaskが停止した時刻。 これは、StartTaskの直近実行が完了した場合(失敗して再試行が保留中であっても)終了時刻です。 この要素は、StartTaskが現在実行されている場合は存在しません。

endTime?: Date

プロパティ値

Date

exitCode

StartTaskコマンドラインで指定されたプログラムの終了コード。 このプロパティは、StartTaskが完了状態にある場合にのみ設定されます。 一般的に、プロセスの終了コードは、そのプロセスに対してアプリケーション開発者が実装した特定の慣習を反映しています。 コード内で判定に出口コードの値を使う場合は、アプリケーションプロセスで使われる出口コードの規則を必ず把握してください。 しかし、バッチサービスがStartTaskを終了した場合(タイムアウトやAPIによるユーザー終了により)、OSが定義した終了コードが表示されることがあります。

exitCode?: number

プロパティ値

number

failureInfo

タスクの失敗に関する情報(あれば)も含まれます。 このプロパティは、タスクが完了状態にあり、失敗が発生した場合のみ設定されます。

failureInfo?: BatchTaskFailureInfo

プロパティ値

BatchTaskFailureInfo

lastRetryTime

タスクの再挑戦が始まった直近の時です。 この要素はタスクが再試行された場合(すなわちretryCountがゼロでない場合)のみ存在します。 もし存在する場合、これは通常startTimeと同じですが、タスクが再試行以外の理由で再起動された場合は異なる場合があります。例えば、リトライ中にコンピュートノードが再起動された場合、startTimeは更新されますがlastRetryTimeは更新されません。

lastRetryTime?: Date

プロパティ値

Date

result

タスク実行の結果です。 値が「失敗」の場合、失敗の詳細はfailureInfoプロパティで確認できます。

result?: BatchTaskExecutionResult

プロパティ値

BatchTaskExecutionResult

retryCount

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

retryCount: number

プロパティ値

number

startTime

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

startTime: Date

プロパティ値

Date

state

計算ノード上のStartTaskの状態。

state: BatchStartTaskState

プロパティ値

BatchStartTaskState