Nodes - List Nodes

Служба:: Batch Service

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

Перечисляет вычислительные узлы в указанном пуле.

GET {endpoint}/pools/{poolId}/nodes?api-version=2025-06-01

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

GET {endpoint}/pools/{poolId}/nodes?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$filter={$filter}&$select={$select}

Параметры 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, используемая для данной операции.
$filter	query		string	Предложение OData $filter. Для получения дополнительной информации о построении этого фильтра см. https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.
$select	query		string[]	Предложение OData $select.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Максимальное количество элементов, возвращаемых в ответе. Максимум может быть возвращено 1000 заявок.
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 напрямую.

Ответы

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

Имя

Тип

Описание

200 OK

BatchNodeListResult

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

Заголовки

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

Примеры

Node list

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

HTTP

GET {endpoint}/pools/poolId/nodes?api-version=2025-06-01

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

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

{
  "value": [
    {
      "id": "tvm-1695681911_1-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2025-11-22T22:22:27.2236818Z",
      "lastBootTime": "2025-11-22T22:22:24.4634125Z",
      "allocationTime": "2025-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "ipv6Address": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_1-20161122t193202z",
      "vmSize": "Standard_D2_v5",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "virtualMachineInfo": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest",
          "exactVersion": "latest"
        }
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2025-11-22T22:22:27.2236818Z",
        "endTime": "2025-11-22T22:22:27.567189Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2025-11-22T22:22:24.4634125Z"
      }
    },
    {
      "id": "tvm-1695681911_2-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2025-11-22T19:37:31.4285526Z",
      "lastBootTime": "2025-11-22T19:37:28.623369Z",
      "allocationTime": "2025-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "ipv6Address": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
      "vmSize": "Standard_D2_v5",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "virtualMachineInfo": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest",
          "exactVersion": "latest"
        }
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2025-11-22T19:37:31.4285526Z",
        "endTime": "2025-11-22T19:37:31.838028Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2025-11-22T22:22:24.4634125Z"
      }
    },
    {
      "id": "tvm-1695681911_3-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2025-11-22T19:36:51.0013378Z",
      "lastBootTime": "2025-11-22T19:36:48.21721Z",
      "allocationTime": "2025-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "ipv6Address": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_3-20161122t193202z",
      "vmSize": "Standard_D2_v5",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "virtualMachineInfo": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest",
          "exactVersion": "latest"
        }
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2025-11-22T19:36:51.0013378Z",
        "endTime": "2025-11-22T19:36:51.2363447Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2025-11-22T22:22:24.4634125Z"
      }
    }
  ]
}

Определения

