Compute Node - Get

Служба:

Batch Service

Версия API:

2024-07-01.20.0

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

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?api-version=2024-07-01.20.0

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

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?$select={$select}&timeout={timeout}&api-version=2024-07-01.20.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
batchUrl	path	True	string	Базовый URL-адрес для всех запросов пакетной службы Azure.
nodeId	path	True	string	Идентификатор вычислительного узла, о который требуется получить сведения.
poolId	path	True	string	Идентификатор пула, содержащего вычислительный узел.
api-version	query	True	string	Версия КЛИЕНТСКОго API.
$select	query		string	Предложение OData $select.
timeout	query		integer int32	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение больше 30, вместо этого будет использоваться значение по умолчанию.

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

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

Имя	Обязательно	Тип	Описание
client-request-id		string uuid	Удостоверение запроса, созданное вызывающим пользователем, в виде GUID без украшений, таких как фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Должен ли сервер возвращать идентификатор client-request-id в ответе.
ocp-date		string date-time-rfc1123	Время выдачи запроса. Клиентские библиотеки обычно задают это в текущее время системных часов; задайте его явным образом, если вы вызываете REST API напрямую.

Ответы

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

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

azure_auth

Поток кода проверки подлинности Microsoft Entra OAuth 2.0

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

Authorization

Тип: apiKey
В: header

Примеры

Node get

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

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z?api-version=2024-07-01.20.0

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

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

200

{
  "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,
  "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-22T19:37:28.623369Z"
  }
}

Определения

Имя	Описание
AutoUserScope	Область для автоматического пользователя
AutoUserSpecification	Задает параметры для автоматического пользователя, выполняющего задачу в пакетной службе.
BatchError	Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
CertificateReference	Ссылка на сертификат, который необходимо установить на вычислительных узлах в пуле.
CertificateStoreLocation	Расположение хранилища сертификатов на вычислительном узле, в который необходимо установить сертификат.
CertificateVisibility	Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата.
ComputeNode	Вычислительный узел в пакетной службе.
ComputeNodeEndpointConfiguration	Конфигурация конечной точки для вычислительного узла.
ComputeNodeError	Ошибка, обнаруженная вычислительным узлом.
ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
ComputeNodeState	Текущее состояние вычислительного узла.
ContainerHostBatchBindMountEntry	Вход пути и режима подключения, который требуется подключить к контейнеру задач.
ContainerHostDataPath	Пути, которые будут подключены к контейнеру задачи контейнера.
ContainerRegistry	Частный реестр контейнеров.
ContainerWorkingDirectory	Расположение рабочего каталога задачи контейнера.
ElevationLevel	Уровень повышения прав пользователя.
EnvironmentSetting	Переменная среды, устанавливаемая в процессе задачи.
ErrorCategory	Категория ошибки.
ErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
ImageReference	Ссылка на образ Azure Virtual Machines Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех ссылок на образы 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

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

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

AutoUserSpecification

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

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

BatchError

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

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

BatchErrorDetail

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

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

CertificateReference

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

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

CertificateStoreLocation

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

Имя	Тип	Описание
currentuser	string	Сертификаты должны быть установлены в хранилище сертификатов CurrentUser.
localmachine	string	Сертификаты должны быть установлены в хранилище сертификатов LocalMachine.

CertificateVisibility

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

Имя	Тип	Описание
remoteuser	string	Сертификат должен отображаться для учетных записей пользователей, в которых пользователи удаленно обращаются к вычислительному узлу.
starttask	string	Сертификат должен быть видимым для учетной записи пользователя, в которой выполняется StartTask. Обратите внимание, что если область autoUser является пулом как для startTask, так и для задачи, этот сертификат также будет виден задаче.
task	string	Сертификат должен быть видимым для учетных записей пользователей, в которых выполняются задачи задания.

ComputeNode

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

