Compute Node - List

Service:

Batch Service

API Version:

2022-01-01.15.0

Выводит список вычислительных узлов в указанном пуле.

GET {batchUrl}/pools/{poolId}/nodes?api-version=2022-01-01.15.0

With optional parameters:

GET {batchUrl}/pools/{poolId}/nodes?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2022-01-01.15.0

Параметры URI

Name	In	Required	Type	Description
batchUrl	path	True	string	Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure.
poolId	path	True	string	Идентификатор пула, из которого требуется перечислить вычислительные узлы.
api-version	query	True	string	Версия API клиента.
$filter	query		string	Предложение $filter OData. Дополнительные сведения о создании этого фильтра см. в разделе https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.
$select	query		string	Предложение $select OData.
maxresults	query		integer int32	Максимальное количество элементов, возвращаемых в ответе. Можно вернуть не более 1000 вычислительных узлов.
timeout	query		integer int32	Максимальное время, которое сервер может потратить на обработку запроса в секундах. По умолчанию это 30 секунд.

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

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

Name	Required	Type	Description
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 напрямую.

Ответы

Name	Type	Description
200 OK	ComputeNodeListResult	Ответ, содержащий список вычислительных узлов. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Ошибка из пакетной службы.

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

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Олицетворение учетной записи пользователя

Authorization

Type: apiKey
In: header

Примеры

Node list

Sample Request

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes?api-version=2022-01-01.15.0

Sample Response

Status code:

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": "2016-11-22T22:22:27.2236818Z",
      "lastBootTime": "2016-11-22T22:22:24.4634125Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_1-20161122t193202z",
      "vmSize": "small",
      "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
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2016-11-22T22:22:27.2236818Z",
        "endTime": "2016-11-22T22:22:27.567189Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-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": "2016-11-22T19:37:31.4285526Z",
      "lastBootTime": "2016-11-22T19:37:28.623369Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
      "vmSize": "small",
      "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
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2016-11-22T19:37:31.4285526Z",
        "endTime": "2016-11-22T19:37:31.838028Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-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": "2016-11-22T19:36:51.0013378Z",
      "lastBootTime": "2016-11-22T19:36:48.21721Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_3-20161122t193202z",
      "vmSize": "small",
      "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
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2016-11-22T19:36:51.0013378Z",
        "endTime": "2016-11-22T19:36:51.2363447Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
      }
    }
  ]
}

Определения

AutoUserScope	Область для автоматического пользователя
AutoUserSpecification	Указывает параметры для автоматического пользователя, запускающего задачу в пакетной службе.
BatchError	Ответ об ошибке, полученный от службы пакетная служба Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.
CertificateReference	Ссылка на сертификат, устанавливаемый на вычислительных узлах в пуле.
CertificateStoreLocation	Расположение хранилища сертификатов на вычислительном узле, в которое необходимо установить сертификат.
ComputeNode	Вычислительный узел в пакетной службе.
ComputeNodeEndpointConfiguration	Конфигурация конечной точки для вычислительного узла.
ComputeNodeError	Ошибка, обнаруженная вычислительным узлом.
ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
ComputeNodeListResult	Результат перечисления вычислительных узлов в пуле.
ComputeNodeState	Текущее состояние вычислительного узла.
ContainerRegistry	Частный реестр контейнеров.
ContainerWorkingDirectory	Расположение рабочего каталога задачи контейнера.
ElevationLevel	Уровень повышения прав пользователя.
EnvironmentSetting	Переменная среды, устанавливаемая в процессе задачи.
ErrorCategory	Категория ошибки.
ErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетная служба Azure.
ImageReference	Ссылка на образ azure Виртуальные машины Marketplace или образ Общая коллекция образов. Список всех ссылок на изображения Azure Marketplace, проверенных пакетная служба Azure, см. в разделе "Список поддерживаемых образов".
InboundEndpoint	Входящая конечная точка на вычислительном узле.
InboundEndpointProtocol	Протокол конечной точки.
NameValuePair	Представляет пару "имя-значение".
NodeAgentInformation	Сведения об агенте вычислительного узла.
ResourceFile	Один файл или несколько файлов, которые необходимо скачать на вычислительный узел.
SchedulingState	Доступен ли вычислительный узел для планирования задач.
StartTask	Задача, которая выполняется при присоединении узла к пулу в службе пакетная служба Azure или при перезагрузке или повторном создании вычислительного узла.
StartTaskInformation	Сведения о startTask, работающем на вычислительном узле.
StartTaskState	Состояние StartTask на вычислительном узле.
TaskContainerExecutionInformation	Содержит сведения о контейнере, который выполняет задача.
TaskContainerSettings	Параметры контейнера для задачи.
TaskExecutionInformation	Сведения о выполнении задачи.
TaskExecutionResult	Результат выполнения задачи.
TaskFailureInformation	Сведения о сбое задачи.
TaskInformation	Сведения о задаче, выполняемой на вычислительном узле.
TaskState	Состояние задачи.
UserIdentity	Определение удостоверения пользователя, под которым выполняется задача.
VirtualMachineInfo	Сведения о текущем состоянии виртуальной машины.

