JobSpecification interface
JobSpecification を表すインターフェイス。
プロパティ
| common |
一般的な環境変数の設定の一覧。 これらの環境変数は、このスケジュールで作成されたジョブ内のすべてのタスク (ジョブ マネージャー、ジョブ準備タスク、ジョブ解放タスクを含む) に設定されます。 個々のタスクは、同じ設定名を別の値で指定することで、ここで指定した環境設定をオーバーライドできます。 |
| constraints | このスケジュールで作成されたジョブの実行制約。 |
| display |
このスケジュールで作成されたジョブの表示名。 名前は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。 |
| job |
このスケジュールでジョブが開始されたときに起動されるジョブ マネージャー タスクの詳細。 ジョブでジョブ マネージャー タスクが指定されていない場合、ユーザーは Task API を使用してジョブにタスクを明示的に追加する必要があります。 ジョブでジョブ マネージャー タスクが指定されている場合、Batch サービスはジョブの作成時にジョブ マネージャー タスクを作成し、ジョブ内の他のタスクをスケジュールする前にジョブ マネージャー タスクのスケジュールを試みます。 |
| job |
このスケジュールで作成されたジョブのジョブ準備タスク。 ジョブにジョブ準備タスクがある場合、Batch サービスは、そのコンピューティング ノードでそのジョブのタスクを開始する前に、ノードでジョブ準備タスクを実行します。 |
| job |
このスケジュールで作成されたジョブのジョブ解放タスク。 ジョブ解放タスクの主な目的は、ジョブ準備タスクによって行われたノードの変更を元に戻すことです。 アクティビティの例としては、ローカル ファイルの削除や、ジョブの準備の一環として開始されたサービスのシャットダウンなどがあります。 ジョブ解放タスクは、ジョブのジョブ準備タスクも指定しないと指定できません。 Batch サービスは、ジョブ準備タスクを実行したコンピューティング ノードでジョブ解放タスクを実行します。 |
| metadata | このスケジュールでメタデータとして作成された各ジョブに関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。 |
| network |
ジョブのネットワーク構成。 |
| on |
このスケジュールで作成されたジョブ内のすべてのタスクが完了状態の場合に、Batch サービスが実行する必要があるアクション。 ジョブにタスクが含まれている場合、すべてのタスクは完了と見なされることに注意してください。 そのため、このオプションは、ジョブ マネージャー タスクで最もよく使用されます。ジョブ マネージャーなしでジョブの自動終了を使用する場合は、最初に onAllTasksComplete を noaction に設定し、タスクの追加が完了したらジョブを終了するように onAllTasksComplete に設定するように Job プロパティを更新する必要があります。 既定値は noaction です。 指定できる値は、'noAction'、'terminateJob' です。 |
| on |
このスケジュールで作成されたジョブでタスクが失敗した場合に Batch サービスが実行する必要があるアクション。 タスクは、failureInfo がある場合に失敗したと見なされます。 failureInfo は、再試行回数を使い果たした後にタスクが 0 以外の終了コードで完了した場合、またはリソース ファイルのダウンロード エラーが原因でタスクの開始エラーが発生した場合に設定されます。 既定値は noaction です。 指定できる値は、'noAction'、'performExitOptionsJobAction' です。 |
| pool |
Batch サービスがこのスケジュールで作成されたジョブのタスクを実行するプール。 |
| priority | このスケジュールで作成されたジョブの優先順位。 優先度の値の範囲は -1000 から 1000 までで、-1000 は最も低い優先度、1000 が最も高い優先度です。 既定値は 0 です。 この優先順位は、ジョブ スケジュールのすべてのジョブの既定値として使用されます。 ジョブの優先度は、ジョブの更新 API を使用して作成した後に更新できます。 |
| uses |
ジョブ内のタスクが相互に依存関係を定義できるかどうかを示します。 既定値は false です。 |
プロパティの詳細
commonEnvironmentSettings
一般的な環境変数の設定の一覧。 これらの環境変数は、このスケジュールで作成されたジョブ内のすべてのタスク (ジョブ マネージャー、ジョブ準備タスク、ジョブ解放タスクを含む) に設定されます。 個々のタスクは、同じ設定名を別の値で指定することで、ここで指定した環境設定をオーバーライドできます。
commonEnvironmentSettings?: EnvironmentSetting[]プロパティ値
constraints
displayName
このスケジュールで作成されたジョブの表示名。 名前は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
displayName?: stringプロパティ値
string
jobManagerTask
このスケジュールでジョブが開始されたときに起動されるジョブ マネージャー タスクの詳細。 ジョブでジョブ マネージャー タスクが指定されていない場合、ユーザーは Task API を使用してジョブにタスクを明示的に追加する必要があります。 ジョブでジョブ マネージャー タスクが指定されている場合、Batch サービスはジョブの作成時にジョブ マネージャー タスクを作成し、ジョブ内の他のタスクをスケジュールする前にジョブ マネージャー タスクのスケジュールを試みます。
jobManagerTask?: JobManagerTaskプロパティ値
jobPreparationTask
このスケジュールで作成されたジョブのジョブ準備タスク。 ジョブにジョブ準備タスクがある場合、Batch サービスは、そのコンピューティング ノードでそのジョブのタスクを開始する前に、ノードでジョブ準備タスクを実行します。
jobPreparationTask?: JobPreparationTaskプロパティ値
jobReleaseTask
このスケジュールで作成されたジョブのジョブ解放タスク。 ジョブ解放タスクの主な目的は、ジョブ準備タスクによって行われたノードの変更を元に戻すことです。 アクティビティの例としては、ローカル ファイルの削除や、ジョブの準備の一環として開始されたサービスのシャットダウンなどがあります。 ジョブ解放タスクは、ジョブのジョブ準備タスクも指定しないと指定できません。 Batch サービスは、ジョブ準備タスクを実行したコンピューティング ノードでジョブ解放タスクを実行します。
jobReleaseTask?: JobReleaseTaskプロパティ値
metadata
このスケジュールでメタデータとして作成された各ジョブに関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
metadata?: MetadataItem[]プロパティ値
networkConfiguration
onAllTasksComplete
このスケジュールで作成されたジョブ内のすべてのタスクが完了状態の場合に、Batch サービスが実行する必要があるアクション。 ジョブにタスクが含まれている場合、すべてのタスクは完了と見なされることに注意してください。 そのため、このオプションは、ジョブ マネージャー タスクで最もよく使用されます。ジョブ マネージャーなしでジョブの自動終了を使用する場合は、最初に onAllTasksComplete を noaction に設定し、タスクの追加が完了したらジョブを終了するように onAllTasksComplete に設定するように Job プロパティを更新する必要があります。 既定値は noaction です。 指定できる値は、'noAction'、'terminateJob' です。
onAllTasksComplete?: OnAllTasksCompleteプロパティ値
onTaskFailure
このスケジュールで作成されたジョブでタスクが失敗した場合に Batch サービスが実行する必要があるアクション。 タスクは、failureInfo がある場合に失敗したと見なされます。 failureInfo は、再試行回数を使い果たした後にタスクが 0 以外の終了コードで完了した場合、またはリソース ファイルのダウンロード エラーが原因でタスクの開始エラーが発生した場合に設定されます。 既定値は noaction です。 指定できる値は、'noAction'、'performExitOptionsJobAction' です。
onTaskFailure?: OnTaskFailureプロパティ値
poolInfo
priority
このスケジュールで作成されたジョブの優先順位。 優先度の値の範囲は -1000 から 1000 までで、-1000 は最も低い優先度、1000 が最も高い優先度です。 既定値は 0 です。 この優先順位は、ジョブ スケジュールのすべてのジョブの既定値として使用されます。 ジョブの優先度は、ジョブの更新 API を使用して作成した後に更新できます。
priority?: numberプロパティ値
number
usesTaskDependencies
ジョブ内のタスクが相互に依存関係を定義できるかどうかを示します。 既定値は false です。
usesTaskDependencies?: booleanプロパティ値
boolean