Pool - Enable Auto Scale

  • Referentie
Service:
Batch Service
API Version:
2023-11-01.18.0

Hiermee schakelt u automatisch schalen voor een pool in.
U kunt automatisch schalen niet inschakelen voor een pool als er een bewerking voor het wijzigen van het formaat van de pool wordt uitgevoerd. Als automatisch schalen van de pool momenteel is uitgeschakeld, moet u een geldige formule voor automatisch schalen opgeven als onderdeel van de aanvraag. Als automatisch schalen van de pool al is ingeschakeld, kunt u een nieuwe formule voor automatisch schalen en/of een nieuw evaluatie-interval opgeven. U kunt deze API niet meerdere keren per 30 seconden aanroepen voor dezelfde pool.

POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2023-11-01.18.0
With optional parameters: 
POST {batchUrl}/pools/{poolId}/enableautoscale?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 waarop automatisch schalen moet 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.

Aanvraagkoptekst

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

Name Vereist Type Description
client-request-id

string

uuid

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 dit 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 op de service sinds de opgegeven tijd 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 op de service sinds de opgegeven tijd niet is gewijzigd.

Aanvraagbody

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

Name Type Description
autoScaleEvaluationInterval

string

Het tijdsinterval waarmee de poolgrootte automatisch moet worden aangepast aan 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 fout met een ongeldige eigenschapswaarde. 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 automatisch schalen gestart, met als begintijd het tijdstip 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 ongeldig is, weigert de Batch-service de aanvraag met gedetailleerde foutinformatie. Zie Compute Nodes in an Azure Batch Pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling) automatisch schalen voor meer informatie over het opgeven van deze formule.

Antwoorden

Name Type Description
200 OK

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 enable autoscale

Sample Request

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



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

Sample Response

Status code:
200

Definities

Name Description
BatchError

Een foutbericht dat is ontvangen van de Azure Batch-service.
BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
ErrorMessage

Een foutbericht ontvangen in een Azure Batch antwoord.
PoolEnableAutoScaleParameter

Opties voor het inschakelen van automatisch schalen in een pool.

BatchError

Een foutbericht dat is 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 details 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.

ErrorMessage

Een foutbericht ontvangen in een Azure Batch antwoord.

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 aan 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 fout met een ongeldige eigenschapswaarde. 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 automatisch schalen gestart, met als begintijd het tijdstip 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 ongeldig is, weigert de Batch-service de aanvraag met gedetailleerde foutinformatie. Zie Compute Nodes in an Azure Batch Pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling) automatisch schalen voor meer informatie over het opgeven van deze formule.