Compute Node - Add User

Tjänst:

Batch Service

API-version:

2024-07-01.20.0

Lägger till ett användarkonto i den angivna beräkningsnoden.
Du kan bara lägga till ett användarkonto i en beräkningsnod när den är i inaktivt eller körs-tillstånd.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch-tjänstbegäranden.
nodeId	path	True	string	ID:t för den dator där du vill skapa ett användarkonto.
poolId	path	True	string	ID:t för poolen som innehåller beräkningsnoden.
api-version	query	True	string	Klient-API-version.
timeout	query		integer (int32)	Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder. Om värdet är större än 30 används standardvärdet i stället.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
client-request-id		string (uuid)	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Om servern ska returnera klient-request-id i svaret.
ocp-date		string (date-time-rfc1123)	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det explicit om du anropar REST-API:et direkt.

Begärandetext

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

Name	Obligatorisk	Typ	Description
name	True	string	Användarnamnet för kontot.
expiryTime		string (date-time)	Den tid då kontot ska upphöra att gälla. Om det utelämnas är standardvärdet 1 dag från den aktuella tiden. För Linux-beräkningsnoder har expiryTime en precision på upp till en dag.
isAdmin		boolean	Om kontot ska vara administratör på beräkningsnoden. Standardvärdet är falskt.
password		string	Lösenordet för kontot. Lösenordet krävs för Windows Compute-noder. För Linux-beräkningsnoder kan lösenordet anges tillsammans med egenskapen sshPublicKey.
sshPublicKey		string	Den offentliga SSH-nyckeln som kan användas för fjärrinloggning till beräkningsnoden. Den offentliga nyckeln ska vara kompatibel med OpenSSH-kodning och ska vara base 64-kodad. Den här egenskapen kan endast anges för Linux-beräkningsnoder. Om detta anges för en Windows-beräkningsnod avvisar Batch-tjänsten begäran. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran).

Svar

Name	Typ	Description
201 Created		Begäran till Batch-tjänsten lyckades. Sidhuvuden client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Felet från Batch-tjänsten.

Säkerhet

azure_auth

Autentiseringskodflöde för Microsoft Entra OAuth 2.0

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Typ: apiKey
I: header

Exempel

Node add user

Exempelbegäran

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"
}

Exempelsvar

Statuskod:

201

Definitioner

Name	Description
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.
ComputeNodeUser	Ett användarkonto för RDP- eller SSH-åtkomst på en beräkningsnod.
ErrorMessage	Ett felmeddelande som togs emot i ett Azure Batch-felsvar.

BatchError

Objekt

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Objekt

Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.

Name	Typ	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

ComputeNodeUser

Objekt

Ett användarkonto för RDP- eller SSH-åtkomst på en beräkningsnod.

Name	Typ	Description
expiryTime	string (date-time)	Den tid då kontot ska upphöra att gälla. Om det utelämnas är standardvärdet 1 dag från den aktuella tiden. För Linux-beräkningsnoder har expiryTime en precision på upp till en dag.
isAdmin	boolean	Om kontot ska vara administratör på beräkningsnoden. Standardvärdet är falskt.
name	string	Användarnamnet för kontot.
password	string	Lösenordet för kontot. Lösenordet krävs för Windows Compute-noder. För Linux-beräkningsnoder kan lösenordet anges tillsammans med egenskapen sshPublicKey.
sshPublicKey	string	Den offentliga SSH-nyckeln som kan användas för fjärrinloggning till beräkningsnoden. Den offentliga nyckeln ska vara kompatibel med OpenSSH-kodning och ska vara base 64-kodad. Den här egenskapen kan endast anges för Linux-beräkningsnoder. Om detta anges för en Windows-beräkningsnod avvisar Batch-tjänsten begäran. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran).

ErrorMessage

Objekt

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.

Name	Typ	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.