Имя	Описание
AutoUserScope	AutoUserScope enums
AutoUserSpecification	Указывает параметры автоматического пользователя, выполняющего задачу пакетной службы Azure.
BatchError	Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
BatchErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
BatchErrorSourceCategory	Enums BatchErrorSourceCategory
BatchNode	Вычислительный узел в пакетной службе.
BatchNodeAgentInfo	Агент пакетного вычислительного узла — это программа, которая выполняется на каждом вычислительном узле в пуле и предоставляет пакетную возможность на вычислительном узле.
BatchNodeEndpointConfiguration	Конфигурация конечной точки для вычислительного узла.
BatchNodeError	Ошибка, обнаруженная вычислительным узлом.
BatchNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
BatchNodeListResult	Результат перечисления вычислительных узлов в пуле.
BatchNodeState	Enums BatchNodeState
BatchStartTask	Пакетная служба будет повторять задачи при активации операции восстановления на узле. Примеры операций восстановления включают (но не ограничиваются) при перезагрузке неработоспособного узла или вычислительном узле исчезли из-за сбоя узла. Повторные попытки из-за операций восстановления не учитываются и не учитываются для maxTaskRetryCount. Даже если значение maxTaskRetryCount равно 0, может произойти внутренняя повторная попытка из-за операции восстановления. Из-за этого все задачи должны быть идемпотентными. Это означает, что задачи должны терпеть прерывание и перезапуск без повреждения или дублирования данных. Рекомендуется использовать определенную форму контрольных точек для длительных задач. В некоторых случаях запуск StartTask может выполняться повторно, даже если вычислительный узел не был перезагружен. Следует учесть, чтобы избежать запуска StartTasks, создающих отсортовый процесс или установку или запуск служб из рабочего каталога StartTask, так как это приведет к тому, что пакетная служба сможет повторно запустить StartTask.
BatchStartTaskInfo	Сведения о запуске StartTask, работающем на вычислительном узле.
BatchStartTaskState	BatchStartTaskState enums
BatchTaskContainerExecutionInfo	Содержит сведения о контейнере, который выполняет задача.
BatchTaskContainerSettings	Параметры контейнера для задачи.
BatchTaskExecutionInfo	Сведения о выполнении задачи.
BatchTaskExecutionResult	BatchTaskExecutionResult enums
BatchTaskFailureInfo	Сведения о сбое задачи.
BatchTaskInfo	Сведения о задаче, выполняемой на вычислительном узле.
BatchTaskState	Enums BatchTaskState
BatchVmImageReference	Ссылка на образ Azure Virtual Machines Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех ссылок на образы Azure Marketplace, проверенных пакетной службой Azure, см. операцию "Список поддерживаемых образов".
ContainerHostBatchBindMountEntry	Вход пути и режима подключения, который требуется подключить к контейнеру задач.
ContainerHostDataPath	Пути, которые будут подключены к контейнеру задачи контейнера.
ContainerRegistryReference	Частный реестр контейнеров.
ContainerWorkingDirectory	ContainerWorkingDirectory enums
ElevationLevel	Enums ElevationLevel
EnvironmentSetting	Переменная среды, устанавливаемая в процессе задачи.
InboundEndpoint	Конечная точка входящего трафика на вычислительном узле.
InboundEndpointProtocol	Enums InboundEndpointProtocol
NameValuePair	Представляет пару "имя-значение".
ResourceFile	Один файл или несколько файлов, которые нужно скачать на вычислительный узел.
SchedulingState	Enums SchedulingState
UserIdentity	Определение удостоверения пользователя, в котором выполняется задача. Укажите свойство userName или autoUser, но не оба.
VirtualMachineInfo	Сведения о текущем состоянии виртуальной машины.

AutoUserScope

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

AutoUserScope enums

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

AutoUserSpecification

Объект

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

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

BatchError

Объект

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

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

BatchErrorDetail

Объект

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

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

BatchErrorMessage

Объект

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

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

BatchErrorSourceCategory

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

Enums BatchErrorSourceCategory

Значение	Описание
usererror	Ошибка возникла из-за пользовательской проблемы, например, неправильной настройки.
servererror	Ошибка связана с внутренней проблемой сервера.

BatchNode

Объект

Вычислительный узел в пакетной службе.

