Pools - Enable Pool Auto Scale

Dienst:: Batch Service

API-Version:: 2025-06-01

Aktiviert die automatische Skalierung für einen Pool.
Sie können die automatische Skalierung für einen Pool nicht aktivieren, wenn ein Vorgang zum Ändern der Größe im Pool ausgeführt wird. Wenn die automatische Skalierung des Pools derzeit deaktiviert ist, müssen Sie eine gültige Autoskalenformel als Teil der Anforderung angeben. Wenn die automatische Skalierung des Pools bereits aktiviert ist, können Sie eine neue Autoskalenformel und/oder ein neues Auswertungsintervall angeben. Sie können diese API nicht für denselben Pool mehr als einmal alle 30 Sekunden aufrufen.

POST {endpoint}/pools/{poolId}/enableautoscale?api-version=2025-06-01

Mit optionalen Parametern:

POST {endpoint}/pools/{poolId}/enableautoscale?api-version=2025-06-01&timeOut={timeOut}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Batchkontoendpunkt (z. B. https://batchaccount.eastus2.batch.azure.com).
poolId	path	True	string	Die ID des abzurufenden Pools.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
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. Ist der Wert größer als 30, wird stattdessen der Standard verwendet."

Anforderungsheader

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

Name	Typ	Beschreibung
client-request-id	string	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-rfc7231)	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-Modified-Since	string (date-time-rfc7231)	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-rfc7231)	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.
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.

Anforderungstext

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

Name	Typ	Beschreibung
autoScaleEvaluationInterval	string (duration)	Das Zeitintervall, in dem die Poolgröße automatisch entsprechend der Autoskalenformel angepasst werden soll. Der Standardwert beträgt 15 Minuten. Der Mindest- und Maximalwert beträgt 5 Minuten bzw. 168 Stunden. Wenn Sie einen Wert angeben, der kleiner als 5 Minuten oder größer als 168 Stunden ist, lehnt der Batchdienst die Anforderung mit einem ungültigen Eigenschaftswertfehler ab; wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung). Wenn Sie ein neues Intervall angeben, wird der bestehende Autoskalierungsplan gestoppt und ein neuer Autoskalierungsplan gestartet, dessen Startzeit die Zeit ist, zu der diese Anfrage gestellt wurde.
autoScaleFormula	string	Die Formel für die gewünschte Anzahl von Computeknoten im Pool. Der Standardwert beträgt 15 Minuten. Der Mindest- und Maximalwert beträgt 5 Minuten bzw. 168 Stunden. Wenn Sie einen Wert angeben, der kleiner als 5 Minuten oder größer als 168 Stunden ist, lehnt der Batchdienst die Anforderung mit einem ungültigen Eigenschaftswertfehler ab; wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung). Wenn Sie ein neues Intervall angeben, wird der bestehende Autoskalierungsplan gestoppt und ein neuer Autoskalierungsplan gestartet, dessen Startzeit die Zeit ist, zu der diese Anfrage gestellt wurde.

Antworten

Name	Typ	Beschreibung
200 OK		Die Anforderung ist erfolgreich. Header DataServiceId: string ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

200 OK

Die Anforderung ist erfolgreich.

Header

DataServiceId: string
ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

Unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

Name	Beschreibung
https://batch.core.windows.net//.default

Beispiele

Pool enable autoscale

Beispielanforderung

HTTP

POST {endpoint}/pools/poolId/enableautoscale?api-version=2025-06-01



{
  "autoScaleFormula": "$TargetDedicated=0",
  "autoScaleEvaluationInterval": "PT8M"
}

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.
BatchErrorMessage	Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
BatchPoolEnableAutoScaleOptions	Parameter zum Aktivieren der automatischen Skalierung in einem Azure-Batchpool.

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

BatchErrorMessage

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.

BatchPoolEnableAutoScaleOptions

Objekt

Parameter zum Aktivieren der automatischen Skalierung in einem Azure-Batchpool.

Name	Typ	Beschreibung
autoScaleEvaluationInterval	string (duration)	Das Zeitintervall, in dem die Poolgröße automatisch entsprechend der Autoskalenformel angepasst werden soll. Der Standardwert beträgt 15 Minuten. Der Mindest- und Maximalwert beträgt 5 Minuten bzw. 168 Stunden. Wenn Sie einen Wert angeben, der kleiner als 5 Minuten oder größer als 168 Stunden ist, lehnt der Batchdienst die Anforderung mit einem ungültigen Eigenschaftswertfehler ab; wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung). Wenn Sie ein neues Intervall angeben, wird der bestehende Autoskalierungsplan gestoppt und ein neuer Autoskalierungsplan gestartet, dessen Startzeit die Zeit ist, zu der diese Anfrage gestellt wurde.
autoScaleFormula	string	Die Formel für die gewünschte Anzahl von Computeknoten im Pool. Der Standardwert beträgt 15 Minuten. Der Mindest- und Maximalwert beträgt 5 Minuten bzw. 168 Stunden. Wenn Sie einen Wert angeben, der kleiner als 5 Minuten oder größer als 168 Stunden ist, lehnt der Batchdienst die Anforderung mit einem ungültigen Eigenschaftswertfehler ab; wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung). Wenn Sie ein neues Intervall angeben, wird der bestehende Autoskalierungsplan gestoppt und ein neuer Autoskalierungsplan gestartet, dessen Startzeit die Zeit ist, zu der diese Anfrage gestellt wurde.

Freigeben über

Pools - Enable Pool Auto Scale

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

OAuth2Auth

Bereiche

Beispiele

Pool enable autoscale

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BatchError

BatchErrorDetail

BatchErrorMessage

BatchPoolEnableAutoScaleOptions