Pool - Delete

Dienst:

Batch Service

API-Version:

2023-11-01.18.0

Löscht einen Pool aus dem angegebenen Konto.
Wenn Sie die Löschung eines Pools anfordern, werden die folgenden Aktionen ausgeführt: Der Poolstatus ist auf Löschen festgelegt. alle laufenden Größenänderungen für den Pool werden beendet. der Batch-Dienst beginnt, die Größe des Pools auf 0 Computeknoten zu ändern. alle Aufgaben, die auf vorhandenen Computeknoten ausgeführt werden, werden beendet und erneut in die Warteschlange gestellt (als ob ein Pooländerungsvorgang mit der Standardoption "Requeue" angefordert wurde); schließlich wird der Pool aus dem System entfernt. Da ausgeführte Tasks erneut in die Warteschlange gestellt werden, kann der Benutzer diese Aufgaben erneut ausführen, indem er seinen Auftrag aktualisiert, um einen anderen Pool als Ziel zu verwenden. Die Tasks können dann im neuen Pool ausgeführt werden. Wenn Sie das Queue-Verhalten überschreiben möchten, sollten Sie den Pool explizit ändern, um den Pool vor dem Löschen des Pools auf null zu verkleinern. Wenn Sie eine Update-, Patch- oder Delete-API für einen Pool im löschenden Zustand aufrufen, schlägt dies mit HTTP-status Code 409 mit dem Fehlercode PoolBeingDeleted fehl.

DELETE {batchUrl}/pools/{poolId}?api-version=2023-11-01.18.0

Mit optionalen Parametern:

DELETE {batchUrl}/pools/{poolId}?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.
poolId	path	True	string	Die ID des zu löschenden Pools.
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 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.
If-Match		string	Ein ETag-Wert, der der Version der Ressource zugeordnet ist, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn das aktuelle ETag der Ressource für den Dienst genau dem vom Client angegebenen Wert entspricht.
If-None-Match		string	Ein ETag-Wert, der der Version der Ressource zugeordnet ist, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn das aktuelle ETag der Ressource für den Dienst nicht mit dem vom Client angegebenen Wert übereinstimmt.
If-Modified-Since		string date-time-rfc1123	Ein Zeitstempel, der den Zeitpunkt der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource im Dienst seit der angegebenen Zeit geändert wurde.
If-Unmodified-Since		string date-time-rfc1123	Ein Zeitstempel, der den Zeitpunkt der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource im Dienst seit der angegebenen Zeit nicht mehr geändert wurde.

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung an den Batch-Dienst war erfolgreich. Header client-request-id: string request-id: string
Other Status Codes	BatchError	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

Pool delete

Beispielanforderung

HTTP

DELETE account.region.batch.azure.com/pools/poolId?api-version=2023-11-01.18.0

Beispiel für eine Antwort

Statuscode:

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.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.

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.

ErrorMessage

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

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