Имя	Тип	Описание
affinityId	string	Идентификатор, который можно передать при добавлении задачи для запроса на выполнение задачи на этом вычислительном узле. Обратите внимание, что это просто мягкое сходство. Если целевой вычислительный узел занят или недоступен во время планирования задачи, задача будет запланирована в другом месте.
allocationTime	string (date-time)	Время, в течение которого этот вычислительный узел был выделен пулу. Это время, когда вычислительный узел изначально был выделен и не изменяется после установки. Он не обновляется, если вычислительный узел является службой, исцеляемой или предварительной.
endpointConfiguration	BatchNodeEndpointConfiguration	Конфигурация конечной точки для вычислительного узла.
errors	BatchNodeError[]	Список ошибок, с которыми в настоящее время сталкивается вычислительный узел.
id	string	Идентификатор вычислительного узла. Каждому вычислительному узлу, добавляемого в пул, присваивается уникальный идентификатор. Когда вычислительный узел удаляется из пула, удаляются все локальные файлы, а идентификатор повторно используется для новых вычислительных узлов.
ipAddress	string	IP-адрес, который другие узлы могут использовать для взаимодействия с этим вычислительным узлом. Каждый вычислительный узел, добавленный в пул, назначается уникальный IP-адрес. Когда вычислительный узел удаляется из пула, удаляются все локальные файлы, а IP-адрес повторно используется для новых вычислительных узлов.
ipv6Address	string	IPv6-адрес, который другие узлы могут использовать для связи с этим вычислительным узлом. Каждый вычислительный узел, добавленный в пул, назначается уникальный IP-адрес. Когда вычислительный узел удаляется из пула, удаляются все локальные файлы, а IP-адрес повторно используется для новых вычислительных узлов. Это свойство не будет присутствовать, если пул не настроен для IPv6.
isDedicated	boolean	Указывает, является ли этот вычислительный узел выделенным вычислительным узлом. Если значение false, вычислительный узел является точечным или низкоприоритетным вычислительным узлом.
lastBootTime	string (date-time)	Последний раз, когда был запущен вычислительный узел. Это свойство может не присутствовать, если состояние вычислительного узла недоступно.
nodeAgentInfo	BatchNodeAgentInfo	Сведения о версии агента вычислительного узла и времени обновления вычислительного узла до новой версии.
recentTasks	BatchTaskInfo[]	Список задач, состояние которого недавно изменилось. Это свойство присутствует только в том случае, если на этом вычислительном узле выполняется по крайней мере одна задача, так как она была назначена пулу.
runningTaskSlotsCount	integer (int32)	Общее количество слотов планирования, используемых в настоящее время выполнением задач задания на вычислительном узле. К ним относятся задачи диспетчера заданий и обычные задачи, но не подготовка заданий, выпуск задания или запуск задач.
runningTasksCount	integer (int32)	Общее число текущих задач задания на вычислительном узле. К ним относятся задачи диспетчера заданий и обычные задачи, но не подготовка заданий, выпуск задания или запуск задач.
schedulingState	SchedulingState	Доступен ли вычислительный узел для планирования задач.
startTask	BatchStartTask	Задача, указанная для запуска на вычислительном узле, при присоединении к пулу.
startTaskInfo	BatchStartTaskInfo	Сведения о выполнении StartTask на вычислительном узле.
state	BatchNodeState	Текущее состояние вычислительного узла.
stateTransitionTime	string (date-time)	Время ввода текущего состояния вычислительного узла.
totalTasksRun	integer (int32)	Общее количество задач задания, завершенных на вычислительном узле. К ним относятся задачи диспетчера заданий и обычные задачи, но не подготовка заданий, выпуск задания или запуск задач.
totalTasksSucceeded	integer (int32)	Общее количество задач заданий, успешно завершенных (с выходом 0) на вычислительном узле. К ним относятся задачи диспетчера заданий и обычные задачи, но не подготовка заданий, выпуск задания или запуск задач.
url	string (uri)	URL-адрес вычислительного узла.
virtualMachineInfo	VirtualMachineInfo	Сведения о текущем состоянии виртуальной машины.
vmSize	string	Размер виртуальной машины, на котором размещен вычислительный узел. Сведения о доступных размерах виртуальных машин в пулах см. в статье Выбор размера виртуальной машины для вычислительных узлов в пуле пакетной службы Azure (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).

BatchNodeAgentInfo

Объект

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

Имя	Тип	Описание
lastUpdateTime	string (date-time)	Время, когда агент Compute Node был обновлён на Compute Node. Это последний случай, когда агент Compute Node был обновлён до новой версии.
version	string	Версия агента Batch Compute Node, работающего на Compute Node. Этот номер версии можно проверить по примечаниям выпуска агента Compute Node, расположенных по https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.mdадресу .

BatchNodeEndpointConfiguration

Объект

Конфигурация конечной точки для вычислительного узла.

Имя	Тип	Описание
inboundEndpoints	InboundEndpoint[]	Список входящих конечных точек, доступных на вычислительном узле.

BatchNodeError

Объект

Ошибка, обнаруженная вычислительным узлом.

