Freigeben über

Compute Node - Update User

  • Referenz
Dienst:
Batch Service
API-Version:
2024-07-01.20.0

Aktualisiert das Kennwort und die Ablaufzeit eines Benutzerkontos auf dem angegebenen Computeknoten.
Dieser Vorgang ersetzt alle aktualisierbaren Eigenschaften des Kontos. Wenn beispielsweise das "expiryTime"-Element nicht angegeben ist, wird der aktuelle Wert durch den Standardwert ersetzt, nicht unverändert bleiben. Sie können ein Benutzerkonto auf einem Computeknoten nur aktualisieren, wenn es sich im Leerlauf- oder Ausführungszustand befindet.

PUT {batchUrl}/pools/{poolId}/nodes/{nodeId}/users/{userName}?api-version=2024-07-01.20.0
Mit optionalen Parametern: 
PUT {batchUrl}/pools/{poolId}/nodes/{nodeId}/users/{userName}?timeout={timeout}&api-version=2024-07-01.20.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 aktualisieren möchten.
poolId
 path True

string

Die ID des Pools, der den Computeknoten enthält.
userName
 path True

string

Der Name des zu aktualisierenden Benutzerkontos.
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 ausgeben kann. Der Standardwert ist 30 Sekunden. Wenn der Wert größer als 30 ist, wird stattdessen der Standardwert verwendet.

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 Clientanforderungs-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 Typ Beschreibung
expiryTime

string (date-time)

Der Zeitpunkt, zu dem das Konto abläuft.
Wenn dieser Wert nicht angegeben wird, beträgt der Standardwert 1 Tag ab der aktuellen Uhrzeit. Für Linux-Computeknoten hat die Ablaufzeit bis zu einem Tag eine Genauigkeit.
password

string

Das Kennwort des Kontos.
Das Kennwort ist für Windows Compute Nodes erforderlich. Für Linux Compute Nodes kann das Kennwort optional zusammen mit der sshPublicKey-Eigenschaft angegeben werden. Wenn nicht angegeben, wird ein vorhandenes Kennwort entfernt.
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 Batchdienst die Anforderung ab; wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung). Wenn nicht angegeben, wird ein vorhandener öffentlicher SSH-Schlüssel entfernt.

Antworten

Name Typ Beschreibung
200 OK

Die Anforderung an den Batchdienst war erfolgreich.

Header

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

Der Fehler vom Batchdienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

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 update user

Beispielanforderung

PUT account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users/userName?api-version=2024-07-01.20.0



{
  "password": "12345",
  "expiryTime": "2016-11-27T00:45:48.7320857Z"
}

Beispiel für eine Antwort

Statuscode:
200

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

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

Die Gruppe der Änderungen, die an einem Benutzerkonto auf einem Computeknoten vorgenommen werden sollen.

BatchError

Objekt

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
message

ErrorMessage

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
values

BatchErrorDetail[]

Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten.

BatchErrorDetail

Objekt

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.

ErrorMessage

Objekt

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.

NodeUpdateUserParameter

Objekt

Die Gruppe der Änderungen, die an einem Benutzerkonto auf einem Computeknoten vorgenommen werden sollen.

Name Typ Beschreibung
expiryTime

string (date-time)

Der Zeitpunkt, zu dem das Konto abläuft.
Wenn dieser Wert nicht angegeben wird, beträgt der Standardwert 1 Tag ab der aktuellen Uhrzeit. Für Linux-Computeknoten hat die Ablaufzeit bis zu einem Tag eine Genauigkeit.
password

string

Das Kennwort des Kontos.
Das Kennwort ist für Windows Compute Nodes erforderlich. Für Linux Compute Nodes kann das Kennwort optional zusammen mit der sshPublicKey-Eigenschaft angegeben werden. Wenn nicht angegeben, wird ein vorhandenes Kennwort entfernt.
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 Batchdienst die Anforderung ab; wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung). Wenn nicht angegeben, wird ein vorhandener öffentlicher SSH-Schlüssel entfernt.