Job - Disable

Service:

Batch Service

API Version:

2023-11-01.18.0

Отключает указанное задание, предотвращая выполнение новых задач.
Пакетная служба немедленно переместит задание в состояние отключения. Затем пакетная служба использует параметр disableTasks, чтобы определить, что делать с текущими задачами задания. Задание остается в состоянии отключения, пока операция отключения не будет завершена и все задачи не будут обработаны в соответствии с параметром disableTasks; Затем задание переходит в отключенное состояние. Новые задачи не запускаются в задании, пока оно не перейдет в активное состояние. При попытке отключить задание, которое находится в состоянии, отличном от активного, отключенного или отключенного, запрос завершается ошибкой с кодом состояния 409.

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

With optional parameters:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
batchUrl	path	True	string	Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure.
jobId	path	True	string	Идентификатор отключаемого задания.
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		Запрос к пакетной службе выполнен успешно. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Ошибка пакетной службы.

Безопасность

azure_auth

Microsoft Entra поток кода проверки подлинности OAuth 2.0

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

Scopes

Имя	Описание
user_impersonation	Олицетворение учетной записи пользователя

Authorization

Type: apiKey
In: header

Примеры

Job disable

Sample Request

HTTP

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



{
  "disableTasks": "terminate"
}

Sample Response

Status code:

202

Определения

Имя	Описание
BatchError	Ответ об ошибке, полученный от службы пакетная служба Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.
DisableJobOption	Что делать с активными задачами, связанными с заданием.
ErrorMessage	Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.
JobDisableParameter	Параметры при отключении задания.

BatchError

Ответ об ошибке, полученный от службы пакетная служба Azure.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
message	ErrorMessage	Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ об ошибке.

DisableJobOption

Что делать с активными задачами, связанными с заданием.

Имя	Тип	Описание
requeue	string	Завершение выполнения задач и их повторная постановка в очередь. Задачи будут выполняться снова, когда задание будет включено.
terminate	string	Завершите выполнение задач. Задачи будут завершены с параметром failureInfo, указывающим, что они были завершены, и больше не будут выполняться.
wait	string	Разрешить выполнение текущих задач.

ErrorMessage

Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.

Имя	Тип	Описание
lang	string	Код языка сообщения об ошибке
value	string	Текст сообщения.

JobDisableParameter

Параметры при отключении задания.

Имя	Тип	Описание
disableTasks	DisableJobOption	Что делать с активными задачами, связанными с заданием.