Имя	Тип	Описание
code	string	Идентификатор ошибки Compute Node. Коды являются инвариантными и предназначены для программного использования.
errorDetails	NameValuePair[]	Список дополнительных деталей ошибок, связанных с ошибкой Compute Node.
message	string	Сообщение, описывающее ошибку Compute Node, предназначенное для отображения в пользовательском интерфейсе.

BatchNodeIdentityReference

Объект

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

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

BatchNodeListResult

Объект

Результат перечисления вычислительных узлов в пуле.

Имя	Тип	Описание
odata.nextLink	string (uri)	URL-адрес для получения следующего набора результатов.
value	BatchNode[]	Список вычислительных узлов.

BatchNodeState

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

Enums BatchNodeState

Значение	Описание
idle	Вычислительный узел в данный момент не выполняет задачу.
rebooting	Вычислительный узел перезагружается.
reimaging	Вычислительный узел переизображает.
running	Вычислительный узел выполняет одну или несколько задач (кроме StartTask).
unusable	Вычислительный узел не может использоваться для выполнения задач из-за ошибок.
creating	Пакетный сервис получил базовую виртуальную машину из Azure Compute, но пока не начал присоединяться к пулу.
starting	Пакетный сервис запускается на базовой виртуальной машине.
waitingforstarttask	StartTask начал работу на Compute Node, но режим waitForSuccess установлен, и StartTask ещё не завершен.
starttaskfailed	StartTask не сработал на Compute Node (и исчерпал все повторные попытки), и режим waitForSuccess установлен. Вычислительный узел непригоден для выполнения задач.
unknown	Пакетная служба потеряла связь с вычислительным узлом и не знает его истинного состояния.
leavingpool	Вычислительный узел покидает пул либо потому, что пользователь явно его удалил, либо потому, что пул меняет размер или автоматически уменьшается.
offline	Вычислительный узел в данный момент не выполняет задачу, и планирование новых задач на вычислительный узел отключено.
preempted	Точечный или низкоприоритетный вычислительный узел был предопределен. Задачи, которые выполнялись на вычислительном узле, когда оно было предварительно выполнено, будет перепланировано, когда другой вычислительный узел становится доступным.
upgradingos	Вычислительный узел проходит операцию обновления ОС.
deallocated	Вычислительный узел находится в распределённом положении.
deallocating	Вычислительный узел делает deallocating.

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.

BatchStartTaskInfo

Объект

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

Имя	Тип	Описание
containerInfo	BatchTaskContainerExecutionInfo	Информация о контейнере, в котором выполняется задача. Это свойство задаётся только если задача выполняется в контейнерном контексте.
endTime	string (date-time)	Время, когда StartTask прекратил работу. Это время завершения последнего запуска StartTask, если он завершён (даже если он провалился и повторная попытка ожидается). Этот элемент отсутствует, если StartTask в данный момент выполняется.
exitCode	integer (int32)	Код выхода программы, указанный в командной строке StartTask. Это свойство устанавливается только если StartTask находится в состоянии завершения. В общем, выходной код процесса отражает конкретную конвенцию, реализованную разработчиком приложения для этого процесса. Если вы используете значение выходного кода для принятия решений в коде, убедитесь, что знаете конвенцию выходного кода, применяемую в процессе применения. Однако если пакетная служба завершает StartTask (из-за тайм-аута или завершения пользователя через API), вы можете увидеть код выхода, определённый операционной системой.
failureInfo	BatchTaskFailureInfo	Информация, описывающая сбой задачи, если она есть. Это свойство устанавливается только если задача находится в состоянии завершения и столкнулась с ошибкой.
lastRetryTime	string (date-time)	Последний раз, когда началась повторная попытка Задачи. Этот элемент присутствует только при повторной попытке задачи (то есть retryCount не равен нулю). Если она присутствует, это обычно то же самое, что и startTime, но может отличаться, если задача была перезапущена по причинам, отличным от повторной попытки; например, если Compute Node был перезапущен во время повторной попытки, то startTime обновляется, а lastRetryTime — нет.
result	BatchTaskExecutionResult	Результат выполнения задачи. Если значение «failed», детали отказа можно найти в свойстве failureInfo.
retryCount	integer (int32)	Количество повторных попыток Task сервисом Batch. Ошибки приложений задачи (ненулевой выходной код) повторяются, ошибки предварительной обработки (задача не удаётся выполнить) и ошибки загрузки файлов не повторяются. Пакетный сервис повторяет выполнение задачи до предела, указанного ограничениями.
startTime	string (date-time)	Время запуска StartTask. Это значение сбрасывается каждый раз при перезапуске или повторной попытке Задачи (то есть это последний раз, когда StartTask начал запуск).
state	BatchStartTaskState	Состояние StartTask на вычислительном узле.

