Pool - Delete

Dienst:

Batch Service

API-Version:

2024-07-01.20.0

Löscht einen Pool aus dem angegebenen Konto.
Wenn Sie anfordern, dass ein Pool gelöscht wird, treten die folgenden Aktionen auf: Der Poolstatus ist auf das Löschen festgelegt; alle laufenden Größenänderungsvorgänge im Pool werden beendet; Der Batchdienst startet die Größenänderung des Pools auf null Computeknoten; alle Aufgaben, die auf vorhandenen Computeknoten ausgeführt werden, werden beendet und erneut abgefragt (als ob ein Vorgang zur Größenänderung mit der Standardoption für die erneute Warteschlange angefordert wurde); schließlich wird der Pool aus dem System entfernt. Da die Ausführung von Aufgaben erneut abgefragt wird, kann der Benutzer diese Aufgaben erneut ausführen, indem er seinen Auftrag auf einen anderen Pool aktualisiert. Die Aufgaben können dann im neuen Pool ausgeführt werden. Wenn Sie das Verhalten der erneuten Warteschlange außer Kraft setzen möchten, sollten Sie die Größe des Pools explizit aufrufen, um die Größe des Pools auf null zu verkleinern, bevor Sie den Pool löschen. Wenn Sie eine Update-, Patch- oder Delete-API für einen Pool im Löschzustand aufrufen, schlägt sie mit dem HTTP-Statuscode 409 mit dem Fehlercode PoolBeingDeleted fehl.

DELETE {batchUrl}/pools/{poolId}?api-version=2024-07-01.20.0

Mit optionalen Parametern:

DELETE {batchUrl}/pools/{poolId}?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.
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 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.
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 exakt mit dem vom Client angegebenen Wert übereinstimmt.
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 die uhrzeit der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource für den Dienst seit dem angegebenen Zeitpunkt geändert wurde.
If-Unmodified-Since		string (date-time-rfc1123)	Ein Zeitstempel, der die uhrzeit der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource für den Dienst seit dem angegebenen Zeitpunkt nicht geändert wurde.

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung an den Batchdienst war erfolgreich. Header client-request-id: string request-id: 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

Pool delete

Beispielanforderung

HTTP

DELETE account.region.batch.azure.com/pools/poolId?api-version=2024-07-01.20.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 wurde.

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