Megosztás a következőn keresztül:

Pool - Enable Auto Scale

  • Referencia
Szolgáltatás:
Batch Service
API-verzió:
2024-07-01.20.0

Engedélyezi a készlet automatikus skálázását.
Ha a készleten átméretezési művelet van folyamatban, nem engedélyezheti az automatikus skálázást a készleten. Ha a készlet automatikus méretezése jelenleg le van tiltva, a kérés részeként meg kell adnia egy érvényes automatikus méretezési képletet. Ha a készlet automatikus méretezése már engedélyezve van, megadhat egy új automatikus skálázási képletet és/vagy egy új kiértékelési időközt. Ezt az API-t nem hívhatja meg 30 másodpercenként többször ugyanarra a készletre.

POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2024-07-01.20.0
Opcionális paraméterekkel: 
POST {batchUrl}/pools/{poolId}/enableautoscale?timeout={timeout}&api-version=2024-07-01.20.0

URI-paraméterek

Name In Kötelező Típus Description
batchUrl
 path True

string

Az Összes Azure Batch-szolgáltatáskérés alap URL-címe.
poolId
 path True

string

Annak a készletnek az azonosítója, amelyen engedélyezni szeretné az automatikus skálázást.
api-version
 query True

string

Ügyfél API-verziója.
timeout
 query

integer

int32

A kiszolgáló által a kérés feldolgozásának maximális időtartama másodpercben. Az alapértelmezett érték 30 másodperc. Ha az érték nagyobb, mint 30, akkor a rendszer az alapértelmezett értéket használja.

Kérelem fejléce

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

Name Kötelező Típus Description
client-request-id

string

uuid

A hívó által generált kérési identitás guid formában, díszítés nélkül, például kapcsos zárójelek, például 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Azt jelzi, hogy a kiszolgálónak vissza kell-e adnia az ügyfél-kérelem azonosítóját a válaszban.
ocp-date

string

date-time-rfc1123

A kérelem kiállításának időpontja. Az ügyfélkódtárak ezt általában az aktuális rendszeróra-időpontra állítják be; állítsa be explicit módon, ha közvetlenül a REST API-t hívja meg.
If-Match

string

Az ügyfél által ismert erőforrás verziójához társított ETag-érték. A művelet csak akkor lesz végrehajtva, ha az erőforrás aktuális ETagje a szolgáltatásban pontosan megegyezik az ügyfél által megadott értékkel.
If-None-Match

string

Az ügyfél által ismert erőforrás verziójához társított ETag-érték. A művelet csak akkor lesz végrehajtva, ha az erőforrás aktuális ETagje a szolgáltatásban nem egyezik meg az ügyfél által megadott értékkel.
If-Modified-Since

string

date-time-rfc1123

Az ügyfél által ismert erőforrás utolsó módosítási idejét jelző időbélyeg. A művelet csak akkor lesz végrehajtva, ha a szolgáltatásban lévő erőforrás a megadott időpont óta módosult.
If-Unmodified-Since

string

date-time-rfc1123

Az ügyfél által ismert erőforrás utolsó módosítási idejét jelző időbélyeg. A művelet csak akkor lesz végrehajtva, ha a szolgáltatásban lévő erőforrás a megadott időpont óta nem módosult.

Kérelem törzse

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

Name Típus Description
autoScaleEvaluationInterval

string

Az az időintervallum, amellyel automatikusan módosíthatja a készlet méretét az automatikus skálázási képletnek megfelelően.
Az alapértelmezett érték 15 perc. A minimális és a maximális érték 5 perc, illetve 168 óra. Ha 5 percnél rövidebb vagy 168 óránál hosszabb értéket ad meg, a Batch szolgáltatás érvénytelen tulajdonságérték-hibával utasítja el a kérelmet; ha közvetlenül a REST API-t hívja meg, a HTTP-állapotkód 400 (hibás kérés). Ha új időközt ad meg, a rendszer leállítja a meglévő automatikus skálázási kiértékelési ütemezést, és elindít egy új automatikus skálázási kiértékelési ütemezést, amelynek kezdő időpontja a kérés kiadásának időpontja.
autoScaleFormula