BatchStartTaskState

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

BatchStartTaskState enums

Значение	Описание
running	StartTask уже запущен.
completed	StartTask завершился с кодом выхода 0, или StartTask провалился и лимит повторных попыток был достигнут, либо процесс StartTask не был запущен из-за ошибок подготовки задачи (например, сбоя загрузки файла ресурсов).

BatchTaskContainerExecutionInfo

Объект

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

Имя	Тип	Описание
containerId	string	Идентификатор контейнера.
error	string	Подробная информация об ошибках контейнера. Это подробная строка ошибки из сервиса Docker, если она доступна. Он эквивалентен полю ошибки, возвращаемому «docker inspect».
state	string	Состояние контейнера. Это состояние контейнера согласно сервису Docker. Он эквивалентен статусному полю, возвращаемому «docker inspect».

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.

BatchTaskExecutionInfo

Объект

Сведения о выполнении задачи.

Имя	Тип	Описание
containerInfo	BatchTaskContainerExecutionInfo	Информация о контейнере, в котором выполняется задача. Это свойство задаётся только если задача выполняется в контейнерном контексте.
endTime	string (date-time)	Время, когда Задание было завершено. Это свойство задаётся только если задача находится в состоянии Выполнено.
exitCode	integer (int32)	Код выхода программы, указанный в командной строке задачи. Это свойство устанавливается только если задача находится в состоянии выполнения. В общем, выходной код процесса отражает конкретную конвенцию, реализованную разработчиком приложения для этого процесса. Если вы используете значение выходного кода для принятия решений в коде, убедитесь, что знаете конвенцию выходного кода, применяемую в процессе применения. Однако если пакетный сервис завершает задачу (из-за тайм-аута или завершения пользователя через API), вы можете увидеть код выхода, определённый операционной системой.
failureInfo	BatchTaskFailureInfo	Информация, описывающая сбой задачи, если она есть. Это свойство устанавливается только если задача находится в состоянии завершения и столкнулась с ошибкой.
lastRequeueTime	string (date-time)	Самый последний случай, когда задача была повторно поставлена в очередь сервисом пакета в результате запроса пользователя. Это свойство задаётся только тогда, когда requeueCount не равен нулю.
lastRetryTime	string (date-time)	Последний раз, когда началась повторная попытка Задачи. Этот элемент присутствует только при повторной попытке задачи (то есть retryCount не равен нулю). Если она присутствует, это обычно то же самое, что и startTime, но может отличаться, если задача была перезапущена по причинам, отличным от повторной попытки; например, если Compute Node был перезапущен во время повторной попытки, то startTime обновляется, а lastRetryTime — нет.
requeueCount	integer (int32)	Количество раз, когда задача была повторно поставлена в очередь пакетным сервисом в результате пользовательского запроса. Когда пользователь удаляет вычислительные узлы из пула (путём изменения размера/уменьшения пула) или когда задача отключается, пользователь может указать, что выполняемые задачи на вычислительных узлах должны быть повторно поставлены в очередь для выполнения. Этот счёт отслеживает, сколько раз задача была повторно поставлена в очередь по этим причинам.
result	BatchTaskExecutionResult	Результат выполнения задачи. Если значение «failed», детали отказа можно найти в свойстве failureInfo.
retryCount	integer (int32)	Количество повторных попыток Task сервисом Batch. Ошибки приложений задачи (ненулевой выходной код) повторяются, ошибки предварительной обработки (задача не удаётся выполнить) и ошибки загрузки файлов не повторяются. Пакетный сервис повторяет выполнение задачи до предела, указанного ограничениями.
startTime	string (date-time)	Время, когда Задание начало работать. «Запуск» соответствует состоянию выполнения, поэтому если задача указывает файлы ресурсов или пакеты, то время запуска отражает время, когда задача начала их загружать или развёртывать. Если задача была перезапущена или попробована повторно, это самое недавнее начало запуска. Это свойство присутствует только для задач, находящихся в состоянии выполнения или выполнения.

