Pool - Enable Auto Scale
Aktiviert die automatische Skalierung für einen Pool.
Sie können die automatische Skalierung für einen Pool nicht aktivieren, wenn ein Größenänderungsvorgang für den Pool ausgeführt wird. Wenn die automatische Skalierung des Pools derzeit deaktiviert ist, müssen Sie eine gültige Formel für die autoskalierte Skalierung als Teil der Anforderung angeben. Wenn die automatische Skalierung des Pools bereits aktiviert ist, können Sie eine neue Formel für die autoskalierte Skalierung und/oder ein neues Auswertungsintervall angeben. Sie können diese API nicht mehr als einmal alle 30 Sekunden für denselben Pool aufrufen.
POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2023-11-01.18.0POST {batchUrl}/pools/{poolId}/enableautoscale?timeout={timeout}&api-version=2023-11-01.18.0URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
batch
|
path | True |
string |
Die Basis-URL für alle Azure Batch-Dienstanforderungen. |
|
pool
|
path | True |
string |
Die ID des Pools, für den die automatische Skalierung aktiviert werden soll. |
|
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 client-request-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 im Dienst genau 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 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 dem angegebenen Zeitpunkt 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 dem angegebenen Zeitpunkt nicht mehr geändert wurde. |
Anforderungstext
Media Types: "application/json; odata=minimalmetadata"
| Name | Typ | Beschreibung |
|---|---|---|
| autoScaleEvaluationInterval |
string |
Das Zeitintervall, in dem die Poolgröße gemäß der Formel für die autoskalierte Skalierung automatisch angepasst werden soll. |
| autoScaleFormula |
string |
Die Formel für die gewünschte Anzahl von Computeknoten im Pool. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Die Anforderung an den Batch-Dienst war erfolgreich. Headers
|
|
| Other Status Codes |
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
Pool enable autoscale
Sample Request
POST account.region.batch.azure.com/pools/poolId/enableautoscale?api-version=2023-11-01.18.0
{
"autoScaleFormula": "$TargetDedicated=0",
"autoScaleEvaluationInterval": "PT8M"
}
Sample Response
Definitionen
| Name | Beschreibung |
|---|---|
|
Batch |
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort. |
|
Batch |
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind. |
|
Error |
Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde. |
|
Pool |
Optionen zum Aktivieren der automatischen Skalierung in einem Pool. |
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 |
Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
|
| values |
Eine Auflistung von Schlüssel-Wert-Paaren mit zusätzlichen Details zum Fehler. |
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 wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| lang |
string |
Der Sprachcode der Fehlermeldung |
| value |
string |
Der Text der Meldung. |
PoolEnableAutoScaleParameter
Optionen zum Aktivieren der automatischen Skalierung in einem Pool.
| Name | Typ | Beschreibung |
|---|---|---|
| autoScaleEvaluationInterval |
string |
Das Zeitintervall, in dem die Poolgröße gemäß der Formel für die autoskalierte Skalierung automatisch angepasst werden soll. |
| autoScaleFormula |
string |
Die Formel für die gewünschte Anzahl von Computeknoten im Pool. |