Compute Node - Add User

Service:

Batch Service

API Version:

2023-11-01.18.0

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

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

With optional parameters:

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

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

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

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

Ответы

Имя	Тип	Описание
201 Created		Запрос к пакетной службе выполнен успешно. Headers 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

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

Scopes

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

Authorization

Type: apiKey
In: header

Примеры

Node add user

Sample Request

HTTP

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2023-11-01.18.0



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

Sample Response

Status code:

201

Определения

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

BatchError

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

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

BatchErrorDetail

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

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

ComputeNodeUser

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

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

ErrorMessage

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

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