Nodes - Create Node User

Služba:

Batch Service

Verze rozhraní API:

2025-06-01

Přidává uživatelský účet k určenému výpočetnímu uzlu.
Uživatelský účet můžete přidat do Compute Node pouze tehdy, když je v nečinnosti nebo běžícím stavu. Než se můžete vzdáleně přihlásit do Compute Node, musíte nastavit přístupové porty pro SSH a RDP. Další informace najdete v tématu https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

POST {endpoint}/pools/{poolId}/nodes/{nodeId}/users?api-version=2025-06-01

S volitelnými parametry:

POST {endpoint}/pools/{poolId}/nodes/{nodeId}/users?api-version=2025-06-01&timeOut={timeOut}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Koncový bod účtu Batch (například: https://batchaccount.eastus2.batch.azure.com).
nodeId	path	True	string	ID zařízení, 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 minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
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	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-rfc7231)	Č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 by měl účet vypršet. Pokud je vynecháno, výchozí stav je 1 den od aktuálního času. U výpočetních uzlů Linuxu má expiryTime přesnost až jeden den.
isAdmin		boolean	Zda by měl být účet správcem na Compute Node. Výchozí hodnota je false.
password		string (password)	Heslo k účtu. Heslo je vyžadováno pro Windows Compute Nodes. Pro Linux Compute Nodes lze heslo volitelně zadat spolu s vlastností sshPublicKey.
sshPublicKey		string	Veřejný SSH klíč, který lze použít pro vzdálené přihlášení do Compute Node. Veřejný klíč by měl být kompatibilní s OpenSSH kódováním a měl by být kódován v base 64. Tato vlastnost může být specifikována pouze pro Linux Compute Nodes. Pokud je toto specifikováno pro Windows Compute Node, pak batch služba požadavek odmítne; pokud voláte přímo REST API, HTTP stavový kód je 400 (Špatný požadavek).

Odpovědi

Name	Typ	Description
201 Created		Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek. Hlavičky DataServiceId: string ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Neočekávaná chybová odpověď

Zabezpečení

OAuth2Auth

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

Rozsahy

Name	Description
https://batch.core.windows.net//.default

Příklady

Node create user

Ukázkový požadavek

HTTP

POST {endpoint}/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2025-06-01



{
  "name": "userName",
  "isAdmin": false,
  "expiryTime": "2025-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
BatchErrorMessage	V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.
BatchNodeUserCreateOptions	Parametry pro vytvoření uživatelského účtu pro přístup RDP nebo SSH na výpočetním uzlu služby Azure Batch

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	BatchErrorMessage	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.

BatchErrorMessage

Objekt

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

Name	Typ	Description
lang	string	Jazykový kód chybové zprávy.
value	string	Text zprávy.

BatchNodeUserCreateOptions

Objekt

Parametry pro vytvoření uživatelského účtu pro přístup RDP nebo SSH na výpočetním uzlu služby Azure Batch

Name	Typ	Description
expiryTime	string (date-time)	Čas, kdy by měl účet vypršet. Pokud je vynecháno, výchozí stav je 1 den od aktuálního času. U výpočetních uzlů Linuxu má expiryTime přesnost až jeden den.
isAdmin	boolean	Zda by měl být účet správcem na Compute Node. Výchozí hodnota je false.
name	string	Uživatelské jméno účtu.
password	string (password)	Heslo k účtu. Heslo je vyžadováno pro Windows Compute Nodes. Pro Linux Compute Nodes lze heslo volitelně zadat spolu s vlastností sshPublicKey.
sshPublicKey	string	Veřejný SSH klíč, který lze použít pro vzdálené přihlášení do Compute Node. Veřejný klíč by měl být kompatibilní s OpenSSH kódováním a měl by být kódován v base 64. Tato vlastnost může být specifikována pouze pro Linux Compute Nodes. Pokud je toto specifikováno pro Windows Compute Node, pak batch služba požadavek odmítne; pokud voláte přímo REST API, HTTP stavový kód je 400 (Špatný požadavek).