AutoUserScope

Область для автоматического пользователя

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

AutoUserSpecification

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

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

BatchError

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

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

BatchErrorDetail

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

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

CertificateReference

Ссылка на сертификат, устанавливаемый на вычислительных узлах в пуле.

Name	Type	Description
storeLocation	CertificateStoreLocation	Расположение хранилища сертификатов на вычислительном узле, в которое необходимо установить сертификат. Значение по умолчанию — currentuser. Это свойство применимо только для пулов, настроенных с Windows вычислительных узлов (т. е. созданных с помощью cloudServiceConfiguration или virtualMachineConfiguration с помощью ссылки на образ Windows). Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочей папки задачи, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса этого расположения. Для сертификатов с видимостью remoteUser каталог "certs" создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог.
storeName	string	Имя хранилища сертификатов на вычислительном узле, в который необходимо установить сертификат. Это свойство применимо только для пулов, настроенных с Windows вычислительных узлов (т. е. созданных с помощью cloudServiceConfiguration или virtualMachineConfiguration с помощью ссылки на образ Windows). К общим именам хранилищ относятся: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, но также можно использовать любое имя пользовательского хранилища. Значение по умолчанию - «My».
thumbprint	string	Отпечаток сертификата.
thumbprintAlgorithm	string	Алгоритм, с которым связан отпечаток. Это должно быть sha1.
visibility	string[]	Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата. В этой коллекции можно указать несколько видимостей. Значение по умолчанию — все учетные записи.

CertificateStoreLocation

Расположение хранилища сертификатов на вычислительном узле, в которое необходимо установить сертификат.

Name	Type	Description
currentuser	string	Сертификаты должны быть установлены в хранилище сертификатов CurrentUser.
localmachine	string	Сертификаты должны быть установлены в хранилище сертификатов LocalMachine.

ComputeNode

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

