Pool - Resize

Service:

Batch Service

API Version:

2023-11-01.18.0

Hiermee wijzigt u het aantal rekenknooppunten dat is toegewezen aan een pool.
U kunt het formaat van een pool alleen wijzigen wanneer de toewijzingsstatus stabiel is. Als het formaat van de groep al wordt gewijzigd, mislukt de aanvraag met statuscode 409. Wanneer u het formaat van een pool wijzigt, verandert de toewijzingsstatus van de pool van constant in het wijzigen van het formaat. U kunt de grootte van pools die zijn geconfigureerd voor automatisch schalen niet wijzigen. Als u dit probeert te doen, retourneert de Batch-service fout 409. Als u de grootte van een pool omlaag wijzigt, kiest de Batch-service welke rekenknooppunten u wilt verwijderen. Als u specifieke rekenknooppunten wilt verwijderen, gebruikt u in plaats daarvan de API Rekenknooppunten groep verwijderen.

POST {batchUrl}/pools/{poolId}/resize?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/resize?timeout={timeout}&api-version=2023-11-01.18.0

URI-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch serviceaanvragen.
poolId	path	True	string	De id van de pool waarvan de grootte moet worden gewijzigd.
api-version	query	True	string	Client-API-versie.
timeout	query		integer int32	De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
client-request-id		string uuid	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 client-request-id in het antwoord moet retourneren.
ocp-date		string date-time-rfc1123	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige systeemkloktijd; stel deze expliciet in als u de REST API rechtstreeks aanroept.
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.
If-Modified-Since		string date-time-rfc1123	Een tijdstempel die de laatste wijzigingstijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource in de service sinds het opgegeven tijdstip is gewijzigd.
If-Unmodified-Since		string date-time-rfc1123	Een tijdstempel die de laatste wijzigingstijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource in de service niet is gewijzigd sinds het opgegeven tijdstip.

Aanvraagbody

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

Name	Type	Description
nodeDeallocationOption	ComputeNodeDeallocationOption	Bepaalt wat er moet worden uitgevoerd met een rekenknooppunt en de actieve taak(en) als de poolgrootte afneemt. De standaardwaarde is opnieuw in de wachtrij plaatsen.
resizeTimeout	string	De time-out voor het toewijzen van knooppunten aan de pool of het verwijderen van rekenknooppunten uit de pool. De standaardwaarde is 15 minuten. De minimumwaarde is 5 minuten. Als u een waarde van minder dan vijf minuten opgeeft, retourneert de Batch-service een fout; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (ongeldige aanvraag).
targetDedicatedNodes	integer	Het gewenste aantal toegewezen rekenknooppunten in de pool.
targetLowPriorityNodes	integer	Het gewenste aantal spot-rekenknooppunten/rekenknooppunten met lage prioriteit in de pool.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag voor de Batch-service is geslaagd. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

Pool resize

Sample Request

HTTP

POST account.region.batch.azure.com/pools/resizePool/resize?api-version=2023-11-01.18.0



{
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0
}

Sample Response

Status code:

202

Definities

Name	Description
BatchError	Een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
ComputeNodeDeallocationOption	Bepaalt wat er moet worden gedaan met een rekenknooppunt en de actieve taak(en) nadat deze is geselecteerd voor deallocatie.
ErrorMessage	Een foutbericht ontvangen in een Azure Batch foutbericht.
PoolResizeParameter	Opties voor het wijzigen van de grootte van een pool.

BatchError

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	ErrorMessage	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values	BatchErrorDetail[]	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 Value aangeeft.
value	string	De aanvullende informatie die is opgenomen in de foutreactie.

ComputeNodeDeallocationOption

Bepaalt wat er moet worden gedaan met een rekenknooppunt en de actieve taak(en) nadat deze is geselecteerd voor deallocatie.

Name	Type	Description
requeue	string	Beëindig actieve taakprocessen en plaats de taken opnieuw. De taken worden opnieuw uitgevoerd wanneer er een rekenknooppunt beschikbaar is. Rekenknooppunten verwijderen zodra taken zijn beëindigd.
retaineddata	string	Sta taken die momenteel worden uitgevoerd toe en wacht totdat alle bewaarperioden voor taakgegevens zijn verlopen. Geen nieuwe taken plannen tijdens het wachten. Rekenknooppunten verwijderen wanneer alle retentieperioden voor taken zijn verlopen.
taskcompletion	string	Sta taken die momenteel worden uitgevoerd toe om te voltooien. Geen nieuwe taken plannen tijdens het wachten. Rekenknooppunten verwijderen wanneer alle taken zijn voltooid.
terminate	string	Actieve taken beëindigen. De taken worden voltooid met failureInfo die aangeeft dat ze zijn beëindigd en niet opnieuw worden uitgevoerd. Rekenknooppunten verwijderen zodra taken zijn beëindigd.

ErrorMessage

Een foutbericht ontvangen in een Azure Batch foutbericht.

Name	Type	Description
lang	string	De taalcode van het foutbericht
value	string	De tekst van het bericht.

PoolResizeParameter

Opties voor het wijzigen van de grootte van een pool.

Name	Type	Description
nodeDeallocationOption	ComputeNodeDeallocationOption	Bepaalt wat er moet worden uitgevoerd met een rekenknooppunt en de actieve taak(en) als de poolgrootte afneemt. De standaardwaarde is opnieuw in de wachtrij plaatsen.
resizeTimeout	string	De time-out voor het toewijzen van knooppunten aan de pool of het verwijderen van rekenknooppunten uit de pool. De standaardwaarde is 15 minuten. De minimumwaarde is 5 minuten. Als u een waarde van minder dan vijf minuten opgeeft, retourneert de Batch-service een fout; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (ongeldige aanvraag).
targetDedicatedNodes	integer	Het gewenste aantal toegewezen rekenknooppunten in de pool.
targetLowPriorityNodes	integer	Het gewenste aantal spot-rekenknooppunten/rekenknooppunten met lage prioriteit in de pool.