Udostępnij przez

Pools - Delete Pool

Usługa:
Batch Service
Wersja interfejsu API:
2025-06-01

Usuwa pulę z określonego konta.
Gdy zażądasz usunięcia puli, zostaną wykonane następujące akcje: stan puli zostanie ustawiony na usunięcie; wszystkie trwające operacje zmiany rozmiaru w puli są zatrzymywane; usługa Batch rozpoczyna zmianę rozmiaru puli na zero węzłów obliczeniowych; wszystkie zadania uruchomione w istniejących węzłach obliczeniowych są przerywane i ponownie kolejkowane (tak jak w przypadku żądania operacji zmiany rozmiaru puli z domyślną opcją ponownej kolejki); na koniec pula zostanie usunięta z systemu. Ponieważ uruchomione zadania są ponownie kolejkowane, użytkownik może ponownie uruchomić te zadania, aktualizując zadanie w celu kierowania innej puli. Następnie zadania mogą być uruchamiane w nowej puli. Jeśli chcesz zastąpić zachowanie ponownej kolejki, należy jawnie wywołać zmianę rozmiaru puli, aby zmniejszyć pulę do zera przed usunięciem puli. Jeśli wywołasz interfejs API aktualizacji, poprawek lub usuwania w puli w stanie usuwania, kod stanu HTTP 409 z kodem błędu PoolBeingDeleted zakończy się niepowodzeniem.

DELETE {endpoint}/pools/{poolId}?api-version=2025-06-01
Z parametrami opcjonalnymi: 
DELETE {endpoint}/pools/{poolId}?api-version=2025-06-01&timeOut={timeOut}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpoint
 path True

string (uri)

Punkt końcowy konta usługi Batch (na przykład: https://batchaccount.eastus2.batch.azure.com).
poolId
 path True

string

Identyfikator puli do pobrania.
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.
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 domyślna wersja domyślna.".

Nagłówek żądania

Nazwa Wymagane Typ Opis
client-request-id

string

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-rfc7231)

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-Modified-Since

string (date-time-rfc7231)

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-rfc7231)

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.
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.

Odpowiedzi

Nazwa Typ Opis
202 Accepted

Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone.

Nagłówki

  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresy

Nazwa Opis
https://batch.core.windows.net//.default

Przykłady

Pool delete

Przykładowe żądanie

DELETE {endpoint}/pools/poolId?api-version=2025-06-01

Przykładowa odpowiedź

Kod stanu:
202

Definicje

Nazwa Opis
BatchError

Odebrano odpowiedź o błędzie z usługi Azure Batch.
BatchErrorDetail

Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.
BatchErrorMessage

Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.

BatchError

Objekt

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

BatchErrorMessage

Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
values

BatchErrorDetail[]

Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu.

BatchErrorDetail

Objekt

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.

BatchErrorMessage

Objekt

Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.

Nazwa Typ Opis
lang

string

Kod językowy komunikatu o błędzie.
value

string

Tekst wiadomości.