Compute Node - Update User

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ą niezmodyfikowaną. 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=2022-01-01.15.0
PUT {batchUrl}/pools/{poolId}/nodes/{nodeId}/users/{userName}?timeout={timeout}&api-version=2022-01-01.15.0

Parametry identyfikatora URI

Name In Required Type Description
batchUrl
path True
  • string

Podstawowy adres URL wszystkich żądań obsługi Azure Batch.

nodeId
path True
  • string

Identyfikator komputera, na którym 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, który serwer może poświęcić na przetwarzanie żądania w sekundach. Wartość domyślna to 30 sekund.

Nagłówek żądania

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

Name Required Type Description
client-request-id
  • string
uuid

Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id
  • boolean

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"

Name Type Description
expiryTime
  • string

Czas wygaśnięcia konta.
Jeśli pominięto, wartość domyślna to 1 dzień od bieżącej godziny. W przypadku węzłów obliczeniowych systemu Linux wygaśnięcieTime ma precyzję do dnia.

password
  • string

Hasło konta.
Hasło jest wymagane dla węzłów obliczeniowych systemu Windows (utworzonych przy użyciu polecenia "cloudServiceConfiguration" lub utworzonego za pomocą polecenia "virtualMachineConfiguration" przy użyciu odwołania do obrazu systemu Windows). W przypadku węzłów obliczeniowych systemu Linux hasło można opcjonalnie określić wraz z właściwością sshPublicKey. Jeśli pominięto, 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). Jeśli pominięto, zostanie usunięty dowolny istniejący klucz publiczny SSH.

Odpowiedzi

Name Type Description
200 OK

Żądanie 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

Błąd usługi Batch.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Name Description
user_impersonation Personifikuj konto użytkownika

Authorization

Type: apiKey
In: header

Przykłady

Node update user

Sample Request

PUT account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users/userName?api-version=2022-01-01.15.0



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

Sample Response

Definicje

BatchError

Odpowiedź o błędzie odebrana z usługi Azure Batch.

BatchErrorDetail

Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu.

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

Odpowiedź o błędzie odebrana z usługi Azure Batch.

Name Type Description
code
  • string

Identyfikator błędu. Kody są niezmienne i mają być używane programowo.

message

Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

values

Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu.

BatchErrorDetail

Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu.

Name Type Description
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.

Name Type Description
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.

Name Type Description
expiryTime
  • string

Czas wygaśnięcia konta.
Jeśli pominięto, wartość domyślna to 1 dzień od bieżącej godziny. W przypadku węzłów obliczeniowych systemu Linux wygaśnięcieTime ma precyzję do dnia.

password
  • string

Hasło konta.
Hasło jest wymagane dla węzłów obliczeniowych systemu Windows (utworzonych przy użyciu polecenia "cloudServiceConfiguration" lub utworzonego za pomocą polecenia "virtualMachineConfiguration" przy użyciu odwołania do obrazu systemu Windows). W przypadku węzłów obliczeniowych systemu Linux hasło można opcjonalnie określić wraz z właściwością sshPublicKey. Jeśli pominięto, 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). Jeśli pominięto, zostanie usunięty dowolny istniejący klucz publiczny SSH.