BatchJobUpdateOptions interface
Azure Batch ジョブを更新するためのパラメーター。
プロパティ
| allow |
このジョブのタスクを他の優先度の高いジョブに割り込むことができるかどうか。 (このプロパティはデフォルトでは使用できません。詳細については、サポートにお問い合わせください)この値を True に設定すると、システムに送信された他の優先度の高いジョブが優先され、このジョブからタスクを再キューに入れることができます。 ジョブの allowTaskPreemption は、更新ジョブ API を使用して作成された後で更新できます。 |
| all |
ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。 省略すると、完了動作は変更されません。 値を terminatejob から noaction に変更することはできません。つまり、ジョブの自動終了を開始した後は、もう一度オフにすることはできません。 これを行おうとすると、要求は "無効なプロパティ値" エラー応答で失敗します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 |
| constraints | ジョブの実行制約。 省略すると、既存の実行制約は変更されません。 |
| max |
ジョブに対して並列に実行できるタスクの最大数。 (このプロパティはデフォルトでは使用できません。詳細については、サポートにお問い合わせください)maxParallelTasks の値は、指定されている場合は -1 または 0 より大きくする必要があります。 指定しない場合、既定値は -1 です。つまり、一度に実行できるタスクの数に制限はありません。 ジョブの maxParallelTasks は、更新ジョブ API を使用して作成された後で更新できます。 |
| metadata | ジョブにメタデータとして関連付けられている名前と値のペアの一覧。 省略すると、既存のジョブ メタデータは変更されません。 |
| network |
(このプロパティはデフォルトでは使用できません。詳細については、サポートにお問い合わせください)ジョブのネットワーク構成。 |
| pool |
Batch サービスがジョブのタスクを実行するプール。 ジョブのプールは、ジョブが無効になっている場合にのみ変更できます。 poolInfo 要素を含め、ジョブが無効でない場合、パッチ ジョブの呼び出しは失敗します。 poolInfo で autoPoolSpecification を指定した場合は、autoPoolSpecification の keepAlive プロパティのみを更新でき、autoPoolSpecification に job の poolLifetimeOption がある場合にのみ更新できます (他のジョブ プロパティは通常どおりに更新できます)。 省略した場合、ジョブは現在のプールで引き続き実行されます。 |
| priority | ジョブの優先順位。 優先度の値の範囲は -1000 から 1000 までで、-1000 は最も低い優先度、1000 が最も高い優先度です。 省略すると、ジョブの優先度は変更されません。 |
プロパティの詳細
allowTaskPreemption
このジョブのタスクを他の優先度の高いジョブに割り込むことができるかどうか。 (このプロパティはデフォルトでは使用できません。詳細については、サポートにお問い合わせください)この値を True に設定すると、システムに送信された他の優先度の高いジョブが優先され、このジョブからタスクを再キューに入れることができます。 ジョブの allowTaskPreemption は、更新ジョブ API を使用して作成された後で更新できます。
allowTaskPreemption?: booleanプロパティ値
boolean
allTasksCompleteMode
ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。 省略すると、完了動作は変更されません。 値を terminatejob から noaction に変更することはできません。つまり、ジョブの自動終了を開始した後は、もう一度オフにすることはできません。 これを行おうとすると、要求は "無効なプロパティ値" エラー応答で失敗します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
allTasksCompleteMode?: BatchAllTasksCompleteModeプロパティ値
constraints
maxParallelTasks
ジョブに対して並列に実行できるタスクの最大数。 (このプロパティはデフォルトでは使用できません。詳細については、サポートにお問い合わせください)maxParallelTasks の値は、指定されている場合は -1 または 0 より大きくする必要があります。 指定しない場合、既定値は -1 です。つまり、一度に実行できるタスクの数に制限はありません。 ジョブの maxParallelTasks は、更新ジョブ API を使用して作成された後で更新できます。
maxParallelTasks?: numberプロパティ値
number
metadata
ジョブにメタデータとして関連付けられている名前と値のペアの一覧。 省略すると、既存のジョブ メタデータは変更されません。
metadata?: BatchMetadataItem[]プロパティ値
networkConfiguration
(このプロパティはデフォルトでは使用できません。詳細については、サポートにお問い合わせください)ジョブのネットワーク構成。
networkConfiguration?: BatchJobNetworkConfigurationプロパティ値
poolInfo
Batch サービスがジョブのタスクを実行するプール。 ジョブのプールは、ジョブが無効になっている場合にのみ変更できます。 poolInfo 要素を含め、ジョブが無効でない場合、パッチ ジョブの呼び出しは失敗します。 poolInfo で autoPoolSpecification を指定した場合は、autoPoolSpecification の keepAlive プロパティのみを更新でき、autoPoolSpecification に job の poolLifetimeOption がある場合にのみ更新できます (他のジョブ プロパティは通常どおりに更新できます)。 省略した場合、ジョブは現在のプールで引き続き実行されます。
poolInfo?: BatchPoolInfoプロパティ値
priority
ジョブの優先順位。 優先度の値の範囲は -1000 から 1000 までで、-1000 は最も低い優先度、1000 が最も高い優先度です。 省略すると、ジョブの優先度は変更されません。
priority?: numberプロパティ値
number
