Nodes - Replace Node User

Служба:: Batch Service

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

Обновляет пароль и время истечения учётной записи пользователя на указанном вычислительном узле.
Эта операция заменяет все обновляемые свойства аккаунта. Например, если элемент expiryTime не указан, текущее значение заменяется на значение по умолчанию, а не оставляется неизмененным. Вы можете обновить пользовательскую учетную запись на вычислительном узле только в режиме простоя или работающего.

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

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

PUT {endpoint}/pools/{poolId}/nodes/{nodeId}/users/{userName}?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	Идентификатор пула, содержащего вычислительный узел.
userName	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"

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

Ответы

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

Имя

Тип

Описание

200 OK

Запрос выполнен успешно.

Заголовки

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 update user

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

HTTP

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



{
  "password": "12345",
  "expiryTime": "2025-11-27T00:45:48.7320857Z"
}

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

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

Определения

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

BatchError

Объект

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

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

BatchErrorDetail

Объект

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

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

BatchErrorMessage

Объект

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

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

BatchNodeUserUpdateOptions

Объект

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

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