Name	Type	Description
affinityId	string	Идентификатор, который можно передать при добавлении задачи для запроса, что задача должна быть запланирована на этом вычислительном узле. Обратите внимание, что это просто мягкое сходство. Если целевой вычислительный узел занят или недоступен во время планирования задачи, задача будет запланирована в другом месте.
allocationTime	string	Время, в течение которого этот вычислительный узел был выделен пулу. Это время, когда вычислительный узел изначально был выделен и не изменяется один раз. Он не обновляется, когда вычислительный узел исцеляется или вытесняется.
certificateReferences	CertificateReference[]	Список сертификатов, установленных на вычислительном узле. Для узлов Windows пакетная служба устанавливает сертификаты в указанное хранилище сертификатов и расположение. Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочей папки задачи, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса этого расположения. Для сертификатов с видимостью remoteUser каталог "certs" создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог.
endpointConfiguration	ComputeNodeEndpointConfiguration	Конфигурация конечной точки для вычислительного узла.
errors	ComputeNodeError[]	Список ошибок, которые в настоящее время встречаются вычислительным узлом.
id	string	Идентификатор вычислительного узла. Каждому вычислительному узлу, добавляемому в пул, присваивается уникальный идентификатор. Каждый раз, когда вычислительный узел удаляется из пула, удаляются все локальные файлы, а идентификатор освобождается и может использоваться повторно для новых вычислительных узлов.
ipAddress	string	IP-адрес, который другие узлы могут использовать для взаимодействия с этим вычислительным узлом. Каждому вычислительному узлу, добавляемому в пул, назначается уникальный IP-адрес. Каждый раз, когда вычислительный узел удаляется из пула, удаляются все его локальные файлы, а IP-адрес освобождается и может быть повторно использован для новых вычислительных узлов.
isDedicated	boolean	Указывает, является ли этот вычислительный узел выделенным вычислительным узлом. Если значение равно false, вычислительный узел является точечным или низкоприоритетным вычислительным узлом.
lastBootTime	string	Время последнего запуска вычислительного узла. Это свойство может не присутствовать, если состояние вычислительного узла недоступно для использования.
nodeAgentInfo	NodeAgentInformation	Сведения о версии агента вычислительного узла и времени обновления вычислительного узла до новой версии. Агент batch Compute Node — это программа, которая выполняется на каждом вычислительном узле в пуле и предоставляет пакетную возможность на вычислительном узле.
recentTasks	TaskInformation[]	Список задач, состояние которых недавно изменилось. Это свойство присутствует только в том случае, если на этом вычислительном узле выполнялась по крайней мере одна задача, так как она была назначена пулу.
runningTaskSlotsCount	integer	Общее количество слотов планирования, используемых в настоящее время выполнением задач задания на вычислительном узле. Сюда входят задачи диспетчера заданий и обычные задачи, но не подготовка заданий, выпуск заданий или запуск задач.
runningTasksCount	integer	Общее число выполняющихся в данный момент задач задания на вычислительном узле. Сюда входят задачи диспетчера заданий и обычные задачи, но не подготовка заданий, выпуск заданий или запуск задач.
schedulingState	SchedulingState	Доступен ли вычислительный узел для планирования задач.
startTask	StartTask	Задача, указанная для запуска на вычислительном узле при присоединении к пулу. Пакетная служба повторит задачи при активации операции восстановления на узле. Примеры операций восстановления включают (но не ограничиваются) при перезагрузке неработоспособного узла или исчезновении вычислительного узла из-за сбоя узла. Повторные попытки из-за операций восстановления не зависят от maxTaskRetryCount. Даже если значение maxTaskRetryCount равно 0, может возникнуть внутренняя повторная попытка из-за операции восстановления. Из-за этого все задачи должны быть идемпотентными. Это означает, что задачи должны допускать прерывание и перезапуск без повреждения или дублирования данных. Для длительных задач рекомендуется использовать определенную форму создания контрольных точек. В некоторых случаях StartTask может быть повторно запущен, даже если вычислительный узел не был перезагружен. Чтобы избежать запуска startTasks, создающих отколовшиеся процессы или установки и запуска служб из рабочего каталога StartTask, следует избегать того, чтобы пакетная служба могла повторно запустить StartTask.
startTaskInfo	StartTaskInformation	Сведения о выполнении StartTask на вычислительном узле.
state	ComputeNodeState	Текущее состояние вычислительного узла. Точечный или низкоприоритетный вычислительный узел был вытесняется. Задачи, которые выполнялись на вычислительном узле, когда он был упрежен, будут перепланированы, когда станет доступен другой вычислительный узел.
stateTransitionTime	string	Время, когда вычислительный узел вошел в текущее состояние.
totalTasksRun	integer	Общее количество задач заданий, выполненных на вычислительном узле. Сюда входят задачи диспетчера заданий и обычные задачи, но не подготовка заданий, выпуск заданий или запуск задач.
totalTasksSucceeded	integer	Общее количество задач задания, которые успешно завершены (с exitCode 0) на вычислительном узле. Сюда входят задачи диспетчера заданий и обычные задачи, но не подготовка заданий, выпуск заданий или запуск задач.
url	string	URL-адрес вычислительного узла.
virtualMachineInfo	VirtualMachineInfo	Сведения о текущем состоянии виртуальной машины.
vmSize	string	Размер виртуальной машины, на котором размещен вычислительный узел. Сведения о доступных размерах виртуальных машин в пулах см. в разделе "Выбор размера виртуальной машины для вычислительных узлов" в пуле пакетная служба Azure (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

ComputeNodeEndpointConfiguration

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

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

ComputeNodeError

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

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

ComputeNodeIdentityReference

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

Name	Type	Description
resourceId	string	Идентификатор ресурса ARM назначенного пользователем удостоверения.

ComputeNodeListResult

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

Name	Type	Description
odata.nextLink	string	URL-адрес для получения следующего набора результатов.
value	ComputeNode[]	Список вычислительных узлов.

ComputeNodeState

Текущее состояние вычислительного узла.

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

ContainerRegistry

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

Name	Type	Description
identityReference	ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, используемое для доступа к Реестр контейнеров Azure вместо имени пользователя и пароля. Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
password	string	Пароль для входа на сервер реестра.
registryServer	string	URL-адрес реестра. Если этот параметр опущен, по умолчанию используется значение "docker.io".
username	string	Имя пользователя для входа на сервер реестра.

ContainerWorkingDirectory

Расположение рабочего каталога задачи контейнера.

Name	Type	Description
containerImageDefault	string	Используйте рабочий каталог, определенный в образе контейнера. Будьте осторожны, что этот каталог не будет содержать файлы ресурсов, скачанные пакетной службой.
taskWorkingDirectory	string	Используйте стандартный рабочий каталог задачи пакетной службы, который будет содержать файлы ресурсов задач, заполненные пакетной службой.

ElevationLevel

Уровень повышения прав пользователя.

Name	Type	Description
admin	string	Пользователь является пользователем с повышенным уровнем доступа и работает с полными разрешениями администратора.
nonadmin	string	Пользователь является стандартным пользователем без повышенных прав доступа.

EnvironmentSetting

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

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

ErrorCategory

Категория ошибки.

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

ErrorMessage

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

Name	Type	Description
lang	string	Код языка сообщения об ошибке
value	string	Текст сообщения.

ImageReference

Ссылка на образ azure Виртуальные машины Marketplace или образ Общая коллекция образов. Список всех ссылок на изображения Azure Marketplace, проверенных пакетная служба Azure, см. в разделе "Список поддерживаемых образов".

Name	Type	Description
exactVersion	string	Конкретная версия образа платформы или образа Marketplace, используемого для создания узла. Это поле только для чтения отличается от "version" только в том случае, если значение, указанное для параметра "версия", когда был создан пул, был "latest".
offer	string	Тип предложения образа azure Виртуальные машины Marketplace. Например, UbuntuServer или WindowsServer.
publisher	string	Издатель образа Виртуальные машины Marketplace Azure. Например, Canonical или MicrosoftWindowsServer.
sku	string	Номер SKU образа Виртуальные машины Marketplace Azure. Например, 18.04-LTS или 2019-Datacenter.
version	string	Версия образа azure Виртуальные машины Marketplace. Можно указать значение latest, чтобы выбрать последнюю версию образа. Если этот параметр опущен, значение по умолчанию — latest.
virtualMachineImageId	string	Идентификатор ресурса ARM образа Общая коллекция образов. Вычислительные узлы в пуле будут созданы с помощью этого идентификатора образа. Это форма /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} или /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} для постоянного использования последней версии образа. Это свойство является взаимоисключающим с другими свойствами ImageReference. Образ Общая коллекция образов должен иметь реплики в одном регионе и находиться в той же подписке, что и учетная запись пакетная служба Azure. Если версия образа не указана в imageId, будет использоваться последняя версия. Сведения о параметрах брандмауэра для агента пакетного вычислительного узла для взаимодействия с пакетной службой см. в разделе https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpoint

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

