Pool - Update Properties
Обновления свойства указанного пула.
Это полностью заменяет все обновляемые свойства пула. Например, если с пулом связан параметр StartTask, а параметр StartTask не указан в этом запросе, то пакетная служба удалит существующий элемент StartTask.
POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2023-11-01.18.0
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
batch
|
path | True |
string |
Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure. |
pool
|
path | True |
string |
Идентификатор обновляемого пула. |
api-version
|
query | True |
string |
Версия API клиента. |
timeout
|
query |
integer int32 |
Максимальное время, которое сервер может потратить на обработку запроса, в секундах. По умолчанию это 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 |
Запрос к пакетной службе выполнен успешно. Headers
|
|
Other Status Codes |
Ошибка пакетной службы. |
Безопасность
azure_auth
Microsoft Entra поток кода проверки подлинности OAuth 2.0
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
user_impersonation | Олицетворение учетной записи пользователя |
Authorization
Type:
apiKey
In:
header
Примеры
Pool update
Sample Request
POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2023-11-01.18.0
{
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'"
},
"certificateReferences": [],
"applicationPackageReferences": [],
"metadata": []
}
Sample Response
Определения
Имя | Описание |
---|---|
Application |
Ссылка на пакет, развертываемый на вычислительных узлах. |
Auto |
область для автоматического пользователя |
Auto |
Задает параметры для автоматического пользователя, который запускает задачу в пакетной службе. |
Batch |
Ответ об ошибке, полученный от службы пакетная служба Azure. |
Batch |
Элемент с дополнительными сведениями, включенными в ответ на ошибку пакетная служба Azure. |
Certificate |
Ссылка на сертификат, устанавливаемый на вычислительных узлах в пуле. |
Certificate |
Расположение хранилища сертификатов на вычислительном узле, в котором устанавливается сертификат. |
Certificate |
Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата. |
Compute |
Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, которое будет использоваться вычислительным узлом. |
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. Обратите внимание, что если областью автопользования является пул для startTask и задачи, этот сертификат также будет отображаться для задачи. |
task |
string |
Сертификат должен быть виден учетным записям пользователей, под которыми выполняются задачи заданий. |
ComputeNodeIdentityReference
Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, которое будет использоваться вычислительным узлом.
Имя | Тип | Описание |
---|---|---|
resourceId |
string |
Идентификатор ресурса ARM для удостоверения, назначаемого пользователем. |
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 с storage.region и BatchNodeManagement. Теги службы {регион}". |
default |
string |
Режим связи с узлом автоматически задается пакетной службой. |
simplified |
string |
Узлам, использующим упрощенный режим связи, требуется исходящий TCP-обмен данными через порт 443 с BatchNodeManagement. Тег службы {регион}. Открытые входящие порты не требуются. |
PoolUpdatePropertiesParameter
Набор изменений, которые необходимо вносить в пул.
Имя | Тип | Описание |
---|---|---|
applicationPackageReferences |
Список пакетов приложений, устанавливаемых на каждом вычислительном узле в пуле. |
|
certificateReferences |
Список сертификатов, устанавливаемых на каждом вычислительном узле в пуле. Предупреждение. Это свойство устарело и будет удалено после февраля 2024 г. Вместо этого используйте расширение Azure KeyVault . |
|
metadata |
Список пар "имя-значение", связанных с пулом в качестве метаданных. |
|
startTask |
Задача, выполняемая на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла. |
|
targetNodeCommunicationMode |
Требуемый режим связи узла для пула. |
ResourceFile
Один файл или несколько файлов для загрузки на вычислительный узел.
Имя | Тип | Описание |
---|---|---|
autoStorageContainerName |
string |
Имя контейнера хранилища в учетной записи автоматического хранения. |
blobPrefix |
string |
Префикс большого двоичного объекта, используемый при скачивании больших двоичных объектов из контейнера службы хранилища Azure. Будут загружены только большие двоичные объекты, имена которых начинаются с указанного префикса. |
fileMode |
string |
Атрибут режима разрешений для файлов в восьмеричном формате. |
filePath |
string |
Расположение на вычислительном узле, в который нужно скачать файлы, относительно рабочего каталога задачи. |
httpUrl |
string |
URL-адрес для скачивания файла. |
identityReference |
Ссылка на назначенное пользователем удостоверение для доступа к Хранилище BLOB-объектов Azure, указанное storageContainerUrl или httpUrl. |
|
storageContainerUrl |
string |
URL-адрес контейнера больших двоичных объектов в Хранилище 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
Параметры контейнера для задачи.
Имя | Тип | Описание |
---|---|---|
containerRunOptions |
string |
Дополнительные параметры команды создания контейнера. |
imageName |
string |
Образ, используемый для создания контейнера, в котором будет выполняться задача. |
registry |
Частный реестр, содержащий образ контейнера. |
|
workingDirectory |
Расположение рабочего каталога задачи контейнера. |
UserIdentity
Определение удостоверения пользователя, с которым выполняется задача.
Имя | Тип | Описание |
---|---|---|
autoUser |
Автоматический пользователь, под которым выполняется задача. |
|
username |
string |
Имя удостоверения пользователя, с которым выполняется задача. |