Nodes - Create Node User

Служба:: Batch Service

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

Добавляет пользовательскую учётную запись к указанному вычислительному узлу.
Вы можете добавить пользовательскую учётную запись в вычислительный узел только в режиме простоя или в режиме запуска. Прежде чем удалённо войти в Compute Node, нужно настроить порты доступа для SSH и RDP. Дополнительные сведения см. по ссылке https://learn.microsoft.com/azure/batch/pool-endpoint-configuration.

POST {endpoint}/pools/{poolId}/nodes/{nodeId}/users?api-version=2025-06-01

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

POST {endpoint}/pools/{poolId}/nodes/{nodeId}/users?api-version=2025-06-01&timeOut={timeOut}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка учетной записи пакетной службы (например, https://batchaccount.eastus2.batch.azure.com).
nodeId	path	True	string	ID машины, на которой вы хотите создать учетную запись пользователя.
poolId	path	True	string	Идентификатор пула, содержащего вычислительный узел.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
timeOut	query		integer (int32)	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение превышает 30, вместо этого используется стандартное значение.".

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

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

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

Текст запроса

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

Имя	Обязательно	Тип	Описание
name	True	string	Имя пользователя аккаунта.
expiryTime		string (date-time)	Время, в которое должен истечь срок действия аккаунта. Если опущено, по умолчанию — 1 день с текущего времени. Для вычислительных узлов Linux срок действия достигает точности до суток.
isAdmin		boolean	Должен ли аккаунт быть администратором на вычислительном узле. По умолчанию используется значение false.
password		string (password)	Пароль от аккаунта. Пароль необходим для вычислительных узлов Windows. Для вычислительных узлов Linux пароль может быть указан по желанию вместе с свойством sshPublicKey.
sshPublicKey		string	SSH-открытый ключ, который можно использовать для удалённого входа в вычислительный узел. Публичный ключ должен быть совместим с кодированием OpenSSH и кодироваться по базе 64. Это свойство можно задать только для вычислительных узлов Linux. Если это указано для вычислительного узла Windows, то пакетная служба отклоняет запрос; если вы вызываете REST API напрямую, HTTP-код статуса — 400 (Плохой запрос).

Ответы

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

Имя

Тип

Описание

201 Created

Запрос успешно выполнен, и в результате был создан новый ресурс.

Заголовки

DataServiceId: string
ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

Непредвиденное сообщение об ошибке.

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

OAuth2Auth

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

Области

Имя	Описание
https://batch.core.windows.net//.default

Примеры

Node create user

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

HTTP

POST {endpoint}/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2025-06-01



{
  "name": "userName",
  "isAdmin": false,
  "expiryTime": "2025-08-01T00:00:00Z",
  "password": "Password"
}

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

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

Определения

Имя	Описание
BatchError	Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
BatchErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
BatchNodeUserCreateOptions	Параметры для создания учетной записи пользователя для доступа RDP или SSH на вычислительном узле пакетной службы Azure.

BatchError

Объект

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

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

BatchErrorDetail

Объект

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

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

BatchErrorMessage

Объект

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

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

BatchNodeUserCreateOptions

Объект

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

Имя	Тип	Описание
expiryTime	string (date-time)	Время, в которое должен истечь срок действия аккаунта. Если опущено, по умолчанию — 1 день с текущего времени. Для вычислительных узлов Linux срок действия достигает точности до суток.
isAdmin	boolean	Должен ли аккаунт быть администратором на вычислительном узле. По умолчанию используется значение false.
name	string	Имя пользователя аккаунта.
password	string (password)	Пароль от аккаунта. Пароль необходим для вычислительных узлов Windows. Для вычислительных узлов Linux пароль может быть указан по желанию вместе с свойством sshPublicKey.
sshPublicKey	string	SSH-открытый ключ, который можно использовать для удалённого входа в вычислительный узел. Публичный ключ должен быть совместим с кодированием OpenSSH и кодироваться по базе 64. Это свойство можно задать только для вычислительных узлов Linux. Если это указано для вычислительного узла Windows, то пакетная служба отклоняет запрос; если вы вызываете REST API напрямую, HTTP-код статуса — 400 (Плохой запрос).