BatchTaskExecutionInfo interface
タスクの実行に関する情報。
プロパティ
| container |
タスクが実行されているコンテナに関する情報。 このプロパティは、タスクがコンテナコンテキストで実行される場合にのみ設定されます。 |
| end |
タスクが完了した時刻。 このプロパティはタスクが完了状態にある場合にのみ設定されます。 |
| exit |
タスクコマンドラインで指定されたプログラムの終了コード。 このプロパティはタスクが完了状態にある場合にのみ設定されます。 一般的に、プロセスの終了コードは、そのプロセスに対してアプリケーション開発者が実装した特定の慣習を反映しています。 コード内で判定に出口コードの値を使う場合は、アプリケーションプロセスで使われる出口コードの規則を必ず把握してください。 しかし、バッチサービスがタイムアウトやAPIによるユーザー終了によりタスクを終了すると、OSが定義した終了コードが表示されることがあります。 |
| failure |
タスクの失敗に関する情報(あれば)も含まれます。 このプロパティは、タスクが完了状態にあり、失敗が発生した場合のみ設定されます。 |
| last |
ユーザーのリクエストの結果としてバッチサービスによってタスクが再キューされた直近の時刻。 このプロパティはrequeueCountがゼロでない場合のみ設定されます。 |
| last |
タスクの再挑戦が始まった直近の時です。 この要素はタスクが再試行された場合(すなわちretryCountがゼロでない場合)のみ存在します。 もし存在する場合、これは通常startTimeと同じですが、タスクが再試行以外の理由で再起動された場合は異なる場合があります。例えば、リトライ中にコンピュートノードが再起動された場合、startTimeは更新されますがlastRetryTimeは更新されません。 |
| requeue |
タスクがユーザーのリクエストの結果としてバッチサービスによって再キューされた回数です。 ユーザーがプールからコンピュートノードをリサイズ・縮小する際やジョブが無効化される際には、コンピュートノード上で実行中のタスクを実行のために再キューするよう指定できます。 このカウントは、これらの理由でタスクが何回再キューされたかを追跡しています。 |
| result | タスク実行の結果です。 値が「失敗」の場合、失敗の詳細はfailureInfoプロパティで確認できます。 |
| retry |
タスクがバッチサービスによって再試された回数。 タスクアプリケーション失敗(ゼロでない終了コード)は再試され、前処理エラー(タスクが実行できなかった)やファイルアップロードエラーは再試されません。 バッチサービスは制約で指定された制限までタスクを再試行します。 |
| start |
タスクが開始された時間。 「Running」は実行状態に対応しているため、タスクがリソースファイルやパッケージを指定する場合、開始時間はタスクがそれらをダウンロードまたは展開し始めた時刻を反映します。 タスクが再起動または再試行された場合、これはタスクが実行を開始した最新の時刻です。 このプロパティは、実行中または完了状態のタスクにのみ適用されます。 |
プロパティの詳細
containerInfo
タスクが実行されているコンテナに関する情報。 このプロパティは、タスクがコンテナコンテキストで実行される場合にのみ設定されます。
containerInfo?: BatchTaskContainerExecutionInfoプロパティ値
endTime
タスクが完了した時刻。 このプロパティはタスクが完了状態にある場合にのみ設定されます。
endTime?: Dateプロパティ値
Date
exitCode
タスクコマンドラインで指定されたプログラムの終了コード。 このプロパティはタスクが完了状態にある場合にのみ設定されます。 一般的に、プロセスの終了コードは、そのプロセスに対してアプリケーション開発者が実装した特定の慣習を反映しています。 コード内で判定に出口コードの値を使う場合は、アプリケーションプロセスで使われる出口コードの規則を必ず把握してください。 しかし、バッチサービスがタイムアウトやAPIによるユーザー終了によりタスクを終了すると、OSが定義した終了コードが表示されることがあります。
exitCode?: numberプロパティ値
number
failureInfo
タスクの失敗に関する情報(あれば)も含まれます。 このプロパティは、タスクが完了状態にあり、失敗が発生した場合のみ設定されます。
failureInfo?: BatchTaskFailureInfoプロパティ値
lastRequeueTime
ユーザーのリクエストの結果としてバッチサービスによってタスクが再キューされた直近の時刻。 このプロパティはrequeueCountがゼロでない場合のみ設定されます。
lastRequeueTime?: Dateプロパティ値
Date
lastRetryTime
タスクの再挑戦が始まった直近の時です。 この要素はタスクが再試行された場合(すなわちretryCountがゼロでない場合)のみ存在します。 もし存在する場合、これは通常startTimeと同じですが、タスクが再試行以外の理由で再起動された場合は異なる場合があります。例えば、リトライ中にコンピュートノードが再起動された場合、startTimeは更新されますがlastRetryTimeは更新されません。
lastRetryTime?: Dateプロパティ値
Date
requeueCount
タスクがユーザーのリクエストの結果としてバッチサービスによって再キューされた回数です。 ユーザーがプールからコンピュートノードをリサイズ・縮小する際やジョブが無効化される際には、コンピュートノード上で実行中のタスクを実行のために再キューするよう指定できます。 このカウントは、これらの理由でタスクが何回再キューされたかを追跡しています。
requeueCount: numberプロパティ値
number
result
タスク実行の結果です。 値が「失敗」の場合、失敗の詳細はfailureInfoプロパティで確認できます。
result?: BatchTaskExecutionResultプロパティ値
retryCount
タスクがバッチサービスによって再試された回数。 タスクアプリケーション失敗(ゼロでない終了コード)は再試され、前処理エラー(タスクが実行できなかった)やファイルアップロードエラーは再試されません。 バッチサービスは制約で指定された制限までタスクを再試行します。
retryCount: numberプロパティ値
number
startTime
タスクが開始された時間。 「Running」は実行状態に対応しているため、タスクがリソースファイルやパッケージを指定する場合、開始時間はタスクがそれらをダウンロードまたは展開し始めた時刻を反映します。 タスクが再起動または再試行された場合、これはタスクが実行を開始した最新の時刻です。 このプロパティは、実行中または完了状態のタスクにのみ適用されます。
startTime?: Dateプロパティ値
Date