Имя	Тип	Описание
affinityId	string	Идентификатор, который можно передать при добавлении задачи для запроса на выполнение задачи на этом вычислительном узле. Обратите внимание, что это просто мягкое сходство. Если целевой вычислительный узел занят или недоступен во время планирования задачи, задача будет запланирована в другом месте.
allocationTime	string	Время, в течение которого этот вычислительный узел был выделен пулу. Это время, когда вычислительный узел изначально был выделен и не изменяется после установки. Он не обновляется, если вычислительный узел является службой, исцеляемой или предварительной.
certificateReferences	CertificateReference[]	Список сертификатов, установленных на вычислительном узле. Для узлов Windows пакетная служба устанавливает сертификаты в указанное хранилище сертификатов и расположение. Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочей папки задачи, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса к этому расположению. Для сертификатов с видимостью remoteUser каталог "certs" создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог. Предупреждение. Это свойство устарело и будет удалено после февраля 2024 года. Вместо этого используйте расширения Azure KeyVault .
endpointConfiguration	ComputeNodeEndpointConfiguration	Конфигурация конечной точки для вычислительного узла.
errors	ComputeNodeError[]	Список ошибок, с которыми в настоящее время сталкивается вычислительный узел.
id	string	Идентификатор вычислительного узла. Каждому вычислительному узлу, добавляемого в пул, присваивается уникальный идентификатор. Когда вычислительный узел удаляется из пула, удаляются все локальные файлы, а идентификатор повторно используется для новых вычислительных узлов.
ipAddress	string	IP-адрес, который другие узлы могут использовать для взаимодействия с этим вычислительным узлом. Каждый вычислительный узел, добавленный в пул, назначается уникальный IP-адрес. Когда вычислительный узел удаляется из пула, удаляются все локальные файлы, а IP-адрес повторно используется для новых вычислительных узлов.
isDedicated	boolean	Указывает, является ли этот вычислительный узел выделенным вычислительным узлом. Если значение false, вычислительный узел является точечным или низкоприоритетным вычислительным узлом.
lastBootTime	string	Последний раз, когда был запущен вычислительный узел. Это свойство может не присутствовать, если состояние вычислительного узла недоступно.
nodeAgentInfo	NodeAgentInformation	Сведения о версии агента вычислительного узла и времени обновления вычислительного узла до новой версии. Агент пакетного вычислительного узла — это программа, которая выполняется на каждом вычислительном узле в пуле и предоставляет пакетную возможность на вычислительном узле.
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	Общее количество задач заданий, успешно завершенных (с выходом 0) на вычислительном узле. К ним относятся задачи диспетчера заданий и обычные задачи, но не подготовка заданий, выпуск задания или запуск задач.
url	string	URL-адрес вычислительного узла.
virtualMachineInfo	VirtualMachineInfo	Сведения о текущем состоянии виртуальной машины.
vmSize	string	Размер виртуальной машины, на котором размещен вычислительный узел. Сведения о доступных размерах виртуальных машин в пулах см. в разделе "Выбор размера виртуальной машины для вычислительных узлов" в пуле пакетной службы Azure (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).

ComputeNodeEndpointConfiguration

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

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

ComputeNodeError

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

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

ComputeNodeIdentityReference

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

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

ComputeNodeState

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

Имя	Тип	Описание
creating	string	Пакетная служба получила базовую виртуальную машину из вычислений Azure, но она еще не начала присоединяться к пулу.
deallocated	string	Вычислительный узел освобожден.
deallocating	string	Вычислительный узел освобождается.
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	Вычислительный узел нельзя использовать для выполнения задачи из-за ошибок.
upgradingos	string	Вычислительный узел проходит операцию обновления ОС.
waitingforstarttask	string	StartTask запущен на вычислительном узле, но задано значение waitForSuccess, и startTask еще не завершено.

ContainerHostBatchBindMountEntry

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

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

ContainerHostDataPath

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

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

ContainerRegistry

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

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

ContainerWorkingDirectory

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

Имя	Тип	Описание
containerImageDefault	string	Используйте рабочий каталог, определенный в образе контейнера. Убедитесь, что этот каталог не будет содержать файлы ресурсов, скачанные пакетной службой.
taskWorkingDirectory	string	Используйте стандартный рабочий каталог задачи пакетной службы, который будет содержать файлы ресурсов задач, заполненные пакетной службой.

ElevationLevel

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

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

EnvironmentSetting

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

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

ErrorCategory

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

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

ErrorMessage

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

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

ImageReference

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

