Compute Node - Update User

Service:

Batch Service

API Version:

2023-11-01.18.0

Aktualizace heslo a čas vypršení platnosti uživatelského účtu na zadaném výpočetním uzlu.
Tato operace nahradí všechny aktualizovatelné vlastnosti účtu. Pokud například není zadaný prvek expiryTime, aktuální hodnota je nahrazena výchozí hodnotou, není ponechána beze změny. Uživatelský účet na výpočetním uzlu můžete aktualizovat jenom v případě, že je v nečinném nebo spuštěném stavu.

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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
batchUrl	path	True	string	Základní adresa URL pro všechny požadavky Azure Batch služby.
nodeId	path	True	string	ID počítače, na kterém chcete aktualizovat uživatelský účet.
poolId	path	True	string	ID fondu, který obsahuje výpočetní uzel.
userName	path	True	string	Název uživatelského účtu, který se má aktualizovat.
api-version	query	True	string	Verze rozhraní API klienta.
timeout	query		integer int32	Maximální doba, kterou může server strávit zpracováním požadavku( v sekundách). Výchozí hodnota je 30 sekund.

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
client-request-id		string uuid	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Určuje, jestli má server v odpovědi vrátit client-request-id.
ocp-date		string date-time-rfc1123	Čas, kdy byla žádost vydána. Klientské knihovny obvykle nastavit na aktuální systémový čas hodin; pokud voláte rozhraní REST API přímo, explicitně ho nastavte.

Text požadavku

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

Name	Typ	Description
expiryTime	string	Čas, kdy má platnost účtu vypršet. Pokud ho vynecháte, výchozí hodnota je 1 den od aktuálního času. U linuxových výpočetních uzlů má hodnota expiryTime přesnost až na den.
password	string	Heslo účtu. Heslo se vyžaduje pro výpočetní uzly Windows (vytvořené pomocí cloudServiceConfiguration nebo vytvořené pomocí virtualMachineConfiguration pomocí odkazu na image Windows). Pro výpočetní uzly s Linuxem je možné volitelně zadat heslo spolu s vlastností sshPublicKey. Pokud ho vynecháte, odeberou se všechna existující hesla.
sshPublicKey	string	Veřejný klíč SSH, který se dá použít pro vzdálené přihlášení k výpočetnímu uzlu. Veřejný klíč by měl být kompatibilní s kódováním OpenSSH a měl by mít kódování Base 64. Tuto vlastnost je možné zadat pouze pro výpočetní uzly s Linuxem. Pokud je zadána pro výpočetní uzel Systému Windows, služba Batch odmítne požadavek; Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 400 (Chybný požadavek). Pokud tento parametr vynecháte, odeberou se všechny existující veřejné klíče SSH.

Odpovědi

Name	Typ	Description
200 OK		Požadavek na službu Batch byl úspěšný. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Chyba ze služby Batch.

Zabezpečení

azure_auth

Microsoft Entra tok ověřovacího kódu OAuth 2.0

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

Scopes

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Authorization

Type: apiKey
In: header

Příklady

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

Definice

Name	Description
BatchError	Služba Azure Batch obdržela chybovou odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.
ErrorMessage	Chybová zpráva přijatá v Azure Batch chybovou odpověď.
NodeUpdateUserParameter	Sada změn, které se mají provést v uživatelském účtu na výpočetním uzlu.

BatchError

Služba Azure Batch obdržela chybovou odpověď.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou neutrální a mají být využívány programově.
message	ErrorMessage	Zpráva popisující chybu, která má být vhodná k zobrazení v uživatelském rozhraní.
values	BatchErrorDetail[]	Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.

Name	Typ	Description
key	string	Identifikátor určující význam value vlastnost.
value	string	Další informace zahrnuté v chybové odpovědi.

ErrorMessage

Chybová zpráva přijatá v Azure Batch chybovou odpověď.

Name	Typ	Description
lang	string	Kód jazyka chybové zprávy
value	string	Text zprávy

NodeUpdateUserParameter

Sada změn, které se mají provést v uživatelském účtu na výpočetním uzlu.

Name	Typ	Description
expiryTime	string	Čas, kdy má platnost účtu vypršet. Pokud ho vynecháte, výchozí hodnota je 1 den od aktuálního času. U linuxových výpočetních uzlů má hodnota expiryTime přesnost až na den.
password	string	Heslo účtu. Heslo se vyžaduje pro výpočetní uzly Windows (vytvořené pomocí cloudServiceConfiguration nebo vytvořené pomocí virtualMachineConfiguration pomocí odkazu na image Windows). Pro výpočetní uzly s Linuxem je možné volitelně zadat heslo spolu s vlastností sshPublicKey. Pokud ho vynecháte, odeberou se všechna existující hesla.
sshPublicKey	string	Veřejný klíč SSH, který se dá použít pro vzdálené přihlášení k výpočetnímu uzlu. Veřejný klíč by měl být kompatibilní s kódováním OpenSSH a měl by mít kódování Base 64. Tuto vlastnost je možné zadat pouze pro výpočetní uzly s Linuxem. Pokud je zadána pro výpočetní uzel Systému Windows, služba Batch odmítne požadavek; Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 400 (Chybný požadavek). Pokud tento parametr vynecháte, odeberou se všechny existující veřejné klíče SSH.