Pools - Replace Pool Properties

Служба:: Batch Service

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

Обновляет свойства указанного пула.
Это полностью заменяет все обновляемые свойства Пула. Например, если к пулу связана StartTask и если StartTask не указан в этом запросе, то пакетная служба удалит существующий StartTask.

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

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

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

Параметры URI

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

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

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

Имя	Обязательно	Тип	Описание
applicationPackageReferences	True	BatchApplicationPackageReference[]	Список пакетов приложений, установленных на каждом вычислительном узле в пуле. Список заменяет все существующие ссылки на пакет приложений в пуле. Изменения ссылок на пакет приложений влияют на все новые вычислительные узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не перезагружаются или переимываются. В любом пуле имеется не более 10 ссылок на пакет приложения. Если опущен или указана пустая коллекция, все существующие ссылки на пакеты приложений удаляются из пула. В данном пуле может быть указано не более 10 ссылок.
metadata	True	BatchMetadataItem[]	Список пар "имя-значение", связанных с пулом в качестве метаданных. Этот список заменяет все существующие метаданные, настроенные в пуле. Если опущен или указана пустая коллекция, все существующие метаданные удаляются из пула.
startTask		BatchStartTask	Задача, выполняемая на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла. Если этот элемент присутствует, он перезаписывает все существующие StartTask. Если опущено, из пула удаляется любой существующий startTask.

Ответы

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

Имя

Тип

Описание

204 No Content

Для этого запроса нет содержимого, но заголовки могут быть полезны.

Заголовки

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 update

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

HTTP

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



{
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'"
  },
  "applicationPackageReferences": [],
  "metadata": []
}

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

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

Определения

Имя	Описание
AutoUserScope	AutoUserScope enums
AutoUserSpecification	Указывает параметры автоматического пользователя, выполняющего задачу пакетной службы Azure.
BatchApplicationPackageReference	Ссылка на пакет для развертывания на вычислительных узлах.
BatchError	Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
BatchErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
BatchMetadataItem	Пакетная служба не назначает никакое значение этим метаданным; он предназначен исключительно для использования пользовательского кода.
BatchNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
BatchPoolReplaceOptions	Параметры замены свойств в пуле пакетной службы Azure.
BatchStartTask	Пакетная служба будет повторять задачи при активации операции восстановления на узле. Примеры операций восстановления включают (но не ограничиваются) при перезагрузке неработоспособного узла или вычислительном узле исчезли из-за сбоя узла. Повторные попытки из-за операций восстановления не учитываются и не учитываются для maxTaskRetryCount. Даже если значение maxTaskRetryCount равно 0, может произойти внутренняя повторная попытка из-за операции восстановления. Из-за этого все задачи должны быть идемпотентными. Это означает, что задачи должны терпеть прерывание и перезапуск без повреждения или дублирования данных. Рекомендуется использовать определенную форму контрольных точек для длительных задач. В некоторых случаях запуск StartTask может выполняться повторно, даже если вычислительный узел не был перезагружен. Следует учесть, чтобы избежать запуска StartTasks, создающих отсортовый процесс или установку или запуск служб из рабочего каталога StartTask, так как это приведет к тому, что пакетная служба сможет повторно запустить StartTask.
BatchTaskContainerSettings	Параметры контейнера для задачи.
ContainerHostBatchBindMountEntry	Вход пути и режима подключения, который требуется подключить к контейнеру задач.
ContainerHostDataPath	Пути, которые будут подключены к контейнеру задачи контейнера.
ContainerRegistryReference	Частный реестр контейнеров.
ContainerWorkingDirectory	ContainerWorkingDirectory enums
ElevationLevel	Enums ElevationLevel
EnvironmentSetting	Переменная среды, устанавливаемая в процессе задачи.
ResourceFile	Один файл или несколько файлов, которые нужно скачать на вычислительный узел.
UserIdentity	Определение удостоверения пользователя, в котором выполняется задача. Укажите свойство userName или autoUser, но не оба.

AutoUserScope

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

AutoUserScope enums

Значение	Описание
task	Указывает, что сервис должен создать нового пользователя для задачи.
pool	Указывает, что задача выполняется как общий автопользовательский аккаунт, который создаётся на каждом вычислительном узле пула.

AutoUserSpecification

Объект

Указывает параметры автоматического пользователя, выполняющего задачу пакетной службы Azure.

