你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Job - Disable

服务:

Batch Service

API 版本:

2023-11-01.18.0

禁用指定的作业，阻止运行新的任务。
Batch 服务会立即将作业移动到禁用状态。 然后，Batch 使用 disableTasks 参数确定对作业当前正在运行的任务执行的操作。 作业将一直处于禁用状态，直到禁用操作完成并且已根据 disableTasks 选项处理所有任务;然后，作业将移动到禁用状态。 在作业返回到活动状态之前，不会在作业下启动任何新任务。 如果尝试禁用处于活动、禁用或禁用状态以外的任何状态的作业，请求将失败，状态代码为 409。

POST {batchUrl}/jobs/{jobId}/disable?api-version=2023-11-01.18.0

具有可选参数:

POST {batchUrl}/jobs/{jobId}/disable?timeout={timeout}&api-version=2023-11-01.18.0

URI 参数

名称	在	必需	类型	说明
batchUrl	path	True	string	所有Azure Batch服务请求的基 URL。
jobId	path	True	string	要禁用的作业的 ID。
api-version	query	True	string	客户端 API 版本。
timeout	query		integer int32	服务器可以花费处理请求的最长时间（以秒为单位）。 默认为 30 秒。

请求头

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

名称	必需	类型	说明
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"

名称	必需	类型	说明
disableTasks	True	DisableJobOption	如何处理与作业关联的活动任务。

响应

名称	类型	说明
202 Accepted		对 Batch 服务的请求已成功。 标头 client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Batch 服务中的错误。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

Authorization

类型: apiKey
在: header

示例

Job disable

示例请求

HTTP

POST account.region.batch.azure.com/jobs/jobId/disable?api-version=2023-11-01.18.0



{
  "disableTasks": "terminate"
}

示例响应

状态代码:

202

定义

名称	说明
BatchError	从Azure Batch服务收到的错误响应。
BatchErrorDetail	Azure Batch错误响应中包含的其他信息项。
DisableJobOption	如何处理与作业关联的活动任务。
ErrorMessage	Azure Batch错误响应中收到的错误消息。
JobDisableParameter	禁用作业时的选项。

BatchError

从Azure Batch服务收到的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
message	ErrorMessage	描述错误的消息，该消息适用于在用户界面中显示。
values	BatchErrorDetail[]	包含有关错误的其他详细信息的键值对的集合。

BatchErrorDetail

Azure Batch错误响应中包含的其他信息项。

名称	类型	说明
key	string	指定 Value 属性含义的标识符。
value	string	错误响应附带的其他信息。

DisableJobOption

如何处理与作业关联的活动任务。

名称	类型	说明
requeue	string	终止正在运行的任务并重新排队。 启用作业后，任务将再次运行。
terminate	string	终止正在运行的任务。 任务将完成，并显示 failureInfo，指示它们已终止，并且不会再次运行。
wait	string	允许当前运行的任务完成。

ErrorMessage

Azure Batch错误响应中收到的错误消息。

名称	类型	说明
lang	string	错误消息的语言代码
value	string	消息的文本。

JobDisableParameter

禁用作业时的选项。

名称	类型	说明
disableTasks	DisableJobOption	如何处理与作业关联的活动任务。