Поделиться через


Compute Node - Update User

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

PUT {batchUrl}/pools/{poolId}/nodes/{nodeId}/users/{userName}?api-version=2023-11-01.18.0
PUT {batchUrl}/pools/{poolId}/nodes/{nodeId}/users/{userName}?timeout={timeout}&api-version=2023-11-01.18.0

Параметры URI

Имя В Обязательно Тип Описание
batchUrl
path True

string

Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure.

nodeId
path True

string

Идентификатор компьютера, на котором требуется обновить учетную запись пользователя.

poolId
path True

string

Идентификатор пула, содержащего вычислительный узел.

userName
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"

Имя Тип Описание
expiryTime

string

Время истечения срока действия учетной записи.
Если этот параметр опущен, значение по умолчанию — 1 день от текущего времени. Для вычислительных узлов Linux значение expiryTime имеет точность до дня.

password

string

Пароль учетной записи.
Пароль требуется для вычислительных узлов Windows (созданных с помощью cloudServiceConfiguration или virtualMachineConfiguration с помощью ссылки на образ Windows). Для вычислительных узлов Linux при необходимости можно указать пароль вместе со свойством sshPublicKey. Если этот параметр опущен, все существующие пароли удаляются.

sshPublicKey

string

Открытый ключ SSH, который можно использовать для удаленного входа на вычислительный узел.
Открытый ключ должен быть совместим с кодировкой OpenSSH и иметь кодировку Base 64. Это свойство можно указать только для вычислительных узлов Linux. Если этот параметр указан для вычислительного узла Windows, пакетная служба отклоняет запрос; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос). Если этот параметр не указан, удаляется любой существующий открытый ключ SSH.

Ответы

Имя Тип Описание
200 OK

Запрос к пакетной службе выполнен успешно.

Заголовки

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

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

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



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

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

Определения

Имя Описание
BatchError

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

BatchErrorDetail

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

ErrorMessage

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

NodeUpdateUserParameter

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

BatchError

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

Имя Тип Описание
code

string

Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.

message

ErrorMessage

Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе.

values

BatchErrorDetail[]

Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

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

Имя Тип Описание
key

string

Идентификатор, указывающий значение свойства Value.

value

string

Дополнительные сведения, включенные в ответ об ошибке.

ErrorMessage

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

Имя Тип Описание
lang

string

Код языка сообщения об ошибке

value

string

Текст сообщения.

NodeUpdateUserParameter

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

Имя Тип Описание
expiryTime

string

Время истечения срока действия учетной записи.
Если этот параметр опущен, значение по умолчанию — 1 день от текущего времени. Для вычислительных узлов Linux значение expiryTime имеет точность до дня.

password

string

Пароль учетной записи.
Пароль требуется для вычислительных узлов Windows (созданных с помощью cloudServiceConfiguration или virtualMachineConfiguration с помощью ссылки на образ Windows). Для вычислительных узлов Linux при необходимости можно указать пароль вместе со свойством sshPublicKey. Если этот параметр опущен, все существующие пароли удаляются.

sshPublicKey

string

Открытый ключ SSH, который можно использовать для удаленного входа на вычислительный узел.
Открытый ключ должен быть совместим с кодировкой OpenSSH и иметь кодировку Base 64. Это свойство можно указать только для вычислительных узлов Linux. Если этот параметр указан для вычислительного узла Windows, пакетная служба отклоняет запрос; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос). Если этот параметр не указан, удаляется любой существующий открытый ключ SSH.