Job Schedules - Terminate Job Schedule

Служба:
Batch Service
Версия API:
2025-06-01

Прекращает график работы.

POST {endpoint}/jobschedules/{jobScheduleId}/terminate?api-version=2025-06-01
С использованием необязательных параметров: 
POST {endpoint}/jobschedules/{jobScheduleId}/terminate?api-version=2025-06-01&timeOut={timeOut}&force={force}

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string (uri)

Конечная точка учетной записи пакетной службы (например, https://batchaccount.eastus2.batch.azure.com).
jobScheduleId
 path True

string

Идентификатор расписания работы заканчивается.
api-version
 query True

string

minLength: 1

Версия API, используемая для данной операции.
force
 query

boolean

Если верно, сервер завершит JobSchedule, даже если соответствующие узлы ещё не полностью обработали завершение. По умолчанию используется значение false.
timeOut
 query

integer (int32)

Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение превышает 30, вместо этого используется стандартное значение.".

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

Имя Обязательно Тип Описание
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 ресурса в службе не соответствует значению, указанному клиентом.

Ответы

Имя Тип Описание
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

Примеры

JobSchedule terminate

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

POST {endpoint}/jobschedules/jobScheduleId/terminate?api-version=2025-06-01

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

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

Определения

Имя Описание
BatchError

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

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

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

BatchError

Объект

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

Имя Тип Описание
code

string

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

BatchErrorMessage

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

BatchErrorDetail[]

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

BatchErrorDetail

Объект

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

Имя Тип Описание
key

string

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

string

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

BatchErrorMessage

Объект

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

Имя Тип Описание
lang

string

Языковой код сообщения об ошибке.
value

string

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