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