Pool - Enable Auto Scale
Włącza automatyczne skalowanie dla puli.
Nie można włączyć automatycznego skalowania w puli, jeśli operacja zmiany rozmiaru jest w toku w puli. Jeśli automatyczne skalowanie puli jest obecnie wyłączone, należy określić prawidłową formułę autoskalowania w ramach żądania. Jeśli automatyczne skalowanie puli jest już włączone, możesz określić nową formułę autoskalowania i/lub nowy interwał oceny. Nie można wywołać tego interfejsu API dla tej samej puli więcej niż raz co 30 sekund.
POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2024-07-01.20.0POST {batchUrl}/pools/{poolId}/enableautoscale?timeout={timeout}&api-version=2024-07-01.20.0Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
batch
|
path | True |
string |
Podstawowy adres URL dla wszystkich żądań usługi Azure Batch. |
|
pool
|
path | True |
string |
Identyfikator puli, dla której ma być włączone automatyczne skalowanie. |
|
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
|
timeout
|
query |
integer int32 |
Maksymalny czas przetwarzania żądania przez serwer w sekundach. Wartość domyślna to 30 sekund. Jeśli wartość jest większa niż 30, zostanie użyta wartość domyślna. |
Nagłówek żądania
Media Types: "application/json; odata=minimalmetadata"
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| client-request-id |
string uuid |
Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
| return-client-request-id |
boolean |
Czy serwer powinien zwrócić identyfikator żądania klienta w odpowiedzi. |
|
| ocp-date |
string date-time-rfc1123 |
Czas wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżący czas zegara systemowego; ustaw go jawnie, jeśli bezpośrednio wywołujesz interfejs API REST. |
|
| If-Match |
string |
Wartość elementu ETag skojarzona z wersją zasobu znaną klientowi. Operacja zostanie wykonana tylko wtedy, gdy bieżący element ETag zasobu w usłudze dokładnie odpowiada wartości określonej przez klienta. |
|
| If-None-Match |
string |
Wartość elementu ETag skojarzona z wersją zasobu znaną klientowi. Operacja zostanie wykonana tylko wtedy, gdy bieżący element ETag zasobu w usłudze nie jest zgodny z wartością określoną przez klienta. |
|
| If-Modified-Since |
string date-time-rfc1123 |
Sygnatura czasowa wskazująca czas ostatniej modyfikacji zasobu znanego klientowi. Operacja zostanie wykonana tylko wtedy, gdy zasób w usłudze został zmodyfikowany od określonego czasu. |
|
| If-Unmodified-Since |
string date-time-rfc1123 |
Sygnatura czasowa wskazująca czas ostatniej modyfikacji zasobu znanego klientowi. Operacja zostanie wykonana tylko wtedy, gdy zasób usługi nie został zmodyfikowany od określonego czasu. |
Treść żądania
Media Types: "application/json; odata=minimalmetadata"
| Nazwa | Typ | Opis |
|---|---|---|
| autoScaleEvaluationInterval |
string |
Interwał czasu, w którym ma być automatycznie dostosowywany rozmiar puli zgodnie z formułą autoskalowania. |
| autoScaleFormula |
string |
Formuła żądanej liczby węzłów obliczeniowych w puli. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
Żądanie do usługi Batch zakończyło się pomyślnie. Nagłówki
|
|
| Other Status Codes |
Błąd usługi Batch. |
Zabezpieczenia
azure_auth
Microsoft Entra OAuth 2.0 — przepływ kodu uwierzytelniania
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
| Nazwa | Opis |
|---|---|
| user_impersonation | Personifikuj konto użytkownika |
Authorization
Typ:
apiKey
W:
header
Przykłady
Pool enable autoscale
Przykładowe żądanie
POST account.region.batch.azure.com/pools/poolId/enableautoscale?api-version=2024-07-01.20.0
{
"autoScaleFormula": "$TargetDedicated=0",
"autoScaleEvaluationInterval": "PT8M"
}
Przykładowa odpowiedź
Definicje
| Nazwa | Opis |
|---|---|
|
Batch |
Odebrano odpowiedź o błędzie z usługi Azure Batch. |
|
Batch |
Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch. |
|
Error |
Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch. |
|
Pool |
Opcje włączania automatycznego skalowania w puli. |
BatchError
Odebrano odpowiedź o błędzie z usługi Azure Batch.
| Nazwa | Typ | Opis |
|---|---|---|
| code |
string |
Identyfikator błędu. Kody są niezmienne i mają być używane programowo. |
| message |
Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika. |
|
| values |
Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu. |
BatchErrorDetail
Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.
| Nazwa | Typ | Opis |
|---|---|---|
| key |
string |
Identyfikator określający znaczenie właściwości Value. |
| value |
string |
Dodatkowe informacje zawarte w odpowiedzi na błąd. |
ErrorMessage
Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.
| Nazwa | Typ | Opis |
|---|---|---|
| lang |
string |
Kod języka komunikatu o błędzie |
| value |
string |
Tekst wiadomości. |
PoolEnableAutoScaleParameter
Opcje włączania automatycznego skalowania w puli.
| Nazwa | Typ | Opis |
|---|---|---|
| autoScaleEvaluationInterval |
string |
Interwał czasu, w którym ma być automatycznie dostosowywany rozmiar puli zgodnie z formułą autoskalowania. |
| autoScaleFormula |
string |
Formuła żądanej liczby węzłów obliczeniowych w puli. |