Compute Node - Add User

Service:

Batch Service

API Version:

2023-11-01.18.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 případě, že je v nečinném nebo spuštěném stavu.

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

With optional parameters:

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?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 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 klientského rozhraní API.
timeout	query		integer int32	Maximální čas, který 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 ozdob, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Jestli má server v odpovědi vrátit client-request-id.
ocp-date		string date-time-rfc1123	Čas, kdy byla žádost vystavena. Klientské knihovny obvykle tuto možnost nastaví na aktuální systémový čas. pokud přímo voláte rozhraní REST API, nastavte ho explicitně.

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	Čas, ke kterému má platnost účtu vypršet. Pokud je vynechán, výchozí hodnota je 1 den od aktuálního času. U výpočetních uzlů s Linuxem má hodnota expiryTime přesnost až na den.
isAdmin		boolean	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 (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.
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 tato možnost určena pro výpočetní uzel Windows, služba Batch žádost odmítne; Pokud voláte rozhraní REST API přímo, 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ý. 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 kódu ověřování 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 add user

Sample Request

HTTP

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2023-11-01.18.0



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

Sample Response

Status code:

201

Definice

Name	Description
BatchError	Ze služby Azure Batch byla přijata chybová odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch odpovědi na chybu.
ComputeNodeUser	Uživatelský účet pro přístup RDP nebo SSH na výpočetním uzlu.
ErrorMessage	Chybová zpráva přijatá v Azure Batch odpověď na chybu.

BatchError

Ze služby Azure Batch byla přijata chybová odpověď.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využívány 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

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

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

ComputeNodeUser

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

Name	Typ	Description
expiryTime	string	Čas, ke kterému má platnost účtu vypršet. Pokud je vynechán, výchozí hodnota je 1 den od aktuálního času. U výpočetních uzlů s Linuxem má hodnota expiryTime přesnost až na den.
isAdmin	boolean	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 (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.
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 tato možnost určena pro výpočetní uzel Windows, služba Batch žádost odmítne; Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 400 (chybný požadavek).

ErrorMessage

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

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