JobUpdateParameter interface
JobUpdateParameter を表すインターフェイス。
プロパティ
| constraints | ジョブの実行制約。 省略すると、制約はクリアされます。 |
| metadata | ジョブにメタデータとして関連付けられている名前と値のペアの一覧。 省略すると、空のリストの既定値が使用されます。実際には、既存のメタデータはすべて削除されます。 |
| on |
ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。 省略すると、完了動作は noaction に設定されます。 現在の値が terminatejob の場合、ジョブの完了動作が terminatejob から noaction に変更されない可能性があるため、これはエラーです。 値を terminatejob から noaction に変更することはできません。つまり、ジョブの自動終了を開始した後は、もう一度オフにすることはできません。 これを行おうとすると、要求は失敗し、Batch は状態コード 400 (無効な要求) と "無効なプロパティ値" エラー応答を返します。 PUT 要求でこの要素を指定しない場合、noaction を渡すことと同じです。 現在の値が terminatejob の場合、これはエラーです。 指定できる値は、'noAction'、'terminateJob' です。 |
| pool |
Batch サービスがジョブのタスクを実行するプール。 ジョブのプールは、ジョブが無効になっている場合にのみ変更できます。 poolInfo 要素を含め、ジョブが無効でない場合、Update Job 呼び出しは失敗します。 poolInfo で autoPoolSpecification を指定した場合は、autoPoolSpecification の keepAlive プロパティのみを更新でき、autoPoolSpecification に job の poolLifetimeOption がある場合にのみ更新できます (他のジョブ プロパティは通常どおりに更新できます)。 |
| priority | ジョブの優先順位。 優先度の値の範囲は -1000 から 1000 までで、-1000 は最も低い優先度、1000 が最も高い優先度です。 省略すると、既定値 0 に設定されます。 |
プロパティの詳細
constraints
metadata
ジョブにメタデータとして関連付けられている名前と値のペアの一覧。 省略すると、空のリストの既定値が使用されます。実際には、既存のメタデータはすべて削除されます。
metadata?: MetadataItem[]プロパティ値
onAllTasksComplete
ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。 省略すると、完了動作は noaction に設定されます。 現在の値が terminatejob の場合、ジョブの完了動作が terminatejob から noaction に変更されない可能性があるため、これはエラーです。 値を terminatejob から noaction に変更することはできません。つまり、ジョブの自動終了を開始した後は、もう一度オフにすることはできません。 これを行おうとすると、要求は失敗し、Batch は状態コード 400 (無効な要求) と "無効なプロパティ値" エラー応答を返します。 PUT 要求でこの要素を指定しない場合、noaction を渡すことと同じです。 現在の値が terminatejob の場合、これはエラーです。 指定できる値は、'noAction'、'terminateJob' です。
onAllTasksComplete?: OnAllTasksCompleteプロパティ値
poolInfo
Batch サービスがジョブのタスクを実行するプール。 ジョブのプールは、ジョブが無効になっている場合にのみ変更できます。 poolInfo 要素を含め、ジョブが無効でない場合、Update Job 呼び出しは失敗します。 poolInfo で autoPoolSpecification を指定した場合は、autoPoolSpecification の keepAlive プロパティのみを更新でき、autoPoolSpecification に job の poolLifetimeOption がある場合にのみ更新できます (他のジョブ プロパティは通常どおりに更新できます)。
poolInfo: PoolInformationプロパティ値
priority
ジョブの優先順位。 優先度の値の範囲は -1000 から 1000 までで、-1000 は最も低い優先度、1000 が最も高い優先度です。 省略すると、既定値 0 に設定されます。
priority?: numberプロパティ値
number