Compute Node - Reimage

Referenz

Service:: Batch Service

API Version:: 2023-11-01.18.0

Installiert das Betriebssystem auf dem angegebenen Computeknoten neu.
Sie können das Betriebssystem nur dann auf einem Computeknoten neu installieren, wenn es sich in einem Leerlauf- oder Ausführungszustand befindet. Diese API kann nur für Pools aufgerufen werden, die mit der Konfigurationseigenschaft des Clouddiensts erstellt wurden.

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/reimage?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/reimage?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 Computeknotens, den Sie neu starten 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	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. explizit festlegen, wenn Sie die REST-API direkt aufrufen.

Anforderungstext

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

Name	Typ	Beschreibung
nodeReimageOption	ComputeNodeReimageOption	Wann der Computeknoten neu zu erstellen ist und was mit derzeit ausgeführten Tasks zu tun ist. Der Standardwert ist „requeue“.

Antworten

Name	Typ	Beschreibung
202 Accepted		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.

Name

Typ

Beschreibung

202 Accepted

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 reimage

Sample Request

HTTP

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/reimage?api-version=2023-11-01.18.0



{
  "nodeReimageOption": "terminate"
}

Sample Response

Status code:: 202

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.
ComputeNodeReimageOption	Wann der Computeknoten neu zu erstellen ist und was mit derzeit ausgeführten Tasks zu tun ist.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.
NodeReimageParameter	Optionen für das erneute Erstellen eines Computeknotens.

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, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
values	BatchErrorDetail[]	Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthält.

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.