Pool - Resize
Ändrar antalet beräkningsnoder som har tilldelats till en pool.
Du kan bara ändra storlek på en pool när dess allokeringstillstånd är stabilt. Om poolen redan ändrar storlek misslyckas begäran med statuskoden 409. När du ändrar storlek på en pool ändras poolens allokeringstillstånd från stabilt till storleksändring. Du kan inte ändra storlek på pooler som har konfigurerats för automatisk skalning. Om du försöker göra detta returnerar Batch-tjänsten ett fel 409. Om du ändrar storlek på en pool nedåt väljer Batch-tjänsten vilka beräkningsnoder du vill ta bort. Om du vill ta bort specifika beräkningsnoder använder du api:et Pool remove Compute Nodes i stället.
POST {batchUrl}/pools/{poolId}/resize?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/resize?timeout={timeout}&api-version=2023-11-01.18.0
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
batch
|
path | True |
string |
Bas-URL:en för alla Azure Batch tjänstbegäranden. |
pool
|
path | True |
string |
ID:t för poolen som ska storleksändras. |
api-version
|
query | True |
string |
Klient-API-version. |
timeout
|
query |
integer int32 |
Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder. |
Begärandehuvud
Media Types: "application/json; odata=minimalmetadata"
Name | Obligatorisk | Typ | Description |
---|---|---|---|
client-request-id |
string uuid |
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-rfc1123 |
Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det uttryckligen om du anropar REST-API:et direkt. |
|
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. |
|
If-Modified-Since |
string date-time-rfc1123 |
En tidsstämpel som anger den senast ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen på tjänsten har ändrats sedan den angivna tiden. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
En tidsstämpel som anger den senast ä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. |
Begärandetext
Media Types: "application/json; odata=minimalmetadata"
Name | Typ | Description |
---|---|---|
nodeDeallocationOption |
Avgör vad du ska göra med en beräkningsnod och dess aktiviteter som körs om poolstorleken minskar. |
|
resizeTimeout |
string |
Tidsgränsen för allokering av noder till poolen eller borttagning av beräkningsnoder från poolen. |
targetDedicatedNodes |
integer |
Önskat antal dedikerade beräkningsnoder i poolen. |
targetLowPriorityNodes |
integer |
Önskat antal beräkningsnoder med oanvänd kapacitet/låg prioritet i poolen. |
Svar
Name | Typ | Description |
---|---|---|
202 Accepted |
Begäran till Batch-tjänsten lyckades. Headers
|
|
Other Status Codes |
Felet från Batch-tjänsten. |
Säkerhet
azure_auth
Microsoft Entra autentiseringskodflöde för OAuth 2.0
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Personifiera ditt användarkonto |
Authorization
Type:
apiKey
In:
header
Exempel
Pool resize
Sample Request
POST account.region.batch.azure.com/pools/resizePool/resize?api-version=2023-11-01.18.0
{
"targetDedicatedNodes": 1,
"targetLowPriorityNodes": 0
}
Sample Response
Definitioner
Name | Description |
---|---|
Batch |
Ett felsvar som tagits emot från Azure Batch-tjänsten. |
Batch |
Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar. |
Compute |
Avgör vad du ska göra med en beräkningsnod och dess aktiviteter som körs när den har valts för frigöring. |
Error |
Ett felmeddelande som togs emot i ett Azure Batch felsvar. |
Pool |
Alternativ för att ändra storleken på en pool. |
BatchError
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 |
Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt. |
|
values |
En samling nyckel/värde-par som innehåller ytterligare information om felet. |
BatchErrorDetail
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. |
ComputeNodeDeallocationOption
Avgör vad du ska göra med en beräkningsnod och dess aktiviteter som körs när den har valts för frigöring.
Name | Typ | Description |
---|---|---|
requeue |
string |
Avsluta aktivitetsprocesser som körs och skicka aktiviteterna på nytt. Aktiviteterna körs igen när en beräkningsnod är tillgänglig. Ta bort beräkningsnoder så snart aktiviteter har avslutats. |
retaineddata |
string |
Tillåt att aktiviteter som körs för närvarande slutförs och vänta tills alla kvarhållningsperioder för uppgiftsdata upphör att gälla. Schemalägg inga nya aktiviteter medan du väntar. Ta bort beräkningsnoder när alla kvarhållningsperioder för aktiviteter har upphört att gälla. |
taskcompletion |
string |
Tillåt att aktiviteter som körs för närvarande slutförs. Schemalägg inga nya aktiviteter medan du väntar. Ta bort beräkningsnoder när alla aktiviteter har slutförts. |
terminate |
string |
Avsluta aktiviteter som körs. Aktiviteterna slutförs med failureInfo som anger att de har avslutats och inte körs igen. Ta bort beräkningsnoder så snart aktiviteter har avslutats. |
ErrorMessage
Ett felmeddelande som togs emot i ett Azure Batch felsvar.
Name | Typ | Description |
---|---|---|
lang |
string |
Språkkoden för felmeddelandet |
value |
string |
Texten i meddelandet. |
PoolResizeParameter
Alternativ för att ändra storleken på en pool.
Name | Typ | Description |
---|---|---|
nodeDeallocationOption |
Avgör vad du ska göra med en beräkningsnod och dess aktiviteter som körs om poolstorleken minskar. |
|
resizeTimeout |
string |
Tidsgränsen för allokering av noder till poolen eller borttagning av beräkningsnoder från poolen. |
targetDedicatedNodes |
integer |
Önskat antal dedikerade beräkningsnoder i poolen. |
targetLowPriorityNodes |
integer |
Önskat antal beräkningsnoder med oanvänd kapacitet/låg prioritet i poolen. |