Имя	Тип	Описание
elevationLevel	ElevationLevel	Уровень повышения прав автоматического пользователя. Значение по умолчанию — nonAdmin.
scope	AutoUserScope	Область для автоматического пользователя. Значение по умолчанию — пул. Если пул работает под управлением Windows, необходимо указать значение задачи, если требуется более строгая изоляция между задачами. Например, если задача изменяет реестр таким образом, что это может повлиять на другие задачи.

BatchApplicationPackageReference

Объект

Ссылка на пакет для развертывания на вычислительных узлах.

Имя	Тип	Описание
applicationId	string	ID приложения для развертывания. При создании пула идентификатор приложения пакета должен быть полным (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Версия приложения для развертывания. Если опущено, будет развернута версия по умолчанию. Если это опущено в пуле, и для этого приложения не указана стандартная версия, запрос не выполняется с кодом ошибки InvalidApplicationPackageReferences и HTTP-кодом статуса 409. Если это опущено в задаче, и для этого приложения не указана стандартная версия, задача проваливается с ошибкой предварительной обработки.

BatchError

Объект

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

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

BatchErrorDetail

Объект

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

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

BatchErrorMessage

Объект

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

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

BatchMetadataItem

Объект

Пакетная служба не назначает никакое значение этим метаданным; он предназначен исключительно для использования пользовательского кода.

Имя	Тип	Описание
name	string	Имя элемента метаданных.
value	string	Значение элемента метаданных.

BatchNodeIdentityReference

Объект

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

Имя	Тип	Описание
resourceId	string (arm-id)	Идентификатор ресурса ARM назначенного пользователем удостоверения.

BatchPoolReplaceOptions

Объект

Параметры замены свойств в пуле пакетной службы Azure.

Имя	Тип	Описание
applicationPackageReferences	BatchApplicationPackageReference[]	Список пакетов приложений, установленных на каждом вычислительном узле в пуле. Список заменяет все существующие ссылки на пакет приложений в пуле. Изменения ссылок на пакет приложений влияют на все новые вычислительные узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не перезагружаются или переимываются. В любом пуле имеется не более 10 ссылок на пакет приложения. Если опущен или указана пустая коллекция, все существующие ссылки на пакеты приложений удаляются из пула. В данном пуле может быть указано не более 10 ссылок.
metadata	BatchMetadataItem[]	Список пар "имя-значение", связанных с пулом в качестве метаданных. Этот список заменяет все существующие метаданные, настроенные в пуле. Если опущен или указана пустая коллекция, все существующие метаданные удаляются из пула.
startTask	BatchStartTask	Задача, выполняемая на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла. Если этот элемент присутствует, он перезаписывает все существующие StartTask. Если опущено, из пула удаляется любой существующий startTask.

BatchStartTask

Объект

Пакетная служба будет повторять задачи при активации операции восстановления на узле. Примеры операций восстановления включают (но не ограничиваются) при перезагрузке неработоспособного узла или вычислительном узле исчезли из-за сбоя узла. Повторные попытки из-за операций восстановления не учитываются и не учитываются для maxTaskRetryCount. Даже если значение maxTaskRetryCount равно 0, может произойти внутренняя повторная попытка из-за операции восстановления. Из-за этого все задачи должны быть идемпотентными. Это означает, что задачи должны терпеть прерывание и перезапуск без повреждения или дублирования данных. Рекомендуется использовать определенную форму контрольных точек для длительных задач. В некоторых случаях запуск StartTask может выполняться повторно, даже если вычислительный узел не был перезагружен. Следует учесть, чтобы избежать запуска StartTasks, создающих отсортовый процесс или установку или запуск служб из рабочего каталога StartTask, так как это приведет к тому, что пакетная служба сможет повторно запустить StartTask.

Имя	Тип	Описание
commandLine	string	Командная строка StartTask. Командная строка не выполняется под оболочкой и поэтому не может воспользоваться преимуществами функций оболочки, таких как расширение переменной среды. Если вы хотите воспользоваться такими функциями, необходимо вызвать оболочку в командной строке, например с помощью cmd /c MyCommand в Windows или "/bin/sh -c MyCommand" в Linux. Если командная строка ссылается на пути к файлам, она должна использовать относительный путь (относительно рабочего каталога задачи) или использовать указанную пакетную переменную среды (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).
containerSettings	BatchTaskContainerSettings	Настройки контейнера, под которым работает StartTask. Когда это указано, все каталоги рекурсивно ниже AZ_BATCH_NODE_ROOT_DIR (корня Azure Batch каталогов на узле) отображаются в контейнер, все переменные среды задачи отображаются в контейнер, и в контейнере выполняется командная строка задачи. Файлы, созданные в контейнере вне AZ_BATCH_NODE_ROOT_DIR, могут не отражаться на хост-диске, что означает, что API пакетных файлов не смогут получить доступ к этим файлам.
environmentSettings	EnvironmentSetting[]	Список параметров переменной среды для StartTask.
maxTaskRetryCount	integer (int32)	Максимальное количество повторных попыток задачи. Пакетная служба повторяет задачу, если его код выхода не является ненулевой. Обратите внимание, что это значение специально управляет числом повторных попыток. Пакетная служба попытается выполнить задачу один раз, а затем повторите попытку до этого ограничения. Например, если максимальное число повторных попыток равно 3, пакет пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторные попытки). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачу. Если максимальное число повторных попыток равно -1, пакетная служба повторяет задачу без ограничения, однако это не рекомендуется для начальной задачи или любой задачи. Значение по умолчанию равно 0 (без повторных попыток).
resourceFiles	ResourceFile[]	Список файлов, которые служба пакетной службы скачивает на вычислительный узел перед выполнением командной строки. Существует максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой, и код ошибки ответа будет RequestEntityTooLarge. В этом случае коллекция ResourceFiles должна быть уменьшена. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker. Файлы, перечисленные в этом элементе, находятся в рабочем каталоге задачи.
userIdentity	UserIdentity	Идентификатор пользователя, под которым работает StartTask. Если задача опущена, она выполняется как неадминистративный пользователь, уникальный для задачи.
waitForSuccess	boolean	Следует ли пакетной службе ждать успешного завершения startTask (т. е. выйти с кодом выхода 0) перед планированием любых задач на вычислительном узле. Если значение true и startTask завершается сбоем на узле, пакетная служба повторяет запускTask до максимального количества повторных попыток (maxTaskRetryCount). Если задача по-прежнему не выполнена успешно после всех повторных попыток, служба пакетной службы помечает узел неиспользуемой и не будет планировать задачи. Это условие можно обнаружить с помощью сведений о состоянии вычислительного узла и сведения о сбоях. Если значение false, служба пакетной службы не будет ожидать завершения запускаTask. В этом случае другие задачи могут запускаться на вычислительном узле во время запуска StartTask; и даже если сбой StartTask, новые задачи будут продолжать планироваться на вычислительном узле. Значение по умолчанию — true.