Name	Type	Description
backendPort	integer	Номер внутреннего порта конечной точки.
frontendPort	integer	Номер общедоступного порта конечной точки.
name	string	Имя конечной точки.
protocol	InboundEndpointProtocol	Протокол конечной точки.
publicFQDN	string	Общедоступное полное доменное имя вычислительного узла.
publicIPAddress	string	Общедоступный IP-адрес вычислительного узла.

InboundEndpointProtocol

Протокол конечной точки.

Name	Type	Description
tcp	string	Используйте TCP для конечной точки.
udp	string	Используйте UDP для конечной точки.

NameValuePair

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

Name	Type	Description
name	string	Имя в паре "имя-значение".
value	string	Значение в паре "имя-значение".

NodeAgentInformation

Сведения об агенте вычислительного узла.

Name	Type	Description
lastUpdateTime	string	Время обновления агента вычислительного узла на вычислительном узле. Это самое последнее время, когда агент вычислительного узла был обновлен до новой версии.
version	string	Версия агента пакетного вычислительного узла, работающего на вычислительном узле. Этот номер версии можно проверить на наличие заметок о выпуске агента вычислительного узла, расположенных по адресу https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.

ResourceFile

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

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

SchedulingState

Доступен ли вычислительный узел для планирования задач.

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

