Compute Node - Add User

Service:

Batch Service

API Version:

2023-11-01.18.0

Fügt dem angegebenen Computeknoten ein Benutzerkonto hinzu.
Sie können einem Computeknoten nur dann ein Benutzerkonto hinzufügen, wenn er sich im Leerlauf- oder Ausführungszustand befindet.

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
batchUrl	path	True	string	Die Basis-URL für alle Azure Batch-Dienstanforderungen.
nodeId	path	True	string	Die ID des Computers, auf dem Sie ein Benutzerkonto erstellen möchten.
poolId	path	True	string	Die ID des Pools, der den Computeknoten enthält.
api-version	query	True	string	Client-API-Version.
timeout	query		integer int32	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden aufwenden kann. Der Standardwert ist 30 Sekunden.

Anforderungsheader

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

Name	Erforderlich	Typ	Beschreibung
client-request-id		string uuid	Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Gibt an, ob der Server die client-request-ID in der Antwort zurückgeben soll.
ocp-date		string date-time-rfc1123	Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.

Anforderungstext

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

Name	Erforderlich	Typ	Beschreibung
name	True	string	Der Benutzername des Kontos.
expiryTime		string	Der Zeitpunkt, zu dem das Konto ablaufen soll. Wenn nicht angegeben, ist der Standardwert 1 Tag ab der aktuellen Uhrzeit. Für Linux-Computeknoten hat die expiryTime eine Genauigkeit von bis zu einem Tag.
isAdmin		boolean	Gibt an, ob das Konto ein Administrator auf dem Computeknoten sein soll. Der Standardwert ist „FALSE“.
password		string	Das Kennwort des Kontos. Das Kennwort ist für Windows-Computeknoten erforderlich (die mit "cloudServiceConfiguration" erstellt oder mit "virtualMachineConfiguration" mithilfe einer Windows-Imagereferenz erstellt wurden). Für Linux-Computeknoten kann das Kennwort optional zusammen mit der sshPublicKey-Eigenschaft angegeben werden.
sshPublicKey		string	Der öffentliche SSH-Schlüssel, der für die Remoteanmeldung beim Computeknoten verwendet werden kann. Der öffentliche Schlüssel sollte mit der OpenSSH-Codierung kompatibel sein und Base64-codiert sein. Diese Eigenschaft kann nur für Linux-Computeknoten angegeben werden. Wenn dies für einen Windows-Computeknoten angegeben ist, lehnt der Batch-Dienst die Anforderung ab. Wenn Sie die REST-API direkt aufrufen, ist der HTTP-status Code 400 (ungültige Anforderung).

Antworten

Name	Typ	Beschreibung
201 Created		Die Anforderung an den Batch-Dienst war erfolgreich. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Der Fehler vom Batch-Dienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodeflow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Authorization

Type: apiKey
In: header

Beispiele

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

Definitionen

Name	Beschreibung
BatchError	Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail	Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.
ComputeNodeUser	Ein Benutzerkonto für RDP- oder SSH-Zugriff auf einen Computeknoten.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde.

BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
message	ErrorMessage	Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
values	BatchErrorDetail[]	Eine Auflistung von Schlüssel-Wert-Paaren mit zusätzlichen Details zum Fehler.

BatchErrorDetail

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.

Name	Typ	Beschreibung
key	string	Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt.
value	string	Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind.

ComputeNodeUser

Ein Benutzerkonto für RDP- oder SSH-Zugriff auf einen Computeknoten.

Name	Typ	Beschreibung
expiryTime	string	Der Zeitpunkt, zu dem das Konto ablaufen soll. Wenn nicht angegeben, ist der Standardwert 1 Tag ab der aktuellen Uhrzeit. Für Linux-Computeknoten hat die expiryTime eine Genauigkeit von bis zu einem Tag.
isAdmin	boolean	Gibt an, ob das Konto ein Administrator auf dem Computeknoten sein soll. Der Standardwert ist „FALSE“.
name	string	Der Benutzername des Kontos.
password	string	Das Kennwort des Kontos. Das Kennwort ist für Windows-Computeknoten erforderlich (die mit "cloudServiceConfiguration" erstellt oder mit "virtualMachineConfiguration" mithilfe einer Windows-Imagereferenz erstellt wurden). Für Linux-Computeknoten kann das Kennwort optional zusammen mit der sshPublicKey-Eigenschaft angegeben werden.
sshPublicKey	string	Der öffentliche SSH-Schlüssel, der für die Remoteanmeldung beim Computeknoten verwendet werden kann. Der öffentliche Schlüssel sollte mit der OpenSSH-Codierung kompatibel sein und Base64-codiert sein. Diese Eigenschaft kann nur für Linux-Computeknoten angegeben werden. Wenn dies für einen Windows-Computeknoten angegeben ist, lehnt der Batch-Dienst die Anforderung ab. Wenn Sie die REST-API direkt aufrufen, ist der HTTP-status Code 400 (ungültige Anforderung).

ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde.

Name	Typ	Beschreibung
lang	string	Der Sprachcode der Fehlermeldung
value	string	Der Text der Meldung.