Pool - Enable Auto Scale

Service:

Batch Service

API-versie:

2024-07-01.20.0

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 {batchUrl}/pools/{poolId}/enableautoscale?api-version=2024-07-01.20.0

Met optionele parameters:

POST {batchUrl}/pools/{poolId}/enableautoscale?timeout={timeout}&api-version=2024-07-01.20.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 waarop automatisch schalen kan worden ingeschakeld.
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. Als de waarde groter is dan 30, wordt in plaats daarvan de standaardwaarde gebruikt.

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 clientaanvraag-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 kloktijd van het systeem; 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 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-rfc1123	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.

Aanvraagbody

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

Name	Type	Description
autoScaleEvaluationInterval	string	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 u een nieuw interval opgeeft, wordt het bestaande evaluatieschema voor automatische schaalaanpassing gestopt en wordt er een nieuw evaluatieschema voor automatische schaalaanpassing gestart, waarbij het begintijd is waarop deze aanvraag is uitgegeven.
autoScaleFormula	string	De formule voor het gewenste aantal rekenknooppunten in de pool. De formule wordt gecontroleerd op geldigheid voordat deze wordt toegepast op de pool. Als de formule niet geldig is, weigert de Batch-service de aanvraag met gedetailleerde foutinformatie. Zie Compute-knooppunten automatisch schalen in een Azure Batch-pool (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling) voor meer informatie over het opgeven van deze formule.

Antwoorden

Name	Type	Description
200 OK		De aanvraag voor de Batch-service is geslaagd. Kopteksten 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
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

Pool enable autoscale

Voorbeeldaanvraag

HTTP

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



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

Voorbeeldrespons

Statuscode:

200

Definities

Name	Description
BatchError	Er is een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
ErrorMessage	Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
PoolEnableAutoScaleParameter	Opties voor het inschakelen van automatisch schalen in een 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	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 Waarde aangeeft.
value	string	De aanvullende informatie die is opgenomen in het foutbericht.

ErrorMessage

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.

PoolEnableAutoScaleParameter

Opties voor het inschakelen van automatisch schalen in een pool.

Name	Type	Description
autoScaleEvaluationInterval	string	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 u een nieuw interval opgeeft, wordt het bestaande evaluatieschema voor automatische schaalaanpassing gestopt en wordt er een nieuw evaluatieschema voor automatische schaalaanpassing gestart, waarbij het begintijd is waarop deze aanvraag is uitgegeven.
autoScaleFormula	string	De formule voor het gewenste aantal rekenknooppunten in de pool. De formule wordt gecontroleerd op geldigheid voordat deze wordt toegepast op de pool. Als de formule niet geldig is, weigert de Batch-service de aanvraag met gedetailleerde foutinformatie. Zie Compute-knooppunten automatisch schalen in een Azure Batch-pool (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling) voor meer informatie over het opgeven van deze formule.