Compute Node - Add User

Service:

Batch Service

API Version:

2023-11-01.18.0

Hozzáad egy felhasználói fiókot a megadott számítási csomóponthoz.
Felhasználói fiókot csak akkor adhat hozzá a számítási csomóponthoz, ha tétlen vagy futó állapotban van.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
batchUrl	path	True	string	Az összes Azure Batch szolgáltatáskérés alap URL-címe.
nodeId	path	True	string	Annak a gépnek az azonosítója, amelyen felhasználói fiókot szeretne létrehozni.
poolId	path	True	string	A számítási csomópontot tartalmazó készlet azonosítója.
api-version	query	True	string	Ügyfél API-verziója.
timeout	query		integer int32	A kérés feldolgozásának maximális időtartama másodpercben. Az alapértelmezett érték 30 mp.

Kérelem fejléce

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

Name	Kötelező	Típus	Description
client-request-id		string uuid	A hívó által generált kérési identitás, olyan GUID formátumban, amely nem rendelkezik díszítéssel, például kapcsos zárójelekkel, például 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Azt határozza meg, hogy a kiszolgálónak vissza kell-e küldenie a válaszban szereplő client-request-id azonosítót.
ocp-date		string date-time-rfc1123	A kérelem kiállításának időpontja. Az ügyfélkódtárak ezt általában az aktuális rendszeróraidőre állítják be; állítsa be explicit módon, ha a REST API-t közvetlenül hívja meg.

Kérelem törzse

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

Name	Kötelező	Típus	Description
name	True	string	A fiók felhasználóneve.
expiryTime		string	A fiók lejáratának időpontja. Ha nincs megadva, az alapértelmezett érték az aktuális időponttól számítva 1 nap. Linux számítási csomópontok esetén a expiryTime pontossága legfeljebb egy nap.
isAdmin		boolean	Azt határozza meg, hogy a fiók rendszergazda legyen-e a számítási csomóponton. Az alapértelmezett érték a hamis.
password		string	A fiók jelszava. A jelszó szükséges a Windows számítási csomópontokhoz (amelyek a "cloudServiceConfiguration" használatával jöttek létre, vagy a "virtualMachineConfiguration" használatával, Windows rendszerkép-referencia használatával). Linux számítási csomópontok esetén a jelszó megadható az sshPublicKey tulajdonsággal együtt.
sshPublicKey		string	A számítási csomópontra való távoli bejelentkezéshez használható nyilvános SSH-kulcs. A nyilvános kulcsnak kompatibilisnek kell lennie az OpenSSH-kódolással, és alapszintű 64 kódolásúnak kell lennie. Ez a tulajdonság csak Linux számítási csomópontokhoz adható meg. Ha ez egy Windows számítási csomóponthoz van megadva, akkor a Batch szolgáltatás elutasítja a kérést; Ha közvetlenül a REST API-t hívja meg, a HTTP-állapotkód 400 (hibás kérés).

Válaszok

Name	Típus	Description
201 Created		A Batch szolgáltatásnak küldött kérés sikeres volt. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	A Batch szolgáltatás hibája.

Biztonság

azure_auth

Microsoft Entra OAuth 2.0 hitelesítési kódfolyamata

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

Scopes

Name	Description
user_impersonation	A felhasználói fiók megszemélyesítése

Authorization

Type: apiKey
In: header

Példák

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

Definíciók

Name	Description
BatchError	Hibaválasz érkezett a Azure Batch szolgáltatástól.
BatchErrorDetail	Egy Azure Batch hibaválaszban szereplő további információk egy eleme.
ComputeNodeUser	Felhasználói fiók RDP- vagy SSH-hozzáféréshez egy számítási csomóponton.
ErrorMessage	Hibaüzenet érkezett egy Azure Batch hibaválaszban.

BatchError

Hibaválasz érkezett a Azure Batch szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
message	ErrorMessage	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
values	BatchErrorDetail[]	Kulcs-érték párok gyűjteménye, amely további részleteket tartalmaz a hibáról.

BatchErrorDetail

Egy Azure Batch hibaválaszban szereplő további információk egy eleme.

Name	Típus	Description
key	string	Egy azonosító, amely az Érték tulajdonság jelentését adja meg.
value	string	A hibaválaszban szereplő további információk.

ComputeNodeUser

Felhasználói fiók RDP- vagy SSH-hozzáféréshez egy számítási csomóponton.

Name	Típus	Description
expiryTime	string	A fiók lejáratának időpontja. Ha nincs megadva, az alapértelmezett érték az aktuális időponttól számítva 1 nap. Linux számítási csomópontok esetén a expiryTime pontossága legfeljebb egy nap.
isAdmin	boolean	Azt határozza meg, hogy a fiók rendszergazda legyen-e a számítási csomóponton. Az alapértelmezett érték a hamis.
name	string	A fiók felhasználóneve.
password	string	A fiók jelszava. A jelszó szükséges a Windows számítási csomópontokhoz (amelyek a "cloudServiceConfiguration" használatával jöttek létre, vagy a "virtualMachineConfiguration" használatával, Windows rendszerkép-referencia használatával). Linux számítási csomópontok esetén a jelszó megadható az sshPublicKey tulajdonsággal együtt.
sshPublicKey	string	A számítási csomópontra való távoli bejelentkezéshez használható nyilvános SSH-kulcs. A nyilvános kulcsnak kompatibilisnek kell lennie az OpenSSH-kódolással, és alapszintű 64 kódolásúnak kell lennie. Ez a tulajdonság csak Linux számítási csomópontokhoz adható meg. Ha ez egy Windows számítási csomóponthoz van megadva, akkor a Batch szolgáltatás elutasítja a kérést; Ha közvetlenül a REST API-t hívja meg, a HTTP-állapotkód 400 (hibás kérés).

ErrorMessage

Hibaüzenet érkezett egy Azure Batch hibaválaszban.

Name	Típus	Description
lang	string	A hibaüzenet nyelvkódja
value	string	Az üzenet szövege.