Task - Update

Usługa:

Batch Service

Wersja interfejsu API:

2024-07-01.20.0

Aktualizuje właściwości określonego zadania.

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2024-07-01.20.0

Z parametrami opcjonalnymi:

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?timeout={timeout}&api-version=2024-07-01.20.0

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL dla wszystkich żądań usługi Azure Batch.
jobId	path	True	string	Identyfikator zadania zawierającego zadanie.
taskId	path	True	string	Identyfikator zadania do zaktualizowania.
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
constraints	TaskConstraints	Ograniczenia, które mają zastosowanie do tego zadania. W przypadku pominięcia zadanie ma domyślne ograniczenia. W przypadku zadań z wieloma wystąpieniami aktualizowanie czasu przechowywania ma zastosowanie tylko do podstawowych zadań podrzędnych, a nie do podzadania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK		Żądanie do usługi Batch zakończyło się pomyślnie. Nagłówki client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	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

Task update

Przykładowe żądanie

HTTP

PUT account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2024-07-01.20.0



{
  "constraints": {
    "maxWallClockTime": "PT1H",
    "maxTaskRetryCount": 3,
    "retentionTime": "PT1H"
  }
}

Przykładowa odpowiedź

Kod stanu:

200

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.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.
TaskConstraints	Ograniczenia wykonywania, które mają zastosowanie do zadania.
TaskUpdateParameter	Zestaw zmian, które mają zostać wprowadzone do zadania.

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

TaskConstraints

Ograniczenia wykonywania, które mają zastosowanie do zadania.

Nazwa	Typ	Opis
maxTaskRetryCount	integer	Maksymalna liczba ponownych prób wykonania zadania. Usługa Batch ponawia próbę zadania, jeśli jego kod zakończenia jest inny niżzer. Należy pamiętać, że ta wartość steruje liczbą ponownych prób dla pliku wykonywalnego zadania ze względu na kod zakończenia niezerowy. Usługa Batch spróbuje raz wykonać zadanie, a następnie może ponowić próbę do tego limitu. Jeśli na przykład maksymalna liczba ponownych prób wynosi 3, usługa Batch próbuje wykonać zadanie do 4 razy (jedna początkowa próba i 3 ponownych prób). Jeśli maksymalna liczba ponownych prób wynosi 0, usługa Batch nie ponowi próby wykonania zadania po pierwszej próbie. Jeśli maksymalna liczba ponownych prób wynosi -1, usługa Batch ponawia próbę zadania bez limitu, jednak nie jest to zalecane w przypadku zadania podrzędnego uruchamiania ani żadnego zadania podrzędnego. Wartość domyślna to 0 (bez ponownych prób).
maxWallClockTime	string	Maksymalny czas, który upłynął, który może zostać uruchomiony przez zadanie, mierzony od momentu uruchomienia zadania. Jeśli zadanie nie zostanie ukończone w limicie czasu, usługa Batch zakończy je. Jeśli to nie zostanie określone, nie ma limitu czasu na czas uruchomienia zadania.
retentionTime	string	Minimalny czas przechowywania katalogu zadań w węźle obliczeniowym, w którym został uruchomiony, od momentu zakończenia wykonywania. Po tym czasie usługa Batch może usunąć katalog Task i całą jego zawartość. Wartość domyślna to 7 dni, tj. katalog zadań zostanie zachowany przez 7 dni, chyba że węzeł obliczeniowy zostanie usunięty lub zadanie zostanie usunięte.

TaskUpdateParameter

Zestaw zmian, które mają zostać wprowadzone do zadania.

Nazwa	Typ	Opis
constraints	TaskConstraints	Ograniczenia, które mają zastosowanie do tego zadania. W przypadku pominięcia zadanie ma domyślne ograniczenia. W przypadku zadań z wieloma wystąpieniami aktualizowanie czasu przechowywania ma zastosowanie tylko do podstawowych zadań podrzędnych, a nie do podzadania.