BatchTaskExecutionResult

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

BatchTaskExecutionResult enums

Значение	Описание
success	Задача прошла успешно.
failure	Произошла ошибка во время обработки задачи. Сбой мог произойти до запуска процесса задачи, во время выполнения процесса задачи или после завершения процесса.

BatchTaskFailureInfo

Объект

Сведения о сбое задачи.

Имя	Тип	Описание
category	BatchErrorSourceCategory	Категория ошибки задачи.
code	string	Идентификатор ошибки задачи. Коды являются инвариантными и предназначены для программного использования.
details	NameValuePair[]	Список дополнительных деталей, связанных с ошибкой.
message	string	Сообщение, описывающее ошибку задачи, предназначенное для отображения в пользовательском интерфейсе.

BatchTaskInfo

Объект

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

Имя	Тип	Описание
executionInfo	BatchTaskExecutionInfo	Информация о выполнении задачи.
jobId	string	ID работы, к которой относится Задача.
subtaskId	integer (int32)	ID подзадачи, если задача является многоэкземплярной задачей.
taskId	string	ID задачи.
taskState	BatchTaskState	Текущее состояние задачи.
taskUrl	string (uri)	URL задачи.

BatchTaskState

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

Enums BatchTaskState

Значение	Описание
active	Задача находится в очереди и может выполняться, но в данный момент не назначена вычислительному узлу. Задача входит в это состояние при создании, при включении после отключения или при ожидании повторной попытки после неудачного запуска.
preparing	Задача назначена вычислительному узлу, но ждёт выполнения необходимой задачи подготовки задания на вычислительном узле. Если задание подготовки к работе успешно выполнено, задание переходит к запуску. Если задача подготовки задания не выполняется, задача возвращается в активное состояние и может быть назначена другому вычислительному узлу.
running	Задача выполняется на вычислительном узле. Это включает подготовку на уровне задач, такую как загрузка файлов ресурсов или развертывание пакетов, указанных в задаче — это не обязательно означает, что командная строка задачи уже начала выполняться.
completed	Задание больше не может быть выполнено, обычно потому, что оно успешно завершено или неуспешно завершилось и исчерпал лимит повторных попыток. Задача также отмечается как завершённая, если произошла ошибка при запуске задачи или когда задача была завершена.

BatchVmImageReference

Объект

Ссылка на образ Azure Virtual Machines Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех ссылок на образы Azure Marketplace, проверенных пакетной службой Azure, см. операцию "Список поддерживаемых образов".

