Job - Disable

停用指定的工作,防止新的工作執行。
Batch 服務會立即將工作移至停用狀態。 Batch 接著會使用 disableTasks 參數來決定要如何處理目前正在執行的工作。 作業會維持在停用狀態,直到停用作業完成,而且所有工作都已根據 disableTasks 選項處理為止;作業接著會移至 [已停用] 狀態。 在工作下,將不會啟動任何新的工作,直到它移回 [作用中] 狀態。 如果您嘗試停用處于作用中、停用或停用以外狀態的作業,要求會失敗,並出現狀態碼409。

POST {batchUrl}/jobs/{jobId}/disable?api-version=2020-09-01.12.0
POST {batchUrl}/jobs/{jobId}/disable?timeout={timeout}&api-version=2020-09-01.12.0

URI 參數

Name In Required Type Description
batchUrl
path True
  • string

所有 Azure Batch 服務要求的基底 URL。

jobId
path True
  • string

要停用之作業的識別碼。

api-version
query True
  • string

用戶端 API 版本。

timeout
query
  • integer
int32

伺服器可花費在處理要求的時間上限(以秒為單位)。 預設值為 30 秒。

要求標頭

Media Types: "application/json; odata=minimalmetadata"

Name Required Type Description
client-request-id
  • string
uuid

呼叫端產生的要求身分識別,以 GUID 的形式呈現,沒有任何裝飾,例如大括弧,例如9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。

return-client-request-id
  • boolean

伺服器是否應在回應中傳回用戶端要求識別碼。

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"

Name Required Type Description
disableTasks True

使用與工作相關聯的作用中工作。

回應

Name Type Description
202 Accepted

對 Batch 服務的要求成功。

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

來自 Batch 服務的錯誤。

安全性

azure_auth

Azure Active Directory OAuth2 流程

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模擬您的使用者帳戶

Authorization

Type: apiKey
In: header

範例

Job disable

Sample Request

POST account.region.batch.azure.com/jobs/jobId/disable?api-version=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "disableTasks": "terminate"
}

Sample Response

定義

BatchError

從 Azure Batch 服務收到的錯誤回應。

BatchErrorDetail

包含在 Azure Batch 錯誤回應中的其他資訊專案。

DisableJobOption

使用與工作相關聯的作用中工作。

ErrorMessage

在 Azure Batch 錯誤回應中收到的錯誤訊息。

JobDisableParameter

停用作業時的選項。

BatchError

從 Azure Batch 服務收到的錯誤回應。

Name Type Description
code
  • string

錯誤的識別碼。 程式碼是不變的,旨在以程式設計的方式取用。

message

描述錯誤的訊息,其適用于在使用者介面中顯示。

values

機碼值組的集合,其中包含有關錯誤的其他詳細資料。

BatchErrorDetail

包含在 Azure Batch 錯誤回應中的其他資訊專案。

Name Type Description
key
  • string

指定 Value 屬性之意義的識別碼。

value
  • string

錯誤回應中所包含的其他資訊。

DisableJobOption

使用與工作相關聯的作用中工作。

Name Type Description
requeue
  • string

終止執行中的工作並 requeue 它們。 當工作啟用時,工作將會再次執行。

terminate
  • string

終止執行中的工作。 工作將會完成,並以 >result 表示已終止這些工作,而且不會再次執行。

wait
  • string

允許正在執行的工作完成。

ErrorMessage

在 Azure Batch 錯誤回應中收到的錯誤訊息。

Name Type Description
lang
  • string

錯誤訊息的語言代碼

value
  • string

訊息的文字。

JobDisableParameter

停用作業時的選項。

Name Type Description
disableTasks

使用與工作相關聯的作用中工作。