Pools - Enable Pool Auto Scale

Служба:: Batch Service

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

Включает автоматическое масштабирование пула.
Невозможно включить автоматическое масштабирование в пуле, если операция изменения размера выполняется в пуле. Если автоматическое масштабирование пула в настоящее время отключено, необходимо указать допустимую формулу автомасштабирования в рамках запроса. Если автоматическое масштабирование пула уже включено, можно указать новую формулу автомасштабирования и (или) новый интервал оценки. Этот API нельзя вызывать для одного пула более одного раза каждые 30 секунд.

POST {endpoint}/pools/{poolId}/enableautoscale?api-version=2025-06-01

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

POST {endpoint}/pools/{poolId}/enableautoscale?api-version=2025-06-01&timeOut={timeOut}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка учетной записи пакетной службы (например, https://batchaccount.eastus2.batch.azure.com).
poolId	path	True	string	Идентификатор пула, который требуется получить.
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"

Имя	Тип	Описание
autoScaleEvaluationInterval	string (duration)	Интервал времени, с помощью которого автоматически настраивается размер пула в соответствии с формулой автомасштабирования. Значение по умолчанию — 15 минут. Минимальное и максимальное значение — 5 минут и 168 часов соответственно. Если указать значение менее 5 минут или больше 168 часов, служба пакетной службы отклоняет запрос с ошибкой недопустимого значения свойства; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). Если указать новый интервал, то существующий график оценки автомасштаба будет остановлен, и начнётся новый график оценки автомасштаба, время которого соответствует моменту отправки этого запроса. Длительность времени указана в формате ISO 8601.
autoScaleFormula	string	Формула для требуемого количества вычислительных узлов в пуле. Значение по умолчанию — 15 минут. Минимальное и максимальное значение — 5 минут и 168 часов соответственно. Если указать значение менее 5 минут или больше 168 часов, служба пакетной службы отклоняет запрос с ошибкой недопустимого значения свойства; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). Если указать новый интервал, то существующий график оценки автомасштаба будет остановлен, и начнётся новый график оценки автомасштаба, время которого соответствует моменту отправки этого запроса.

Ответы

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

Имя

Тип

Описание

200 OK

Запрос выполнен успешно.

Заголовки

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

Примеры

Pool enable autoscale

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

HTTP

POST {endpoint}/pools/poolId/enableautoscale?api-version=2025-06-01



{
  "autoScaleFormula": "$TargetDedicated=0",
  "autoScaleEvaluationInterval": "PT8M"
}

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

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

Определения

Имя	Описание
BatchError	Получена ошибка от сервиса пакетная служба Azure.
BatchErrorDetail	Дополнительная информация, включённая в ответ на ошибку пакетная служба Azure.
BatchErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетная служба Azure.
BatchPoolEnableAutoScaleOptions	Parameters for enable automatic scaling on an пакетная служба Azure Pool.

BatchError

Объект

Получена ошибка от сервиса пакетная служба Azure.

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

BatchErrorDetail

Объект

Дополнительная информация, включённая в ответ на ошибку пакетная служба Azure.

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

BatchErrorMessage

Объект

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

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

BatchPoolEnableAutoScaleOptions

Объект

Parameters for enable automatic scaling on an пакетная служба Azure Pool.

Имя	Тип	Описание
autoScaleEvaluationInterval	string (duration)	Интервал времени, с помощью которого автоматически настраивается размер пула в соответствии с формулой автомасштабирования. Значение по умолчанию — 15 минут. Минимальное и максимальное значение — 5 минут и 168 часов соответственно. Если указать значение менее 5 минут или больше 168 часов, служба пакетной службы отклоняет запрос с ошибкой недопустимого значения свойства; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). Если указать новый интервал, то существующий график оценки автомасштаба будет остановлен, и начнётся новый график оценки автомасштаба, время которого соответствует моменту отправки этого запроса. Длительность времени указана в формате ISO 8601.
autoScaleFormula	string	Формула для требуемого количества вычислительных узлов в пуле. Значение по умолчанию — 15 минут. Минимальное и максимальное значение — 5 минут и 168 часов соответственно. Если указать значение менее 5 минут или больше 168 часов, служба пакетной службы отклоняет запрос с ошибкой недопустимого значения свойства; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). Если указать новый интервал, то существующий график оценки автомасштаба будет остановлен, и начнётся новый график оценки автомасштаба, время которого соответствует моменту отправки этого запроса.