Compute Node - Add User

Služba:

Batch Service

Verze rozhraní API:

2024-07-01.20.0

Přidá uživatelský účet do zadaného výpočetního uzlu.
Uživatelský účet můžete přidat do výpočetního uzlu jenom v nečinném nebo spuštěném stavu.

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?api-version=2024-07-01.20.0

S volitelnými parametry:

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?timeout={timeout}&api-version=2024-07-01.20.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 služby Azure Batch.
nodeId	path	True	string	ID počítače, na kterém chcete vytvořit uživatelský účet.
poolId	path	True	string	ID fondu, který obsahuje výpočetní uzel.
api-version	query	True	string	Verze rozhraní API klienta.
timeout	query		integer (int32)	Maximální doba, po kterou může server strávit zpracováním požadavku v sekundách. Výchozí hodnota je 30 sekund. Pokud je hodnota větší než 30, použije se výchozí hodnota.

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, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Určuje, jestli má server v odpovědi vrátit ID požadavku klienta.
ocp-date		string (date-time-rfc1123)	Čas vydání žádosti. Klientské knihovny obvykle nastavily aktuální systémový čas; explicitně ji nastavte, pokud voláte přímo rozhraní REST API.

Text požadavku

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

Name	Vyžadováno	Typ	Description
name	True	string	Uživatelské jméno účtu.
expiryTime		string (date-time)	Čas, kdy má platnost účtu vypršet. Pokud tento argument vynecháte, výchozí hodnota je 1 den od aktuálního času. U výpočetních uzlů s Linuxem má doba vypršení platnosti přesnost až na den.
isAdmin		boolean	Určuje, jestli má být účet správcem výpočetního uzlu. Výchozí hodnota je false.
password		string	Heslo účtu. Heslo se vyžaduje pro výpočetní uzly Windows. Pro výpočetní uzly Linuxu je možné volitelně zadat heslo spolu s vlastností sshPublicKey.
sshPublicKey		string	Veřejný klíč SSH, který lze 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 Linuxu. Pokud je zadán pro výpočetní uzel Windows, služba Batch žádost odmítne; Pokud voláte přímo rozhraní REST API, stavový kód HTTP je 400 (chybný požadavek).

Odpovědi

Name	Typ	Description
201 Created		Požadavek na službu Batch byl úspěšný. Hlavičky 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

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

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Authorization

Typ: apiKey
V: header

Příklady

Node add user

Ukázkový požadavek

HTTP

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2024-07-01.20.0



{
  "name": "userName",
  "isAdmin": false,
  "expiryTime": "2017-08-01T00:00:00Z",
  "password": "Password"
}

Ukázková odpověď

Stavový kód:

201

Definice

Name	Description
BatchError	Odpověď na chybu přijatá ze služby Azure Batch
BatchErrorDetail	Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch
ComputeNodeUser	Uživatelský účet pro přístup RDP nebo SSH na výpočetním uzlu
ErrorMessage	V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.

BatchError

Objekt

Odpověď na chybu přijatá ze služby Azure Batch

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

BatchErrorDetail

Objekt

Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch

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

ComputeNodeUser

Objekt

Uživatelský účet pro přístup RDP nebo SSH na výpočetním uzlu

Name	Typ	Description
expiryTime	string (date-time)	Čas, kdy má platnost účtu vypršet. Pokud tento argument vynecháte, výchozí hodnota je 1 den od aktuálního času. U výpočetních uzlů s Linuxem má doba vypršení platnosti přesnost až na den.
isAdmin	boolean	Určuje, jestli má být účet správcem výpočetního uzlu. Výchozí hodnota je false.
name	string	Uživatelské jméno účtu.
password	string	Heslo účtu. Heslo se vyžaduje pro výpočetní uzly Windows. Pro výpočetní uzly Linuxu je možné volitelně zadat heslo spolu s vlastností sshPublicKey.
sshPublicKey	string	Veřejný klíč SSH, který lze 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 Linuxu. Pokud je zadán pro výpočetní uzel Windows, služba Batch žádost odmítne; Pokud voláte přímo rozhraní REST API, stavový kód HTTP je 400 (chybný požadavek).

ErrorMessage

Objekt

V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.

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