Pool - Update Properties
Обновляет свойства указанного пула.
Это полностью заменяет все обновляемые свойства пула. Например, если с пулом связана начальнаяtask, а если с этим запросом не указана начальнаяtask, служба пакетной службы удаляет существующий StartTask.
POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2024-07-01.20.0
POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2024-07-01.20.0
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
batch
|
path | True |
string |
Базовый URL-адрес для всех запросов пакетной службы Azure. |
pool
|
path | True |
string |
Идентификатор пула для обновления. |
api-version
|
query | True |
string |
Версия КЛИЕНТСКОго API. |
timeout
|
query |
integer int32 |
Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение больше 30, вместо этого будет использоваться значение по умолчанию. |
Заголовок запроса
Media Types: "application/json; odata=minimalmetadata"
Имя | Обязательно | Тип | Описание |
---|---|---|---|
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 напрямую. |
Текст запроса
Media Types: "application/json; odata=minimalmetadata"
Имя | Обязательно | Тип | Описание |
---|---|---|---|
applicationPackageReferences | True |
Список пакетов приложений, установленных на каждом вычислительном узле в пуле. |
|
certificateReferences | True |
Список сертификатов, которые необходимо установить на каждом вычислительном узле в пуле. Предупреждение. Это свойство устарело и будет удалено после февраля 2024 года. Вместо этого используйте расширения Azure KeyVault |
|
metadata | True |
Список пар "имя-значение", связанных с пулом в качестве метаданных. |
|
startTask |
Задача, выполняемая на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла. |
||
targetNodeCommunicationMode |
Требуемый режим связи узла для пула. |
Ответы
Имя | Тип | Описание |
---|---|---|
204 No Content |
Запрос к пакетной службе выполнен успешно. Заголовки
|
|
Other Status Codes |
Ошибка из пакетной службы. |
Безопасность
azure_auth
Поток кода проверки подлинности Microsoft Entra OAuth 2.0
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | Олицетворения учетной записи пользователя |
Authorization
Тип:
apiKey
В:
header
Примеры
Pool update
Образец запроса
POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2024-07-01.20.0
{
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'"
},
"certificateReferences": [],
"applicationPackageReferences": [],
"metadata": []
}
Пример ответа
Определения
Имя | Описание |
---|---|
Application |
Ссылка на пакет для развертывания на вычислительных узлах. |
Auto |
Область для автоматического пользователя |
Auto |
Задает параметры для автоматического пользователя, выполняющего задачу в пакетной службе. |
Batch |
Ответ об ошибке, полученный из пакетной службы Azure. |
Batch |
Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure. |
Certificate |
Ссылка на сертификат, который необходимо установить на вычислительных узлах в пуле. |
Certificate |
Расположение хранилища сертификатов на вычислительном узле, в который необходимо установить сертификат. |
Certificate |
Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата. |
Compute |
Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел. |
Container |
Вход пути и режима подключения, который требуется подключить к контейнеру задач. |
Container |
Пути, которые будут подключены к контейнеру задачи контейнера. |
Container |
Частный реестр контейнеров. |
Container |
Расположение рабочего каталога задачи контейнера. |
Elevation |
Уровень повышения прав пользователя. |
Environment |
Переменная среды, устанавливаемая в процессе задачи. |
Error |
Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure. |
Metadata |
Пара "имя-значение", связанная с ресурсом пакетной службы. |
Node |
Определяет, как пул взаимодействует со службой пакетной службы. |
Pool |
Набор изменений, внесенных в пул. |
Resource |
Один файл или несколько файлов, которые нужно скачать на вычислительный узел. |
Start |
Задача, которая выполняется при присоединении узла к пулу в пакетной службе Azure или при перезагрузке или повторном переимыке вычислительного узла. |
Task |
Параметры контейнера для задачи. |
User |
Определение удостоверения пользователя, в котором выполняется задача. |
ApplicationPackageReference
Ссылка на пакет для развертывания на вычислительных узлах.
Имя | Тип | Описание |
---|---|---|
applicationId |
string |
Идентификатор развертываемого приложения. |
version |
string |
Версия приложения для развертывания. Если опущено, будет развернута версия по умолчанию. |
AutoUserScope
Область для автоматического пользователя
Имя | Тип | Описание |
---|---|---|
pool |
string |
Указывает, что задача выполняется в качестве общей учетной записи автоматического пользователя, созданной на каждом вычислительном узле в пуле. |
task |
string |
Указывает, что служба должна создать нового пользователя для задачи. |
AutoUserSpecification
Задает параметры для автоматического пользователя, выполняющего задачу в пакетной службе.
Имя | Тип | Описание |
---|---|---|
elevationLevel |
Уровень повышения прав автоматического пользователя. |
|
scope |
Область для автоматического пользователя |
BatchError
Ответ об ошибке, полученный из пакетной службы Azure.
Имя | Тип | Описание |
---|---|---|
code |
string |
Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования. |
message |
Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе. |
|
values |
Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке. |
BatchErrorDetail
Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
Имя | Тип | Описание |
---|---|---|
key |
string |
Идентификатор, указывающий значение свойства Value. |
value |
string |
Дополнительные сведения, включенные в ответ на ошибку. |
CertificateReference
Ссылка на сертификат, который необходимо установить на вычислительных узлах в пуле.
Имя | Тип | Описание |
---|---|---|
storeLocation |
Расположение хранилища сертификатов на вычислительном узле, в который необходимо установить сертификат. |
|
storeName |
string |
Имя хранилища сертификатов на вычислительном узле, в который необходимо установить сертификат. |
thumbprint |
string |
Отпечаток сертификата. |
thumbprintAlgorithm |
string |
Алгоритм, с которым связан отпечаток. Это должно быть sha1. |
visibility |
Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата. |
CertificateStoreLocation
Расположение хранилища сертификатов на вычислительном узле, в который необходимо установить сертификат.
Имя | Тип | Описание |
---|---|---|
currentuser |
string |
Сертификаты должны быть установлены в хранилище сертификатов CurrentUser. |
localmachine |
string |
Сертификаты должны быть установлены в хранилище сертификатов LocalMachine. |
CertificateVisibility
Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата.
Имя | Тип | Описание |
---|---|---|
remoteuser |
string |
Сертификат должен отображаться для учетных записей пользователей, в которых пользователи удаленно обращаются к вычислительному узлу. |
starttask |
string |
Сертификат должен быть видимым для учетной записи пользователя, в которой выполняется StartTask. Обратите внимание, что если область autoUser является пулом как для startTask, так и для задачи, этот сертификат также будет виден задаче. |
task |
string |
Сертификат должен быть видимым для учетных записей пользователей, в которых выполняются задачи задания. |
ComputeNodeIdentityReference
Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
Имя | Тип | Описание |
---|---|---|
resourceId |
string |
Идентификатор ресурса ARM назначенного пользователем удостоверения. |
ContainerHostBatchBindMountEntry
Вход пути и режима подключения, который требуется подключить к контейнеру задач.
Имя | Тип | Описание |
---|---|---|
isReadOnly |
boolean |
Подключите этот исходный путь как режим только для чтения или нет. Значение по умолчанию равно false (режим чтения и записи). |
source |
Путь, подключенный к клиенту контейнера, можно выбрать. |
ContainerHostDataPath
Пути, которые будут подключены к контейнеру задачи контейнера.
Имя | Тип | Описание |
---|---|---|
Applications |
string |
Путь к приложениям. |
JobPrep |
string |
Путь задачи подготовки задания. |
Shared |
string |
Путь к задаче с несколькими экземплярами для совместного использования файлов. |
Startup |
string |
Путь к задаче запуска. |
Task |
string |
Путь к задаче. |
VfsMounts |
string |
Путь содержит все виртуальные файловые системы, подключенные на этом узле. |
ContainerRegistry
Частный реестр контейнеров.
Имя | Тип | Описание |
---|---|---|
identityReference |
Ссылка на назначенное пользователем удостоверение для доступа к реестру контейнеров Azure вместо имени пользователя и пароля. |
|
password |
string |
Пароль для входа на сервер реестра. |
registryServer |
string |
URL-адрес реестра. |
username |
string |
Имя пользователя для входа на сервер реестра. |
ContainerWorkingDirectory
Расположение рабочего каталога задачи контейнера.
Имя | Тип | Описание |
---|---|---|
containerImageDefault |
string |
Используйте рабочий каталог, определенный в образе контейнера. Убедитесь, что этот каталог не будет содержать файлы ресурсов, скачанные пакетной службой. |
taskWorkingDirectory |
string |
Используйте стандартный рабочий каталог задачи пакетной службы, который будет содержать файлы ресурсов задач, заполненные пакетной службой. |
ElevationLevel
Уровень повышения прав пользователя.
Имя | Тип | Описание |
---|---|---|
admin |
string |
Пользователь является пользователем с повышенными правами доступа и работает с полными разрешениями администратора. |
nonadmin |
string |
Пользователь является стандартным пользователем без повышенного доступа. |
EnvironmentSetting
Переменная среды, устанавливаемая в процессе задачи.
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя переменной среды. |
value |
string |
Значение переменной среды. |
ErrorMessage
Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
Имя | Тип | Описание |
---|---|---|
lang |
string |
Языковой код сообщения об ошибке |
value |
string |
Текст сообщения. |
MetadataItem
Пара "имя-значение", связанная с ресурсом пакетной службы.
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя элемента метаданных. |
value |
string |
Значение элемента метаданных. |
NodeCommunicationMode
Определяет, как пул взаимодействует со службой пакетной службы.
Имя | Тип | Описание |
---|---|---|
classic |
string |
Для узлов, использующих классический режим связи, требуется входящий TCP-обмен данными через порты 29876 и 29877 из пакета BatchNodeManagement. Тег службы {region}" и исходящий TCP-обмен данными через порт 443 в хранилище.регион и BatchNodeManagement. Теги службы {region}". |
default |
string |
Режим связи узла автоматически устанавливается пакетной службой. |
simplified |
string |
Узлы, использующие упрощенный режим связи, требуют исходящего TCP-подключения через порт 443 к пакетной службе BatchNodeManagement. Тег службы {region}". Открытые входящие порты не требуются. |
PoolUpdatePropertiesParameter
Набор изменений, внесенных в пул.
Имя | Тип | Описание |
---|---|---|
applicationPackageReferences |
Список пакетов приложений, установленных на каждом вычислительном узле в пуле. |
|
certificateReferences |
Список сертификатов, которые необходимо установить на каждом вычислительном узле в пуле. Предупреждение. Это свойство устарело и будет удалено после февраля 2024 года. Вместо этого используйте расширения Azure KeyVault |
|
metadata |
Список пар "имя-значение", связанных с пулом в качестве метаданных. |
|
startTask |
Задача, выполняемая на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла. |
|
targetNodeCommunicationMode |
Требуемый режим связи узла для пула. |
ResourceFile
Один файл или несколько файлов, которые нужно скачать на вычислительный узел.
Имя | Тип | Описание |
---|---|---|
autoStorageContainerName |
string |
Имя контейнера хранилища в учетной записи автоматического хранения. |
blobPrefix |
string |
Префикс большого двоичного объекта, используемый при скачивании BLOB-объектов из контейнера службы хранилища Azure. Будут загружены только большие двоичные объекты, имена которых начинаются с указанного префикса. |
fileMode |
string |
Атрибут режима разрешений файла в восьмимерном формате. |
filePath |
string |
Расположение на вычислительном узле, на который следует скачать файлы, относительно рабочего каталога задачи. |
httpUrl |
string |
URL-адрес скачиваемого файла. |
identityReference |
Ссылка на назначенное пользователем удостоверение для доступа к хранилищу BLOB-объектов Azure, заданному storageContainerUrl или httpUrl |
|
storageContainerUrl |
string |
URL-адрес контейнера BLOB-объектов в хранилище BLOB-объектов Azure. |
StartTask
Задача, которая выполняется при присоединении узла к пулу в пакетной службе Azure или при перезагрузке или повторном переимыке вычислительного узла.
Имя | Тип | Описание |
---|---|---|
commandLine |
string |
Командная строка StartTask. |
containerSettings |
Параметры контейнера, в котором выполняется StartTask. |
|
environmentSettings |
Список параметров переменной среды для StartTask. |
|
maxTaskRetryCount |
integer |
Максимальное количество повторных попыток задачи. |
resourceFiles |
Список файлов, которые служба пакетной службы скачивает на вычислительный узел перед выполнением командной строки. Существует максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой, и код ошибки ответа будет RequestEntityTooLarge. В этом случае коллекция ResourceFiles должна быть уменьшена. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker. |
|
userIdentity |
Удостоверение пользователя, под которым запускается StartTask. |
|
waitForSuccess |
boolean |
Следует ли пакетной службе ждать успешного завершения startTask (т. е. выйти с кодом выхода 0) перед планированием любых задач на вычислительном узле. |
TaskContainerSettings
Параметры контейнера для задачи.
Имя | Тип | Описание |
---|---|---|
containerHostBatchBindMounts |
Пути, которые необходимо подключить к задаче контейнера. |
|
containerRunOptions |
string |
Дополнительные параметры команды создания контейнера. |
imageName |
string |
Образ, используемый для создания контейнера, в котором будет выполняться задача. |
registry |
Частный реестр, содержащий образ контейнера. |
|
workingDirectory |
Расположение рабочего каталога задачи контейнера. |
UserIdentity
Определение удостоверения пользователя, в котором выполняется задача.
Имя | Тип | Описание |
---|---|---|
autoUser |
Автоматический пользователь, под которым выполняется задача. |
|
username |
string |
Имя удостоверения пользователя, в котором выполняется задача. |