Compute Node - Add User
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
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?timeout={timeout}&api-version=2023-11-01.18.0
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
batch
|
path | True |
string |
Die Basis-URL für alle Azure Batch-Dienstanforderungen. |
node
|
path | True |
string |
Die ID des Computers, auf dem Sie ein Benutzerkonto erstellen möchten. |
pool
|
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. |
|
isAdmin |
boolean |
Gibt an, ob das Konto ein Administrator auf dem Computeknoten sein soll. |
|
password |
string |
Das Kennwort des Kontos. |
|
sshPublicKey |
string |
Der öffentliche SSH-Schlüssel, der für die Remoteanmeldung beim Computeknoten verwendet werden kann. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
201 Created |
Die Anforderung an den Batch-Dienst war erfolgreich. Header
|
|
Other Status Codes |
Der Fehler vom Batch-Dienst. |
Sicherheit
azure_auth
Microsoft Entra OAuth 2.0-Authentifizierungscodeflow
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Authorization
Typ:
apiKey
In:
header
Beispiele
Node add user
Beispielanforderung
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"
}
Beispiel für eine Antwort
Definitionen
Name | Beschreibung |
---|---|
Batch |
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort. |
Batch |
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind. |
Compute |
Ein Benutzerkonto für RDP- oder SSH-Zugriff auf einen Computeknoten. |
Error |
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 |
Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
|
values |
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. |
isAdmin |
boolean |
Gibt an, ob das Konto ein Administrator auf dem Computeknoten sein soll. |
name |
string |
Der Benutzername des Kontos. |
password |
string |
Das Kennwort des Kontos. |
sshPublicKey |
string |
Der öffentliche SSH-Schlüssel, der für die Remoteanmeldung beim Computeknoten verwendet werden kann. |
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. |