Имя	Тип	Описание
communityGalleryImageId	string	Уникальный идентификатор образа коллекции сообщества Это свойство является взаимоисключающим с другими свойствами и может быть получено из вызова GET коллекции сообщества.
exactVersion	string	Конкретная версия образа платформы или образа Marketplace, используемая для создания узла. Это поле только для чтения отличается от "версии" только в том случае, если значение, указанное для "версии", когда пул был создан, был "последняя".
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. Чтобы выбрать последнюю версию образа, можно указать значение "последняя". Если опущено, значение по умолчанию — "последняя".
virtualMachineImageId	string	Идентификатор ресурса ARM образа коллекции вычислений Azure. Вычислительные узлы в пуле будут созданы с помощью этого идентификатора образа. Это форма /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 должен иметь реплики в том же регионе и должен находиться в той же подписке, что и учетная запись пакетной службы Azure. Если версия образа не указана в imageId, будет использоваться последняя версия. Сведения о параметрах брандмауэра для агента пакетного вычислительного узла для взаимодействия со службой пакетной службы см. в https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

InboundEndpoint

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

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

InboundEndpointProtocol

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

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

NameValuePair

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

Имя	Тип	Описание
name	string	Имя в паре "имя-значение".
value	string	Значение в паре "имя-значение".

NodeAgentInformation

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

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

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	URL-адрес скачиваемого файла. Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан. Если URL-адрес указывает на хранилище BLOB-объектов Azure, он должен быть доступен для чтения с вычислительных узлов. Существует три способа получить такой URL-адрес для большого двоичного объекта в хранилище Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение большого двоичного объекта, использовать управляемое удостоверение с разрешением на чтение или задать ACL для большого двоичного объекта или его контейнера, чтобы разрешить общедоступный доступ.
identityReference	ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение для доступа к хранилищу BLOB-объектов Azure, заданному storageContainerUrl или httpUrl Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
storageContainerUrl	string	URL-адрес контейнера BLOB-объектов в хранилище BLOB-объектов Azure. Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан. Этот URL-адрес должен быть доступен для чтения и перечисления из вычислительных узлов. Существует три способа получить такой URL-адрес для контейнера в хранилище Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение и список для контейнера, использовать управляемое удостоверение с разрешениями на чтение и список или задать ACL для контейнера, чтобы разрешить общедоступный доступ.

SchedulingState

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

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

StartTask

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

Имя	Тип	Описание
commandLine	string	Командная строка StartTask. Командная строка не выполняется под оболочкой и поэтому не может воспользоваться преимуществами функций оболочки, таких как расширение переменной среды. Если вы хотите воспользоваться такими функциями, необходимо вызвать оболочку в командной строке, например с помощью cmd /c MyCommand в Windows или "/bin/sh -c MyCommand" в Linux. Если командная строка ссылается на пути к файлам, она должна использовать относительный путь (относительно рабочего каталога задачи) или использовать указанную пакетную переменную среды (https://learn.microsoft.com/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. Файлы, перечисленные в этом элементе, находятся в рабочем каталоге задачи.
userIdentity	UserIdentity	Удостоверение пользователя, под которым запускается StartTask. Если опущен, задача выполняется как пользователь, отличный от администрирования, уникальным для задачи.
waitForSuccess	boolean	Следует ли пакетной службе ждать успешного завершения startTask (т. е. выйти с кодом выхода 0) перед планированием любых задач на вычислительном узле. Если значение true и startTask завершается сбоем на узле, пакетная служба повторяет запускTask до максимального количества повторных попыток (maxTaskRetryCount). Если задача по-прежнему не выполнена успешно после всех повторных попыток, служба пакетной службы помечает узел неиспользуемой и не будет планировать задачи. Это условие можно обнаружить с помощью сведений о состоянии вычислительного узла и сведения о сбоях. Если значение false, служба пакетной службы не будет ожидать завершения запускаTask. В этом случае другие задачи могут запускаться на вычислительном узле во время запуска StartTask; и даже если сбой StartTask, новые задачи будут продолжать планироваться на вычислительном узле. Значение по умолчанию — true.

StartTaskInformation

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

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

StartTaskState

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

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

TaskContainerExecutionInformation

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

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

TaskContainerSettings

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

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

TaskExecutionInformation

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

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

TaskExecutionResult

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

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

TaskFailureInformation

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

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

TaskInformation

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

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

TaskState

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

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

UserIdentity

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

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

VirtualMachineInfo

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

Имя	Тип	Описание
imageReference	ImageReference	Ссылка на образ Marketplace виртуальной машины Azure.
scaleSetVmResourceId	string	Идентификатор ресурса текущей виртуальной машины масштабируемого набора виртуальных машин вычислительного узла. Определяется только в том случае, если учетная запись пакетной службы была создана с его свойством poolAllocationMode с значением UserSubscription.