string

A készletben lévő számítási csomópontok kívánt számának képlete.
A rendszer ellenőrzi a képlet érvényességét, mielőtt alkalmazva lenne a készletre. Ha a képlet érvénytelen, a Batch szolgáltatás elutasítja a kérelmet részletes hibainformációkkal. A képlet megadásáról további információt a "Számítási csomópontok automatikus méretezése az Azure Batch-készletben" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling) című témakörben talál.

Válaszok

Name Típus Description
200 OK

A Batch szolgáltatásnak küldött kérés sikeres volt.

Fejlécek

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

A Batch szolgáltatás hibája.

Biztonság

azure_auth

Microsoft Entra OAuth 2.0 hitelesítési kódfolyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation A felhasználói fiók megszemélyesítése

Authorization

Típus: apiKey
In: header

Példák

Pool enable autoscale

Mintakérelem

POST account.region.batch.azure.com/pools/poolId/enableautoscale?api-version=2024-07-01.20.0



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

Mintaválasz

Állapotkód:
200

Definíciók

Name Description
BatchError

Az Azure Batch szolgáltatástól kapott hibaválasz.
BatchErrorDetail

Az Azure Batch-hibaválaszban szereplő további információk egy eleme.
ErrorMessage

Hibaüzenet érkezett egy Azure Batch-hibaválaszban.
PoolEnableAutoScaleParameter

A készlet automatikus skálázásának engedélyezésére szolgáló beállítások.

BatchError

Az Azure Batch szolgáltatástól kapott hibaválasz.

Name Típus Description
code

string

A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
message

ErrorMessage

A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
values

BatchErrorDetail[]

Kulcs-érték párok gyűjteménye, amelyek további részleteket tartalmaznak a hibáról.

BatchErrorDetail

Az Azure Batch-hibaválaszban szereplő további információk egy eleme.

Name Típus Description
key

string

Az Érték tulajdonság jelentését meghatározó azonosító.
value

string

A hibaválasz további információi.

ErrorMessage

Hibaüzenet érkezett egy Azure Batch-hibaválaszban.

Name Típus Description
lang

string

A hibaüzenet nyelvi kódja
value

string

Az üzenet szövege.

PoolEnableAutoScaleParameter

A készlet automatikus skálázásának engedélyezésére szolgáló beállítások.

Name Típus Description
autoScaleEvaluationInterval

string

Az az időintervallum, amellyel automatikusan módosíthatja a készlet méretét az automatikus skálázási képletnek megfelelően.
Az alapértelmezett érték 15 perc. A minimális és a maximális érték 5 perc, illetve 168 óra. Ha 5 percnél rövidebb vagy 168 óránál hosszabb értéket ad meg, a Batch szolgáltatás érvénytelen tulajdonságérték-hibával utasítja el a kérelmet; ha közvetlenül a REST API-t hívja meg, a HTTP-állapotkód 400 (hibás kérés). Ha új időközt ad meg, a rendszer leállítja a meglévő automatikus skálázási kiértékelési ütemezést, és elindít egy új automatikus skálázási kiértékelési ütemezést, amelynek kezdő időpontja a kérés kiadásának időpontja.
autoScaleFormula

string

A készletben lévő számítási csomópontok kívánt számának képlete.
A rendszer ellenőrzi a képlet érvényességét, mielőtt alkalmazva lenne a készletre. Ha a képlet érvénytelen, a Batch szolgáltatás elutasítja a kérelmet részletes hibainformációkkal. A képlet megadásáról további információt a "Számítási csomópontok automatikus méretezése az Azure Batch-készletben" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling) című témakörben talál.