JobAddParameter interface
JobAddParameter を表すインターフェイス。
プロパティ
| common |
一般的な環境変数設定の一覧。 これらの環境変数は、ジョブ内のすべてのタスク (ジョブ マネージャー、ジョブ準備タスク、ジョブ解放タスクを含む) に設定されます。 個々のタスクは、同じ設定名を別の値で指定することで、ここで指定した環境設定をオーバーライドできます。 |
| constraints | ジョブの実行制約。 |
| display |
ジョブの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。 |
| id | アカウント内のジョブを一意に識別する文字列。 ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に大文字と小文字のみが異なる 2 つの ID がない可能性があります)。 |
| job |
ジョブの開始時に起動されるジョブ マネージャー タスクの詳細。 ジョブでジョブ マネージャー タスクが指定されていない場合、ユーザーはジョブにタスクを明示的に追加する必要があります。 ジョブでジョブ マネージャー タスクが指定されている場合、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 です。 |
| uses |
ジョブ内のタスクが相互に依存関係を定義できるかどうかを示します。 既定値は false です。 |
プロパティの詳細
commonEnvironmentSettings
一般的な環境変数設定の一覧。 これらの環境変数は、ジョブ内のすべてのタスク (ジョブ マネージャー、ジョブ準備タスク、ジョブ解放タスクを含む) に設定されます。 個々のタスクは、同じ設定名を別の値で指定することで、ここで指定した環境設定をオーバーライドできます。
commonEnvironmentSettings?: EnvironmentSetting[]プロパティ値
constraints
displayName
ジョブの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
displayName?: stringプロパティ値
string
id
アカウント内のジョブを一意に識別する文字列。 ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に大文字と小文字のみが異なる 2 つの ID がない可能性があります)。
id: stringプロパティ値
string
jobManagerTask
ジョブの開始時に起動されるジョブ マネージャー タスクの詳細。 ジョブでジョブ マネージャー タスクが指定されていない場合、ユーザーはジョブにタスクを明示的に追加する必要があります。 ジョブでジョブ マネージャー タスクが指定されている場合、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 です。
priority?: numberプロパティ値
number
usesTaskDependencies
ジョブ内のタスクが相互に依存関係を定義できるかどうかを示します。 既定値は false です。
usesTaskDependencies?: booleanプロパティ値
boolean