Task - Update

Service:

Batch Service

API Version:

2023-11-01.18.0

Aktualizace vlastnosti zadané úlohy.

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2023-11-01.18.0

With optional parameters:

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?timeout={timeout}&api-version=2023-11-01.18.0

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
batchUrl	path	True	string	Základní adresa URL pro všechny požadavky Azure Batch služby.
jobId	path	True	string	ID úlohy obsahující úkol.
taskId	path	True	string	ID úlohy, která se má aktualizovat.
api-version	query	True	string	Verze rozhraní API klienta.
timeout	query		integer int32	Maximální doba, kterou může server strávit zpracováním požadavku( v sekundách). Výchozí hodnota je 30 sekund.

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
client-request-id		string uuid	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Určuje, jestli má server v odpovědi vrátit client-request-id.
ocp-date		string date-time-rfc1123	Čas, kdy byla žádost vydána. Klientské knihovny obvykle nastavit na aktuální systémový čas hodin; pokud voláte rozhraní REST API přímo, explicitně ho nastavte.
If-Match		string	Hodnota ETag přidružená k verzi prostředku, kterou klient zná. Operace se provede pouze v případě, že aktuální značka ETag prostředku ve službě přesně odpovídá hodnotě zadané klientem.
If-None-Match		string	Hodnota ETag přidružená k verzi prostředku, kterou klient zná. Operace se provede pouze v případě, že aktuální značka ETag prostředku ve službě neodpovídá hodnotě zadané klientem.
If-Modified-Since		string date-time-rfc1123	Časové razítko označující čas poslední změny prostředku známého klientovi. Operace se provede pouze v případě, že se prostředek ve službě od zadaného času změnil.
If-Unmodified-Since		string date-time-rfc1123	Časové razítko označující čas poslední změny prostředku známého klientovi. Operace se provede pouze v případě, že prostředek ve službě nebyl od zadaného času změněn.

Text požadavku

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

Name	Typ	Description
constraints	TaskConstraints	Omezení, která se vztahují na tento úkol. Pokud ho vynecháte, bude úkol nastaven na výchozí omezení. U úloh s více instancemi se aktualizace doby uchovávání vztahuje pouze na primární úlohu, a ne na dílčí úkoly.

Odpovědi

Name	Typ	Description
200 OK		Požadavek na službu Batch byl úspěšný. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Chyba ze služby Batch.

Zabezpečení

azure_auth

Microsoft Entra tok ověřovacího kódu OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Authorization

Type: apiKey
In: header

Příklady

Task update

Sample Request

HTTP

PUT account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2023-11-01.18.0



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

Sample Response

Status code:

200

Definice

Name	Description
BatchError	Služba Azure Batch obdržela chybovou odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.
ErrorMessage	Chybová zpráva přijatá v Azure Batch chybovou odpověď.
TaskConstraints	Omezení provádění, která se mají použít pro úlohu.
TaskUpdateParameter	Sada změn, které mají být provedeny v úkolu.

BatchError

Služba Azure Batch obdržela chybovou odpověď.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou neutrální a mají být využívány programově.
message	ErrorMessage	Zpráva popisující chybu, která má být vhodná k zobrazení v uživatelském rozhraní.
values	BatchErrorDetail[]	Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.

Name	Typ	Description
key	string	Identifikátor určující význam value vlastnost.
value	string	Další informace zahrnuté v chybové odpovědi.

ErrorMessage

Chybová zpráva přijatá v Azure Batch chybovou odpověď.

Name	Typ	Description
lang	string	Kód jazyka chybové zprávy
value	string	Text zprávy

TaskConstraints

Omezení provádění, která se mají použít pro úlohu.

Name	Typ	Description
maxTaskRetryCount	integer	Maximální počet pokusů o opakování úkolu Služba Batch opakuje úlohu, pokud je její ukončovací kód nenulový. Všimněte si, že tato hodnota konkrétně řídí počet opakování spustitelného souboru úlohy z důvodu nenulového ukončovacího kódu. Služba Batch tuto úlohu jednou vyzkouší a pak to může opakovat až do tohoto limitu. Pokud je například maximální počet opakování 3, služba Batch zkouší úlohu až 4krát (jeden počáteční pokus a 3 opakování). Pokud je maximální počet opakování 0, služba Batch po prvním pokusu nezopakuje úlohu. Pokud je maximální počet opakování -1, služba Batch opakuje úlohu bez omezení, ale nedoporučuje se to pro spouštěcí úkol ani žádný úkol. Výchozí hodnota je 0 (bez opakování).
maxWallClockTime	string	Maximální uplynulý čas, po který může úloha běžet, měřená od okamžiku spuštění úlohy. Pokud se úkol nedokončil ve stanoveném časovém limitu, služba Batch ho ukončí. Není-li tato hodnota zadána, neexistuje žádný časový limit, jak dlouho může úloha běžet.
retentionTime	string	Minimální doba uchování adresáře úkolů na výpočetním uzlu, na kterém byl spuštěný, od okamžiku dokončení provádění. Po uplynutí této doby může služba Batch odstranit adresář úkolů a veškerý jeho obsah. Výchozí hodnota je 7 dnů, tj. adresář úkolů se zachová po dobu 7 dnů, pokud se neodebere výpočetní uzel nebo neodstraní úlohu.

TaskUpdateParameter

Sada změn, které mají být provedeny v úkolu.

Name	Typ	Description
constraints	TaskConstraints	Omezení, která se vztahují na tento úkol. Pokud ho vynecháte, bude úkol nastaven na výchozí omezení. U úloh s více instancemi se aktualizace doby uchovávání vztahuje pouze na primární úlohu, a ne na dílčí úkoly.