StartTask

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

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

StartTaskInformation

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

Name	Type	Description
containerInfo	TaskContainerExecutionInformation	Сведения о контейнере, в котором выполняется задача. Это свойство задается только в том случае, если задача выполняется в контексте контейнера.
endTime	string	Время остановки запуска StartTask. Это время окончания последнего запуска StartTask, если оно завершилось (даже если этот запуск завершился сбоем и ожидается повтор). Этот элемент отсутствует, если в данный момент выполняется StartTask.
exitCode	integer	Код выхода программы, указанной в командной строке StartTask. Это свойство задается только в том случае, если StartTask находится в состоянии завершения. Как правило, код выхода для процесса отражает конкретное соглашение, реализованное разработчиком приложения для этого процесса. Если вы используете значение кода выхода для принятия решений в коде, убедитесь, что вы знаете соглашение о коде выхода, используемое процессом приложения. Однако если пакетная служба завершает начальную загрузку (из-за истечения времени ожидания или завершения работы пользователя через API), может отображаться код выхода, определенный операционной системой.
failureInfo	TaskFailureInformation	Сведения, описывающие сбой задачи, если таковые есть. Это свойство задается, только если задача находится в состоянии завершения и возникла ошибка.
lastRetryTime	string	Последнее время, с которого началась повторная попытка задачи. Этот элемент присутствует только в том случае, если задача была повторно выполнена (т. е. retryCount ненулево). Если он присутствует, это обычно то же самое, что и время начала, но может отличаться, если задача была перезапущена по причинам, отличным от повторных попыток; Например, если вычислительный узел был перезагружен во время повтора, время начала обновляется, но значение lastRetryTime не является.
result	TaskExecutionResult	Результат выполнения задачи. Если значение равно failed, подробные сведения о сбое можно найти в свойстве failureInfo.
retryCount	integer	Количество повторных попыток задачи пакетной службой. Сбои приложения задачи (ненулевая код выхода) выполняются повторно, ошибки предварительной обработки (задача не может быть выполнена) и ошибки отправки файлов не будут повторяться. Пакетная служба повторит задачу до предела, указанного ограничениями.
startTime	string	Время запуска StartTask. Это значение сбрасывается каждый раз при перезапуске или повторной попытке задачи (т. е. это самое последнее время, когда запускается StartTask).
state	StartTaskState	Состояние StartTask на вычислительном узле.

StartTaskState

Состояние StartTask на вычислительном узле.

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

TaskContainerExecutionInformation

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

Name	Type	Description
containerId	string	Идентификатор контейнера.
error	string	Подробные сведения об ошибке контейнера. Это подробная строка ошибки из службы Docker, если она доступна. Это эквивалентно полю ошибки, возвращаемой методом docker inspect.
state	string	Состояние контейнера. Это состояние контейнера в соответствии со службой Docker. Это эквивалентно полю состояния, возвращаемого методом docker inspect.

TaskContainerSettings

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

Name	Type	Description
containerRunOptions	string	Дополнительные параметры команды создания контейнера. Эти дополнительные параметры предоставляются в качестве аргументов для команды docker create в дополнение к тем, которые управляются пакетной службой.
imageName	string	Образ, используемый для создания контейнера, в котором будет выполняться задача. Это полная ссылка на образ, как указано в параметре docker pull. Если тег не указан как часть имени образа, тег ":latest" используется в качестве значения по умолчанию.
registry	ContainerRegistry	Частный реестр, содержащий образ контейнера. Этот параметр можно опустить, если он уже был указан при создании пула.
workingDirectory	ContainerWorkingDirectory	Расположение рабочего каталога задачи контейнера. Значение по умолчанию — taskWorkingDirectory.

