Job - Disable
停用指定的作業，防止執行新的工作。
Batch 服務會立即將作業移至停用狀態。 Batch 接著會使用 disableTasks 參數來判斷目前執行中作業的工作該怎麼辦。 作業會維持停用狀態，直到停用作業完成，且所有工作都已根據 disableTasks 選項進行處理;作業接著會移至停用狀態。 在工作回到使用中狀態之前，不會在 [作業] 下啟動任何新工作。 如果您嘗試停用處於作用中、停用或停用以外的任何狀態的作業，要求會失敗，狀態代碼為 409。
POST {batchUrl}/jobs/{jobId}/disable?api-version=2023-11-01.18.0POST {batchUrl}/jobs/{jobId}/disable?timeout={timeout}&api-version=2023-11-01.18.0URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
batch
|
path | True |
string |
所有 Azure Batch 服務要求的基底 URL。 |
|
job
|
path | True |
string |
要停用之作業的標識碼。 |
|
api-version
|
query | True |
string |
用戶端 API 版本。 |
|
timeout
|
query |
integer int32 |
伺服器可以花費在處理要求的最大時間，以秒為單位。 預設值為 30 秒。 |
要求標頭
Media Types: "application/json; odata=minimalmetadata"
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| client-request-id |
string uuid |
呼叫端產生的要求識別，格式為不含大括弧的 GUID，例如大括弧，例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。 |
|
| return-client-request-id |
boolean |
伺服器是否應該在回應中傳回 client-request-id。 |
|
| ocp-date |
string date-time-rfc1123 |
發出要求的時間。 用戶端連結庫通常會將此設定為目前的系統時鐘時間;如果您要直接呼叫 REST API，請明確設定它。 |
|
| If-Match |
string |
與用戶端已知資源版本的 ETag 值相關聯。 只有在服務上資源的目前 ETag 完全符合用戶端所指定的值時，才會執行作業。 |
|
| If-None-Match |
string |
與用戶端已知資源版本的 ETag 值相關聯。 只有在服務的目前 ETag 不符合用戶端所指定的值時，才會執行作業。 |
|
| If-Modified-Since |
string date-time-rfc1123 |
時間戳，表示用戶端已知資源的上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行作業。 |
|
| If-Unmodified-Since |
string date-time-rfc1123 |
時間戳，表示用戶端已知資源的上次修改時間。 只有在服務上的資源自指定時間之後尚未修改時，才會執行作業。 |
要求本文
Media Types: "application/json; odata=minimalmetadata"
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| disableTasks | True |
與作業相關聯的使用中工作該怎麼辦。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 202 Accepted |
Batch 服務的要求成功。 標題
|
|
| Other Status Codes |
Batch 服務的錯誤。 |
安全性
azure_auth
Microsoft Entra OAuth 2.0 驗證碼流程
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
| 名稱 | Description |
|---|---|
| user_impersonation | 模擬您的用戶帳戶 |
Authorization
類型:
apiKey
位於:
header
範例
Job disable
範例要求
POST account.region.batch.azure.com/jobs/jobId/disable?api-version=2023-11-01.18.0
{
"disableTasks": "terminate"
}
範例回覆
定義
| 名稱 | Description |
|---|---|
|
Batch |
從 Azure Batch 服務收到的錯誤回應。 |
|
Batch |
Azure Batch 錯誤回應中包含的其他信息專案。 |
|
Disable |
與作業相關聯的使用中工作該怎麼辦。 |
|
Error |
Azure Batch 錯誤回應中收到的錯誤訊息。 |
|
Job |
停用作業時的選項。 |
BatchError
從 Azure Batch 服務收到的錯誤回應。
| 名稱 | 類型 | Description |
|---|---|---|
| code |
string |
錯誤的識別碼。 程式碼不變，且要以程式設計方式使用。 |
| message |
描述錯誤的訊息，適用於在使用者介面中顯示。 |
|
| values |
索引鍵/值組的集合，其中包含錯誤的其他詳細數據。 |
BatchErrorDetail
Azure Batch 錯誤回應中包含的其他信息專案。
| 名稱 | 類型 | Description |
|---|---|---|
| key |
string |
指定 Value 屬性意義的識別碼。 |
| value |
string |
錯誤回應中包含的其他資訊。 |
DisableJobOption
與作業相關聯的使用中工作該怎麼辦。
| 名稱 | 類型 | Description |
|---|---|---|
| requeue |
string |
終止執行中的工作，並重新排入佇列。 啟用作業時，工作會再次執行。 |
| terminate |
string |
終止執行中的工作。 工作將會以 failureInfo 完成，指出它們已終止，且不會再次執行。 |
| wait |
string |
允許目前正在執行的工作完成。 |
ErrorMessage
Azure Batch 錯誤回應中收到的錯誤訊息。
| 名稱 | 類型 | Description |
|---|---|---|
| lang |
string |
錯誤訊息的語言代碼 |
| value |
string |
訊息的文字。 |
JobDisableParameter
停用作業時的選項。
| 名稱 | 類型 | Description |
|---|---|---|
| disableTasks |
與作業相關聯的使用中工作該怎麼辦。 |