Pools - Enable Pool Auto Scale

Tjänst:

Batch Service

API-version:

2025-06-01

Aktiverar automatisk skalning för en pool.
Du kan inte aktivera automatisk skalning på en pool om en storleksändring pågår i poolen. Om automatisk skalning av poolen för närvarande är inaktiverad måste du ange en giltig autoskalningsformel som en del av begäran. Om automatisk skalning av poolen redan är aktiverad kan du ange en ny autoskalningsformel och/eller ett nytt utvärderingsintervall. Du kan inte anropa det här API:et för samma pool mer än en gång var 30:e sekund.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Batch-kontoslutpunkt (till exempel: https://batchaccount.eastus2.batch.azure.com).
poolId	path	True	string	ID:t för poolen som ska hämtas.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
timeOut	query		integer (int32)	Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder. Om värdet är större än 30 används standardvärdet istället."

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
client-request-id		string	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Om servern ska returnera klient-request-id i svaret.
ocp-date		string (date-time-rfc7231)	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det explicit om du anropar REST-API:et direkt.
If-Modified-Since		string (date-time-rfc7231)	En tidsstämpel som anger den senaste ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen i tjänsten har ändrats sedan den angivna tiden.
If-Unmodified-Since		string (date-time-rfc7231)	En tidsstämpel som anger den senaste ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen på tjänsten inte har ändrats sedan den angivna tiden.
If-Match		string	Ett ETag-värde som är associerat med den version av resursen som är känd för klienten. Åtgärden utförs endast om resursens aktuella ETag på tjänsten exakt matchar det värde som anges av klienten.
If-None-Match		string	Ett ETag-värde som är associerat med den version av resursen som är känd för klienten. Åtgärden utförs endast om resursens aktuella ETag på tjänsten inte matchar det värde som anges av klienten.

Begärandetext

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

Name	Typ	Description
autoScaleEvaluationInterval	string (duration)	Tidsintervallet då poolstorleken ska justeras automatiskt enligt autoskalningsformeln. Standardvärdet är 15 minuter. Det lägsta och högsta värdet är 5 minuter respektive 168 timmar. Om du anger ett värde som är mindre än 5 minuter eller större än 168 timmar avvisar Batch-tjänsten begäran med ett ogiltigt egenskapsvärdefel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran). Om du anger ett nytt intervall kommer det befintliga autoskaleringsutvärderingsschemat att stoppas och ett nytt autoskaleringsschema startas, där dess starttid är den tid då denna begäran skickades ut.
autoScaleFormula	string	Formeln för önskat antal beräkningsnoder i poolen. Standardvärdet är 15 minuter. Det lägsta och högsta värdet är 5 minuter respektive 168 timmar. Om du anger ett värde som är mindre än 5 minuter eller större än 168 timmar avvisar Batch-tjänsten begäran med ett ogiltigt egenskapsvärdefel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran). Om du anger ett nytt intervall kommer det befintliga autoskaleringsutvärderingsschemat att stoppas och ett nytt autoskaleringsschema startas, där dess starttid är den tid då denna begäran skickades ut.

Svar

Name	Typ	Description
200 OK		Begäran har slutförts. Sidhuvuden DataServiceId: string ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Ett oväntat felsvar.

Säkerhet

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

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

Exempel

Pool enable autoscale

Exempelbegäran

HTTP

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



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

Exempelsvar

Statuskod:

200

Definitioner

Name	Description
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.
BatchErrorMessage	Ett felmeddelande som togs emot i ett Azure Batch-felsvar.
BatchPoolEnableAutoScaleOptions	Parametrar för att aktivera automatisk skalning på en Azure Batch-pool.

BatchError

Objekt

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	BatchErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Objekt

Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.

Name	Typ	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

BatchErrorMessage

Objekt

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.

Name	Typ	Description
lang	string	Felmeddelandets språkkod.
value	string	Texten i meddelandet.

BatchPoolEnableAutoScaleOptions

Objekt

Parametrar för att aktivera automatisk skalning på en Azure Batch-pool.

Name	Typ	Description
autoScaleEvaluationInterval	string (duration)	Tidsintervallet då poolstorleken ska justeras automatiskt enligt autoskalningsformeln. Standardvärdet är 15 minuter. Det lägsta och högsta värdet är 5 minuter respektive 168 timmar. Om du anger ett värde som är mindre än 5 minuter eller större än 168 timmar avvisar Batch-tjänsten begäran med ett ogiltigt egenskapsvärdefel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran). Om du anger ett nytt intervall kommer det befintliga autoskaleringsutvärderingsschemat att stoppas och ett nytt autoskaleringsschema startas, där dess starttid är den tid då denna begäran skickades ut.
autoScaleFormula	string	Formeln för önskat antal beräkningsnoder i poolen. Standardvärdet är 15 minuter. Det lägsta och högsta värdet är 5 minuter respektive 168 timmar. Om du anger ett värde som är mindre än 5 minuter eller större än 168 timmar avvisar Batch-tjänsten begäran med ett ogiltigt egenskapsvärdefel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran). Om du anger ett nytt intervall kommer det befintliga autoskaleringsutvärderingsschemat att stoppas och ett nytt autoskaleringsschema startas, där dess starttid är den tid då denna begäran skickades ut.