BatchTaskContainerSettings

Объект

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

Имя	Тип	Описание
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	Пути, которые необходимо подключить к задаче контейнера. Если этот массив имеет значение NULL или отсутствует, задача контейнера будет подключать весь временный диск диска в окнах (или AZ_BATCH_NODE_ROOT_DIR в Linux). Он не будет подключать пути к данным в контейнер, если этот массив задан как пустой.
containerRunOptions	string	Дополнительные параметры команды создания контейнера. Эти дополнительные параметры предоставляются в качестве аргументов в команду docker create, а также те, которые управляются пакетной службой.
imageName	string	Изображение для создания контейнера, в котором будет выполняться задача. Это полная ссылка на изображение, как было бы указано в «docker pull». Если в названии изображения нет тега, по умолчанию используется тег «:latest».
registry	ContainerRegistryReference	Частный реестр, содержащий контейнер Image. Эта настройка может быть опущена, если она уже была предоставлена при создании пула.
workingDirectory	ContainerWorkingDirectory	Расположение рабочего каталога задач контейнера. Значение по умолчанию — taskWorkingDirectory.

ContainerHostBatchBindMountEntry

Объект

Вход пути и режима подключения, который требуется подключить к контейнеру задач.

Имя	Тип	Описание
isReadOnly	boolean	Подключите этот исходный путь как режим только для чтения или нет. Значение по умолчанию равно false (режим чтения и записи). Если вы подключаете этот путь как режим чтения и записи, это не означает, что у всех пользователей в контейнере есть доступ на чтение и запись для пути, он зависит от доступа на виртуальной машине узла. Если этот путь подключен только для чтения, все пользователи в контейнере не смогут изменить путь.
source	ContainerHostDataPath	Путь, подключенный к клиенту контейнера, можно выбрать.

ContainerHostDataPath

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

Пути, которые будут подключены к контейнеру задачи контейнера.

Значение	Описание
Shared	Путь к задаче с несколькими экземплярами для совместного использования файлов.
Startup	Путь к задаче запуска.
VfsMounts	Путь содержит все виртуальные файловые системы, подключенные на этом узле.
Task	Путь к задаче.
JobPrep	Путь задачи подготовки задания.
Applications	Путь к приложениям.

ContainerRegistryReference

Объект

Частный реестр контейнеров.

