Udostępnij przez

Nodes - Replace Node User

Usługa:
Batch Service
Wersja interfejsu API:
2025-06-01

Aktualizuje hasło i czas wygaśnięcia konta użytkownika na określonym węźle Compute.
Ta operacja zastępuje wszystkie właściwości aktualizowalne Konta. Na przykład, jeśli element expiryTime nie jest określony, aktualna wartość jest zastępowana wartością domyślną, a nie pozostawiana bez zmian. Konto użytkownika na węźle obliczeniowym można aktualizować tylko wtedy, gdy jest ono w stanie bezczynności lub w trybie działania.

PUT {endpoint}/pools/{poolId}/nodes/{nodeId}/users/{userName}?api-version=2025-06-01
Z parametrami opcjonalnymi: 
PUT {endpoint}/pools/{poolId}/nodes/{nodeId}/users/{userName}?api-version=2025-06-01&timeOut={timeOut}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpoint
 path True

string (uri)

Punkt końcowy konta usługi Batch (na przykład: https://batchaccount.eastus2.batch.azure.com).
nodeId
 path True

string

ID 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 aktualizacji.
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.
timeOut
 query

integer (int32)

Maksymalny czas przetwarzania żądania przez serwer w sekundach. Wartość domyślna to 30 sekund. Jeśli wartość jest większa niż 30, zostanie użyta domyślna wersja domyślna.".

Nagłówek żądania

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

Nazwa Wymagane Typ Opis
client-request-id

string

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ć identyfikator żądania klienta w odpowiedzi.
ocp-date

string (date-time-rfc7231)

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 (date-time)

Czas, w którym konto powinno wygasnąć. Jeśli zostanie pominięte, domyślna jest 1 dzień od obecnej godziny. Dla węzłów obliczeniowych Linuksa czas wypażenia ma precyzję do jednego dnia.
password

string (password)

Hasło do konta. Hasło jest wymagane dla węzłów obliczeniowych Windows. Dla węzłów obliczeniowych Linuksa hasło może być opcjonalnie określone wraz z właściwością sshPublicKey. Jeśli zostanie pominięte, każde istniejące hasło zostaje usunięte.
sshPublicKey

string

Klucz publiczny SSH, który może być używany do zdalnego logowania do węzła obliczeniowego. Klucz publiczny powinien być kompatybilny z kodowaniem OpenSSH i powinien być zakodowany w bazie 64. Ta właściwość może być określona tylko dla węzłów obliczeniowych Linuksa. Jeśli jest to określone dla węzła obliczeniowego Windows, usługa Batch odrzuca żądanie; jeśli wywołujesz bezpośrednio REST API, kod statusu HTTP to 400 (Bad Request). Jeśli zostanie pominięty, każdy istniejący klucz publiczny SSH zostaje usunięty.

Odpowiedzi

Nazwa Typ Opis
200 OK

Żądanie zakończyło się pomyślnie.

Nagłówki

  • DataServiceId: string
  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresy

Nazwa Opis
https://batch.core.windows.net//.default

Przykłady

Node update user

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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 usługi Azure Batch.
BatchErrorMessage

Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.
BatchNodeUserUpdateOptions

Parametry aktualizowania konta użytkownika na potrzeby dostępu RDP lub SSH w węźle obliczeniowym usługi Azure Batch.

BatchError

Objekt

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

BatchErrorMessage

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

Objekt

Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi 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.

BatchErrorMessage

Objekt

Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.

Nazwa Typ Opis
lang

string

Kod językowy komunikatu o błędzie.
value

string

Tekst wiadomości.

BatchNodeUserUpdateOptions

Objekt

Parametry aktualizowania konta użytkownika na potrzeby dostępu RDP lub SSH w węźle obliczeniowym usługi Azure Batch.

Nazwa Typ Opis
expiryTime

string (date-time)

Czas, w którym konto powinno wygasnąć. Jeśli zostanie pominięte, domyślna jest 1 dzień od obecnej godziny. Dla węzłów obliczeniowych Linuksa czas wypażenia ma precyzję do jednego dnia.
password

string (password)

Hasło do konta. Hasło jest wymagane dla węzłów obliczeniowych Windows. Dla węzłów obliczeniowych Linuksa hasło może być opcjonalnie określone wraz z właściwością sshPublicKey. Jeśli zostanie pominięte, każde istniejące hasło zostaje usunięte.
sshPublicKey

string

Klucz publiczny SSH, który może być używany do zdalnego logowania do węzła obliczeniowego. Klucz publiczny powinien być kompatybilny z kodowaniem OpenSSH i powinien być zakodowany w bazie 64. Ta właściwość może być określona tylko dla węzłów obliczeniowych Linuksa. Jeśli jest to określone dla węzła obliczeniowego Windows, usługa Batch odrzuca żądanie; jeśli wywołujesz bezpośrednio REST API, kod statusu HTTP to 400 (Bad Request). Jeśli zostanie pominięty, każdy istniejący klucz publiczny SSH zostaje usunięty.