Compute Node - Get

Service:

Batch Service

API Version:

2023-11-01.18.0

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

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?$select={$select}&timeout={timeout}&api-version=2023-11-01.18.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 секунд.

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

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	Ответ, содержащий вычислительный узел. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Ошибка из пакетной службы.

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

azure_auth

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

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

Scopes

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

Authorization

Type: apiKey
In: header

Примеры

Node get

Sample Request

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z?api-version=2023-11-01.18.0

Sample Response

Status code:

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	Текущее состояние вычислительного узла.
ContainerRegistry	Частный реестр контейнеров.
ContainerWorkingDirectory	Расположение рабочего каталога задачи контейнера.
ElevationLevel	Уровень прав пользователя.
EnvironmentSetting	Переменная среды, устанавливаемая в процессе задачи.
ErrorCategory	Категория ошибки.
ErrorMessage	Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.
ImageReference	Ссылка на образ Azure Виртуальные машины Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех Azure Marketplace ссылок на образы, проверенные пакетная служба Azure, см. операцию "Список поддерживаемых образов".
InboundEndpoint	Входящая конечная точка на вычислительном узле.
InboundEndpointProtocol	Протокол конечной точки.
NameValuePair	Представляет пару "имя-значение".
NodeAgentInformation	Сведения об агенте вычислительного узла.
ResourceFile	Один файл или несколько файлов для загрузки на вычислительный узел.
SchedulingState	Доступен ли вычислительный узел для планирования задач.
StartTask	Задача, которая выполняется, когда узел присоединяется к пулу в службе пакетная служба Azure или когда вычислительный узел перезагружается или перезагружается.
StartTaskInformation	Сведения о начальной нагрузке, выполняемой на вычислительном узле.
StartTaskState	Состояние StartTask на вычислительном узле.
TaskContainerExecutionInformation	Содержит сведения о контейнере, который выполняет задача.
TaskContainerSettings	Параметры контейнера для задачи.
TaskExecutionInformation	Сведения о выполнении задачи.
TaskExecutionResult	Результат выполнения задачи.
TaskFailureInformation	Сведения о сбое задачи.
TaskInformation	Сведения о задаче, выполняемой на вычислительном узле.
TaskState	Состояние задачи.
UserIdentity	Определение удостоверения пользователя, с которым выполняется задача.
VirtualMachineInfo	Сведения о текущем состоянии виртуальной машины.

AutoUserScope

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

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

AutoUserSpecification

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

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

BatchError

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

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

BatchErrorDetail

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

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

CertificateReference

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

Имя	Тип	Описание
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, Запрещено, 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. Обратите внимание, что если областью автопользования является пул для 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	Общее количество задач задания, успешно выполненных (с exitCode 0) на вычислительном узле. Сюда входят задачи диспетчера заданий и обычные задачи, но не подготовка заданий, выпуск заданий или запуск задач.
url	string	URL-адрес вычислительного узла.
virtualMachineInfo	VirtualMachineInfo	Сведения о текущем состоянии виртуальной машины.
vmSize	string	Размер виртуальной машины, на котором размещен вычислительный узел. Сведения о доступных размерах виртуальных машин в пулах см. в статье Выбор размера виртуальной машины для вычислительных узлов в пуле пакетная служба Azure (https://docs.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, но еще не начала присоединение к пулу.
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

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

Имя	Тип	Описание
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 Виртуальные машины Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех Azure Marketplace ссылок на образы, проверенные пакетная служба Azure, см. операцию "Список поддерживаемых образов".

Имя	Тип	Описание
exactVersion	string	Конкретная версия образа платформы или образа Marketplace, используемого для создания узла. Это поле , доступное только для чтения, отличается от "version" только в том случае, если значение , указанное для "version" при создании пула, было "latest".
offer	string	Тип предложения образа Azure Виртуальные машины Marketplace. Например, UbuntuServer или WindowsServer.
publisher	string	Издатель образа Azure Виртуальные машины Marketplace. Например, Canonical или MicrosoftWindowsServer.
sku	string	Номер SKU образа Azure Виртуальные машины Marketplace. Например, 18.04-LTS или 2019-Datacenter.
version	string	Версия образа Azure Виртуальные машины Marketplace. Чтобы выбрать последнюю версию образа, можно указать значение latest. Если этот параметр опущен, значение по умолчанию — latest.
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://docs.microsoft.com/en-us/azure/batch/batch-api-basics#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	Префикс большого двоичного объекта, используемый при скачивании больших двоичных объектов из контейнера службы хранилища 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-адрес для BLOB-объекта в службе хранилища 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

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

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

StartTask

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

Имя	Тип	Описание
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. Файлы, перечисленные в этом элементе, находятся в рабочем каталоге задачи.
userIdentity	UserIdentity	Удостоверение пользователя, под которым выполняется StartTask. Если этот параметр опущен, задача выполняется от имени пользователя, не являющегося административным, уникальным для задачи.
waitForSuccess	boolean	Указывает, должна ли пакетная служба ждать успешного завершения StartTask (т. е. выхода с кодом выхода 0), прежде чем планировать какие-либо задачи на вычислительном узле. Если задано значение true и на узле завершается сбой StartTask, пакетная служба повторяет попытку StartTask до максимального количества повторных попыток (maxTaskRetryCount). Если задача по-прежнему не была успешно завершена после всех повторных попыток, пакетная служба пометит узел непригодным для использования и не будет планировать задачи для него. Это условие можно определить с помощью сведений о состоянии вычислительного узла и сведений о сбое. Если значение равно false, пакетная служба не будет ожидать завершения начальной задачи. В этом случае другие задачи могут начать выполнение на вычислительном узле, пока startTask все еще выполняется; и даже в случае сбоя StartTask новые задачи будут по-прежнему планироваться на вычислительном узле. Значение по умолчанию — true.

StartTaskInformation

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

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

StartTaskState

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

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

TaskContainerExecutionInformation

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

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

TaskContainerSettings

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

Имя	Тип	Описание
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 не равно нулю). При наличии обычно это значение совпадает с startTime, но может отличаться, если задача была перезапущена по причинам, отличным от повторных попыток. Например, если вычислительный узел был перезагружен во время повторных попыток, то startTime обновляется, а lastRetryTime — нет.
requeueCount	integer	Количество повторных вызовов задачи пакетной службой в результате запроса пользователя. Когда пользователь удаляет вычислительные узлы из пула (путем изменения размера или сжатия пула) или при отключении задания пользователь может указать, что выполняющиеся задачи на вычислительных узлах должны быть перезапрослены для выполнения. Этот счетчик отслеживает, сколько раз задача была повторно поставлена в очередь по этим причинам.
result	TaskExecutionResult	Результат выполнения задачи. Если значение равно failed, подробные сведения о сбое можно найти в свойстве 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.