Pools - Enable Pool Auto Scale
Hiermee schakelt u automatisch schalen voor een pool in.
U kunt automatisch schalen voor een pool niet inschakelen als er een bewerking voor het wijzigen van de grootte van de pool wordt uitgevoerd. Als automatisch schalen van de pool momenteel is uitgeschakeld, moet u een geldige formule voor automatische schaalaanpassing opgeven als onderdeel van de aanvraag. Als automatisch schalen van de pool al is ingeschakeld, kunt u een nieuwe formule voor automatische schaalaanpassing en/of een nieuw evaluatie-interval opgeven. U kunt deze API niet meer dan één keer per 30 seconden aanroepen voor dezelfde pool.
POST {endpoint}/pools/{poolId}/enableautoscale?api-version=2025-06-01POST {endpoint}/pools/{poolId}/enableautoscale?api-version=2025-06-01&timeOut={timeOut}URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Batch-accounteindpunt (bijvoorbeeld: https://batchaccount.eastus2.batch.azure.com). |
|
pool
|
path | True |
string |
De id van de pool die u wilt ophalen. |
|
api-version
|
query | True |
string minLength: 1 |
De API-versie die voor deze bewerking moet worden gebruikt. |
|
time
|
query |
integer (int32) |
De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. Als de waarde groter is dan 30, wordt de standaard in plaats daarvan gebruikt." |
Aanvraagkoptekst
Media Types: "application/json; odata=minimalmetadata"
| Name | Vereist | Type | Description |
|---|---|---|---|
| client-request-id |
string |
De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
| return-client-request-id |
boolean |
Of de server de clientaanvraag-id in het antwoord moet retourneren. |
|
| ocp-date |
string (date-time-rfc7231) |
Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; stel deze expliciet in als u de REST API rechtstreeks aanroept. |
|
| If-Modified-Since |
string (date-time-rfc7231) |
Een tijdstempel die de laatst gewijzigde tijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource op de service is gewijzigd sinds de opgegeven tijd. |
|
| If-Unmodified-Since |
string (date-time-rfc7231) |
Een tijdstempel die de laatst gewijzigde tijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource op de service niet is gewijzigd sinds de opgegeven tijd. |
|
| If-Match |
string |
Een ETag-waarde die is gekoppeld aan de versie van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de huidige ETag van de resource op de service exact overeenkomt met de waarde die is opgegeven door de client. |
|
| If-None-Match |
string |
Een ETag-waarde die is gekoppeld aan de versie van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de huidige ETag van de resource op de service niet overeenkomt met de waarde die is opgegeven door de client. |
Aanvraagbody
Media Types: "application/json; odata=minimalmetadata"
| Name | Type | Description |
|---|---|---|
| autoScaleEvaluationInterval |
string (duration) |
Het tijdsinterval waarmee de poolgrootte automatisch moet worden aangepast volgens de formule voor automatische schaalaanpassing. De standaardwaarde is 15 minuten. De minimum- en maximumwaarde zijn respectievelijk 5 minuten en 168 uur. Als u een waarde opgeeft die minder dan 5 minuten of langer is dan 168 uur, weigert de Batch-service de aanvraag met een ongeldige eigenschapswaardefout; als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag). Als je een nieuw interval specificeert, wordt het bestaande autoscale evaluatieschema gestopt en wordt een nieuw autoscale evaluatieschema gestart, waarbij het startmoment is het moment waarop dit verzoek werd ingediend. |
| autoScaleFormula |
string |
De formule voor het gewenste aantal rekenknooppunten in de pool. De standaardwaarde is 15 minuten. De minimum- en maximumwaarde zijn respectievelijk 5 minuten en 168 uur. Als u een waarde opgeeft die minder dan 5 minuten of langer is dan 168 uur, weigert de Batch-service de aanvraag met een ongeldige eigenschapswaardefout; als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag). Als je een nieuw interval specificeert, wordt het bestaande autoscale evaluatieschema gestopt en wordt een nieuw autoscale evaluatieschema gestart, waarbij het startmoment is het moment waarop dit verzoek werd ingediend. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
De aanvraag is voltooid. Kopteksten
|
|
| Other Status Codes |
Een onverwachte foutreactie. |
Beveiliging
OAuth2Auth
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Bereiken
| Name | Description |
|---|---|
| https://batch.core.windows.net//.default |
Voorbeelden
Pool enable autoscale
Voorbeeldaanvraag
POST {endpoint}/pools/poolId/enableautoscale?api-version=2025-06-01
{
"autoScaleFormula": "$TargetDedicated=0",
"autoScaleEvaluationInterval": "PT8M"
}
Voorbeeldrespons
Definities
| Name | Description |
|---|---|
|
Batch |
Er is een foutbericht ontvangen van de Azure Batch-service. |
|
Batch |
Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie. |
|
Batch |
Een foutbericht dat is ontvangen in een Azure Batch-foutreactie. |
|
Batch |
Parameters voor het inschakelen van automatisch schalen in een Azure Batch-pool. |
BatchError
Er is een foutbericht ontvangen van de Azure Batch-service.
| Name | Type | Description |
|---|---|---|
| code |
string |
Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt. |
| message |
Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface. |
|
| values |
Een verzameling sleutel-waardeparen met aanvullende informatie over de fout. |
BatchErrorDetail
Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
| Name | Type | Description |
|---|---|---|
| key |
string |
Een id die de betekenis van de eigenschap Waarde aangeeft. |
| value |
string |
De aanvullende informatie die is opgenomen in het foutbericht. |
BatchErrorMessage
Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
| Name | Type | Description |
|---|---|---|
| lang |
string |
De taalcode van het foutbericht. |
| value |
string |
De tekst van het bericht. |
BatchPoolEnableAutoScaleOptions
Parameters voor het inschakelen van automatisch schalen in een Azure Batch-pool.
| Name | Type | Description |
|---|---|---|
| autoScaleEvaluationInterval |
string (duration) |
Het tijdsinterval waarmee de poolgrootte automatisch moet worden aangepast volgens de formule voor automatische schaalaanpassing. De standaardwaarde is 15 minuten. De minimum- en maximumwaarde zijn respectievelijk 5 minuten en 168 uur. Als u een waarde opgeeft die minder dan 5 minuten of langer is dan 168 uur, weigert de Batch-service de aanvraag met een ongeldige eigenschapswaardefout; als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag). Als je een nieuw interval specificeert, wordt het bestaande autoscale evaluatieschema gestopt en wordt een nieuw autoscale evaluatieschema gestart, waarbij het startmoment is het moment waarop dit verzoek werd ingediend. |
| autoScaleFormula |
string |
De formule voor het gewenste aantal rekenknooppunten in de pool. De standaardwaarde is 15 minuten. De minimum- en maximumwaarde zijn respectievelijk 5 minuten en 168 uur. Als u een waarde opgeeft die minder dan 5 minuten of langer is dan 168 uur, weigert de Batch-service de aanvraag met een ongeldige eigenschapswaardefout; als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag). Als je een nieuw interval specificeert, wordt het bestaande autoscale evaluatieschema gestopt en wordt een nieuw autoscale evaluatieschema gestart, waarbij het startmoment is het moment waarop dit verzoek werd ingediend. |