Имя	Тип	Описание
communityGalleryImageId	string	Уникальный идентификатор изображения в галерее сообщества. Это свойство является взаимоисключающим с другими свойствами и может быть получено из вызова GET коллекции сообщества.
exactVersion	string	Конкретная версия изображения платформы или изображения маркетплейса, используемая для создания узла. Это поле только для чтения отличается от 'version' только в том случае, если значение 'version', указанное при создании пула, было 'последним'.
offer	string	Тип предложения изображения Azure Virtual Machines Marketplace. Например, UbuntuServer или WindowsServer.
publisher	string	Издатель изображения Azure Virtual Machines Marketplace. Например, Canonical или MicrosoftWindowsServer.
sharedGalleryImageId	string	Уникальный идентификатор изображения общей галереи. Это свойство является взаимоисключающим с другими свойствами и может быть получено из вызова GET образа общей коллекции.
sku	string	SKU изображения Azure Virtual Machines Marketplace. Например, 18.04-LTS или 2019-Datacenter.
version	string	Версия изображения Azure Virtual Machines Marketplace. Для выбора последней версии изображения можно задать значение 'lastest'. Если опущено, значение по умолчанию — "последняя".
virtualMachineImageId	string (arm-id)	Идентификатор ресурса ARM образа коллекции вычислений Azure. Вычислительные узлы в пуле будут созданы с использованием этого идентификатора изображения. Это в виде /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} или /subscriptions/{subscriptionId}/resourceGroup/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} для постоянного выбора последней версии изображения. Это свойство взаимоисключается с другими свойствами ImageReference. Образ вычислительной галереи Azure должен иметь реплики в том же регионе и находиться в той же подписке, что и аккаунт Azure Batch. Если версия изображения не указана в imageId, будет использована последняя версия. Для получения информации о настройках межсетевого экрана для агента Batch Compute Node для взаимодействия с сервисом Batch см. https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

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	Значение переменной среды.

InboundEndpoint

Объект

Конечная точка входящего трафика на вычислительном узле.

Имя	Тип	Описание
backendPort	integer (int32)	Номер порта на сервере эндпоинта.
frontendPort	integer (int32)	Публичный номер порта конечной точки.
name	string	Имя конечной точки.
protocol	InboundEndpointProtocol	Протокол конечной точки.
publicFQDN	string	Публичное полностью квалифицированное доменное имя для вычислительного узла.
publicIPAddress	string	Публичный IP-адрес вычислительного узла.

InboundEndpointProtocol

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

Enums InboundEndpointProtocol

Значение	Описание
tcp	Используйте TCP для конечной точки.
udp	Используйте UDP для конечной точки.

NameValuePair

Объект

Представляет пару "имя-значение".

Имя	Тип	Описание
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 для контейнера, чтобы разрешить общедоступный доступ.

SchedulingState

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

Enums SchedulingState

Значение	Описание
enabled	Задачи можно планировать на вычислительном узле.
disabled	Новые задачи не планируются на Вычислительном узле. Задачи, уже выполняющиеся на Вычислительном узле, могут всё ещё выполняться до завершения. Все вычислительные узлы начинаются с включенным планированием.

UserIdentity

Объект

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

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

VirtualMachineInfo

Объект

Сведения о текущем состоянии виртуальной машины.

Имя	Тип	Описание
imageReference	BatchVmImageReference	Ссылка на образ рынка виртуальной машины Azure Virtual Machine.
scaleSetVmResourceId	string	Идентификатор ресурса текущей виртуальной машины Virtual Machine Scale Set VM. Определяется только если пакетный аккаунт был создан с свойством poolAllocationMode, установленным в 'UserSubscription'.

Поделиться через

Nodes - List Nodes

Параметры URI

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

Ответы

Безопасность

OAuth2Auth

Области

Примеры

Node list

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

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

Определения

AutoUserScope

AutoUserSpecification

BatchError

BatchErrorDetail

BatchErrorMessage

BatchErrorSourceCategory

BatchNode

BatchNodeAgentInfo

BatchNodeEndpointConfiguration

BatchNodeError

BatchNodeIdentityReference

BatchNodeListResult

BatchNodeState

BatchStartTask

BatchStartTaskInfo

BatchStartTaskState

BatchTaskContainerExecutionInfo

BatchTaskContainerSettings

BatchTaskExecutionInfo

BatchTaskExecutionResult

BatchTaskFailureInfo

BatchTaskInfo

BatchTaskState

BatchVmImageReference

ContainerHostBatchBindMountEntry

ContainerHostDataPath

ContainerRegistryReference

ContainerWorkingDirectory

ElevationLevel

EnvironmentSetting

InboundEndpoint

InboundEndpointProtocol

NameValuePair

ResourceFile

SchedulingState

UserIdentity

VirtualMachineInfo