Job - Disable

  • Ссылка
Service:
Batch Service
API Version:
2022-01-01.15.0

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

POST {batchUrl}/jobs/{jobId}/disable?api-version=2022-01-01.15.0
With optional parameters: 
POST {batchUrl}/jobs/{jobId}/disable?timeout={timeout}&api-version=2022-01-01.15.0

Параметры URI

Name In Required Type Description
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"

Name Required Type 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"

Name Required Type Description
disableTasks True

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

Ответы

Name Type Description
202 Accepted

Запрос к пакетной службе выполнен успешно.

Headers

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

Ошибка пакетной службы.

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

azure_auth

Flow OAuth2 Azure Active Directory

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=2022-01-01.15.0



{
  "disableTasks": "terminate"
}

Sample Response

Status code:
202

Определения

BatchError

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

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

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

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

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

BatchError

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

Name Type Description
code
  • string

Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
message

Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values

Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

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

Name Type Description
key
  • string

Идентификатор, указывающий значение свойства Value.
value
  • string

Дополнительные сведения, включенные в ответ на ошибку.

DisableJobOption

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

Name Type Description
requeue
  • string

Завершите выполнение задач и повторите их. Задачи будут выполняться снова, когда задание включено.
terminate
  • string

Завершение выполнения задач. Задачи будут завершены с помощью failureInfo, указывая, что они были завершены и не будут выполняться снова.
wait
  • string

Разрешить выполнение задач в настоящее время.

ErrorMessage

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

Name Type Description
lang
  • string

Код языка сообщения об ошибке
value
  • string

Текст сообщения.

JobDisableParameter

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

Name Type Description
disableTasks

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