Имя	Тип	Описание
identityReference	BatchNodeIdentityReference	Ссылка на назначенное пользователем удостоверение для доступа к реестру контейнеров Azure вместо имени пользователя и пароля.
password	string (password)	Пароль для входа на сервер реестра.
registryServer	string (uri)	URL-адрес реестра. Если опущено, значение по умолчанию — "docker.io".
username	string	Имя пользователя для входа на сервер реестра.

ContainerWorkingDirectory

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

ContainerWorkingDirectory enums

Значение	Описание
taskWorkingDirectory	Используйте стандартную рабочую директорию задачи пакетного сервиса, которая будет содержать файлы ресурсов задач, заполненные batch.
containerImageDefault	Используйте рабочую директорию, определённую в контейнере Image. Обратите внимание, что эта папка не будет содержать файлы ресурсов, загруженные Batch.

ElevationLevel

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

Enums ElevationLevel

Значение	Описание
nonadmin	Пользователь является стандартным пользователем без повышенного доступа.
admin	Пользователь является пользователем с повышенными правами доступа и работает с полными разрешениями администратора.

EnvironmentSetting

Объект

Переменная среды, устанавливаемая в процессе задачи.

Имя	Тип	Описание
name	string	Имя переменной среды.
value	string	Значение переменной среды.

ResourceFile

Объект

Один файл или несколько файлов, которые нужно скачать на вычислительный узел.

Имя	Тип	Описание
autoStorageContainerName	string	Название контейнера хранения в учетной записи автохранилища. Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан.
blobPrefix	string	Префикс большого двоичного объекта, используемый при скачивании BLOB-объектов из контейнера службы хранилища Azure. Будут загружены только большие двоичные объекты, имена которых начинаются с указанного префикса. Свойство допустимо, только если используется autoStorageContainerName или storageContainerUrl. Этот префикс может быть частичным именем файла или подкаталогом. Если префикс не указан, все файлы в контейнере будут скачаны.
fileMode	string	Атрибут режима разрешений файла в восьмимерном формате. Это свойство применяется только к файлам, загружаемым в вычислительные узлы Linux. Он будет игнорирован, если он указан для resourceFile, который будет загружен на вычислительный узел Windows. Если это свойство не указано для вычислительного узла Linux, то к файлу применяется значение по умолчанию 0770.
filePath	string	Местоположение на Вычислительном узле, куда можно скачать файл(ы), относительно рабочей директории задачи. Если задано свойство httpUrl, файлPath является обязательным и описывает путь, в который будет скачан файл, включая имя файла. В противном случае, если задано свойство autoStorageContainerName или storageContainerUrl, filePath является необязательным и является каталогом для скачивания файлов. В случае, когда filePath используется в качестве каталога, любая структура каталогов, уже связанная с входными данными, будет сохранена в полном объеме и добавлена в указанный каталог filePath. Указанный относительный путь не может выйти из рабочего каталога задачи (например, используя '..').
httpUrl	string (uri)	URL-адрес скачиваемого файла. Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан. Если URL-адрес указывает на хранилище BLOB-объектов Azure, он должен быть доступен для чтения с вычислительных узлов. Существует три способа получить такой URL-адрес для большого двоичного объекта в хранилище Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение большого двоичного объекта, использовать управляемое удостоверение с разрешением на чтение или задать ACL для большого двоичного объекта или его контейнера, чтобы разрешить общедоступный доступ.
identityReference	BatchNodeIdentityReference	Ссылка на идентификатор, назначенную пользователю для доступа к Azure Blob Storage, указанную в storageContainerUrl или httpUrl.
storageContainerUrl	string (uri)	URL-адрес контейнера BLOB-объектов в хранилище BLOB-объектов Azure. Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан. Этот URL-адрес должен быть доступен для чтения и перечисления из вычислительных узлов. Существует три способа получить такой URL-адрес для контейнера в хранилище Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение и список для контейнера, использовать управляемое удостоверение с разрешениями на чтение и список или задать ACL для контейнера, чтобы разрешить общедоступный доступ.

UserIdentity

Объект

Определение удостоверения пользователя, в котором выполняется задача. Укажите свойство userName или autoUser, но не оба.

Имя	Тип	Описание
autoUser	AutoUserSpecification	Автоматический пользователь, под которым выполняется задача. Свойства userName и autoUser являются взаимоисключающими; необходимо указать один, но не оба.
username	string	Название идентификатора пользователя, под которым выполняется задача. Свойства userName и autoUser являются взаимоисключающими; необходимо указать один, но не оба.