Compute Node - Update User

Service:

Batch Service

API Version:

2023-11-01.18.0

Aktualizacje hasło i czas wygaśnięcia konta użytkownika w określonym węźle obliczeniowym.
Ta operacja zastępuje wszystkie możliwe do zaktualizowania właściwości konta. Jeśli na przykład element expiryTime nie zostanie określony, bieżąca wartość zostanie zastąpiona wartością domyślną, a nie pozostawioną bez modyfikacji. Konto użytkownika można zaktualizować w węźle obliczeniowym tylko wtedy, gdy jest w stanie bezczynności lub uruchomienia.

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

With optional parameters:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL dla wszystkich żądań obsługi Azure Batch.
nodeId	path	True	string	Identyfikator maszyny, na której chcesz zaktualizować konto użytkownika.
poolId	path	True	string	Identyfikator puli zawierającej węzeł obliczeniowy.
userName	path	True	string	Nazwa konta użytkownika do zaktualizowania.
api-version	query	True	string	Wersja interfejsu API klienta.
timeout	query		integer int32	Maksymalny czas przetwarzania żądania przez serwer w sekundach. Wartość domyślna to 30 sekund.

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
client-request-id		string uuid	Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takich jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Określa, czy serwer powinien zwrócić wartość client-request-id w odpowiedzi.
ocp-date		string date-time-rfc1123	Czas wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżący czas zegara systemowego; ustaw go jawnie, jeśli bezpośrednio wywołujesz interfejs API REST.

Treść żądania

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

Nazwa	Typ	Opis
expiryTime	string	Czas wygaśnięcia konta. W przypadku pominięcia wartość domyślna to 1 dzień od bieżącej godziny. W przypadku węzłów obliczeniowych systemu Linux czas wygaśnięcia ma precyzję do dnia.
password	string	Hasło konta. Hasło jest wymagane dla węzłów obliczeniowych systemu Windows (utworzonych za pomocą polecenia "cloudServiceConfiguration" lub utworzonych za pomocą polecenia "virtualMachineConfiguration" przy użyciu odwołania do obrazu systemu Windows). W przypadku węzłów obliczeniowych systemu Linux można opcjonalnie określić hasło wraz z właściwością sshPublicKey. W przypadku pominięcia wszystkie istniejące hasła zostaną usunięte.
sshPublicKey	string	Klucz publiczny SSH, który może służyć do zdalnego logowania do węzła obliczeniowego. Klucz publiczny powinien być zgodny z kodowaniem OpenSSH i powinien być zakodowany w formacie Base 64. Tę właściwość można określić tylko dla węzłów obliczeniowych systemu Linux. Jeśli jest to określone dla węzła obliczeniowego systemu Windows, usługa Batch odrzuca żądanie; Jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (Nieprawidłowe żądanie). W przypadku pominięcia zostanie usunięty dowolny istniejący klucz publiczny SSH.

Odpowiedzi

Nazwa	Typ	Opis
200 OK		Żądanie do usługi Batch zakończyło się pomyślnie. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Błąd usługi Batch.

Zabezpieczenia

azure_auth

przepływ kodu uwierzytelniania OAuth 2.0 Microsoft Entra

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

Scopes

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Authorization

Type: apiKey
In: header

Przykłady

Node update user

Sample Request

HTTP

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

Sample Response

Status code:

200

Definicje

Nazwa	Opis
BatchError	Odebrano odpowiedź o błędzie z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi na błąd Azure Batch.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.
NodeUpdateUserParameter	Zestaw zmian, które mają zostać wprowadzone do konta użytkownika w węźle obliczeniowym.

BatchError

Odebrano odpowiedź o błędzie z usługi Azure Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message	ErrorMessage	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
values	BatchErrorDetail[]	Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu.

BatchErrorDetail

Element dodatkowych informacji zawartych w odpowiedzi na błąd Azure Batch.

Nazwa	Typ	Opis
key	string	Identyfikator określający znaczenie właściwości Value.
value	string	Dodatkowe informacje zawarte w odpowiedzi na błąd.

ErrorMessage

Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.

Nazwa	Typ	Opis
lang	string	Kod języka komunikatu o błędzie
value	string	Tekst wiadomości.

NodeUpdateUserParameter

Zestaw zmian, które mają zostać wprowadzone do konta użytkownika w węźle obliczeniowym.

Nazwa	Typ	Opis
expiryTime	string	Czas wygaśnięcia konta. W przypadku pominięcia wartość domyślna to 1 dzień od bieżącej godziny. W przypadku węzłów obliczeniowych systemu Linux czas wygaśnięcia ma precyzję do dnia.
password	string	Hasło konta. Hasło jest wymagane dla węzłów obliczeniowych systemu Windows (utworzonych za pomocą polecenia "cloudServiceConfiguration" lub utworzonych za pomocą polecenia "virtualMachineConfiguration" przy użyciu odwołania do obrazu systemu Windows). W przypadku węzłów obliczeniowych systemu Linux można opcjonalnie określić hasło wraz z właściwością sshPublicKey. W przypadku pominięcia wszystkie istniejące hasła zostaną usunięte.
sshPublicKey	string	Klucz publiczny SSH, który może służyć do zdalnego logowania do węzła obliczeniowego. Klucz publiczny powinien być zgodny z kodowaniem OpenSSH i powinien być zakodowany w formacie Base 64. Tę właściwość można określić tylko dla węzłów obliczeniowych systemu Linux. Jeśli jest to określone dla węzła obliczeniowego systemu Windows, usługa Batch odrzuca żądanie; Jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (Nieprawidłowe żądanie). W przypadku pominięcia zostanie usunięty dowolny istniejący klucz publiczny SSH.