Jobs - Disable Job

Служба:: Batch Service

Версия API:: 2025-06-01

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

POST {endpoint}/jobs/{jobId}/disable?api-version=2025-06-01

С использованием необязательных параметров:

POST {endpoint}/jobs/{jobId}/disable?api-version=2025-06-01&timeOut={timeOut}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка учетной записи пакетной службы (например, https://batchaccount.eastus2.batch.azure.com).
jobId	path	True	string	ID работы для отключения.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
timeOut	query		integer (int32)	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение превышает 30, вместо этого используется стандартное значение.".

Заголовок запроса

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

Имя	Тип	Описание
client-request-id	string	Удостоверение запроса, созданное вызывающим пользователем, в виде GUID без украшений, таких как фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Должен ли сервер возвращать идентификатор client-request-id в ответе.
ocp-date	string (date-time-rfc7231)	Время выдачи запроса. Клиентские библиотеки обычно задают это в текущее время системных часов; задайте его явным образом, если вы вызываете REST API напрямую.
If-Modified-Since	string (date-time-rfc7231)	Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
If-Unmodified-Since	string (date-time-rfc7231)	Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс в службе не был изменен с указанного времени.
If-Match	string	Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе точно соответствует значению, указанному клиентом.
If-None-Match	string	Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе не соответствует значению, указанному клиентом.

Текст запроса

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

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

Ответы

Имя	Тип	Описание
202 Accepted		Запрос был принят для обработки, но обработка еще не завершена. Заголовки DataServiceId: string ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

202 Accepted

Запрос был принят для обработки, но обработка еще не завершена.

Заголовки

DataServiceId: string
ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

Непредвиденное сообщение об ошибке.

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

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://batch.core.windows.net//.default

Примеры

Job disable

Образец запроса

HTTP

POST {endpoint}/jobs/jobId/disable?api-version=2025-06-01



{
  "disableTasks": "terminate"
}

Пример ответа

Код состояния:: 202

Определения

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

BatchError

Объект

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

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

BatchErrorDetail

Объект

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

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

BatchErrorMessage

Объект

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

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

BatchJobDisableOptions

Объект

Параметры отключения задания пакетной службы Azure.

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

DisableBatchJobOption

Перечисление

Enums disableBatchJobOption

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