Compute Node - Add User

Служба:

Batch Service

Версия API:

2024-07-01.20.0

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

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

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

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?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.
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 напрямую.

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

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

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

Ответы

Имя	Тип	Описание
201 Created		Запрос к пакетной службе выполнен успешно. Заголовки client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: 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 add user

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

HTTP

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2024-07-01.20.0



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

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

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

201

Определения

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

BatchError

Object

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

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

BatchErrorDetail

Object

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

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

ComputeNodeUser

Object

Учетная запись пользователя для доступа к RDP или SSH на вычислительном узле.

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

ErrorMessage

Object

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

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