TaskExecutionInformation

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

Name	Type	Description
containerInfo	TaskContainerExecutionInformation	Сведения о контейнере, в котором выполняется задача. Это свойство задается только в том случае, если задача выполняется в контексте контейнера.
endTime	string	Время завершения задачи. Это свойство задается только в том случае, если задача находится в состоянии "Завершено".
exitCode	integer	Код выхода программы, указанной в командной строке задачи. Это свойство задается, только если задача находится в состоянии завершения. Как правило, код выхода для процесса отражает конкретное соглашение, реализованное разработчиком приложения для этого процесса. Если вы используете значение кода выхода для принятия решений в коде, убедитесь, что вы знаете соглашение о коде выхода, используемое процессом приложения. Однако если пакетная служба завершает задачу (из-за истечения времени ожидания или завершения работы пользователя через API), может отображаться код выхода, определенный операционной системой.
failureInfo	TaskFailureInformation	Сведения, описывающие сбой задачи, если таковые есть. Это свойство задается, только если задача находится в состоянии завершения и возникла ошибка.
lastRequeueTime	string	Последнее время, когда задача была перезапугирована пакетной службой в результате запроса пользователя. Это свойство задается только в том случае, если requeueCount не является нулевым.
lastRetryTime	string	Последнее время, с которого началась повторная попытка задачи. Этот элемент присутствует только в том случае, если задача была повторно выполнена (т. е. retryCount ненулево). Если он присутствует, это обычно то же самое, что и время начала, но может отличаться, если задача была перезапущена по причинам, отличным от повторных попыток; Например, если вычислительный узел был перезагружен во время повтора, время начала обновляется, но значение lastRetryTime не является.
requeueCount	integer	Количество повторов задачи пакетной службой в результате запроса пользователя. Когда пользователь удаляет вычислительные узлы из пула (путем изменения размера или сжатия пула) или при отключении задания, пользователь может указать, что выполнение задач на вычислительных узлах будет повторно возвращено для выполнения. Это число отслеживает количество повторов задачи по этим причинам.
result	TaskExecutionResult	Результат выполнения задачи. Если значение равно failed, подробные сведения о сбое можно найти в свойстве failureInfo.
retryCount	integer	Количество повторных попыток задачи пакетной службой. Сбои приложения задачи (ненулевая код выхода) выполняются повторно, ошибки предварительной обработки (задача не может быть выполнена) и ошибки отправки файлов не будут повторяться. Пакетная служба повторит задачу до предела, указанного ограничениями.
startTime	string	Время запуска задачи. "Выполняется" соответствует состоянию выполнения, поэтому, если задача указывает файлы ресурсов или пакеты, время начала отражает время начала загрузки или развертывания задачи. Если задача была перезапущена или повторна, это самое последнее время, когда задача запущена. Это свойство присутствует только для задач, которые находятся в состоянии выполнения или завершения.

TaskExecutionResult

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

Name	Type	Description
failure	string	Во время обработки задачи произошла ошибка. Возможно, произошел сбой до запуска процесса задачи, во время выполнения процесса задачи или после завершения процесса задачи.
success	string	Задача выполнена успешно.

TaskFailureInformation

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

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

TaskInformation

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

Name	Type	Description
executionInfo	TaskExecutionInformation	Сведения о выполнении задачи.
jobId	string	Идентификатор задания, которому принадлежит задача.
subtaskId	integer	Идентификатор подзадаки, если задача является задачей с несколькими экземплярами.
taskId	string	Идентификатор задачи.
taskState	TaskState	Текущее состояние задачи.
taskUrl	string	URL-адрес задачи.

TaskState

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

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

UserIdentity

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

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

VirtualMachineInfo

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

Name	Type	Description
imageReference	ImageReference	Ссылка на образ Marketplace виртуальной машины Azure.