Pool - Delete

Usługa:

Batch Service

Wersja interfejsu API:

2023-11-01.18.0

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 jakby zażądano 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. Zadania można następnie uruchamiać w nowej puli. Jeśli chcesz zastąpić zachowanie ponownego kolejkowania, przed usunięciem puli należy jawnie wywołać metodę zmiany rozmiaru puli, aby zmniejszyć pulę do zera. Jeśli wywołasz interfejs API aktualizacji, poprawki lub usuwania w puli w stanie usuwania, kod stanu HTTP 409 z kodem błędu PoolBeingDeleted zakończy się niepowodzeniem.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL dla wszystkich żądań obsługi Azure Batch.
poolId	path	True	string	Identyfikator puli do usunięcia.
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.

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, takich jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Określa, czy serwer powinien zwrócić wartość client-request-id 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 znanego 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 znanego klientowi. Operacja zostanie wykonana tylko wtedy, gdy bieżący element ETag zasobu w usłudze jest niezgodny 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.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Żądanie do usługi Batch zakończyło się pomyślnie. Nagłówki client-request-id: string request-id: string
Other Status Codes	BatchError	Błąd usługi Batch.

Zabezpieczenia

azure_auth

przepływ kodu uwierzytelniania OAuth 2.0 Microsoft Entra

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 delete

Przykładowe żądanie

HTTP

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

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 Azure Batch.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.

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

Element dodatkowych informacji zawartych w odpowiedzi na błąd 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 Azure Batch błędu.

Nazwa	Typ	Opis
lang	string	Kod języka komunikatu o błędzie
value	string	Tekst wiadomości.