Task - Update

Služba:

Batch Service

Verze rozhraní API:

2024-07-01.20.0

Aktualizuje vlastnosti zadané úlohy.

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

S volitelnými parametry:

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?timeout={timeout}&api-version=2024-07-01.20.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 služby Azure Batch.
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, po kterou může server strávit zpracováním požadavku v sekundách. Výchozí hodnota je 30 sekund. Pokud je hodnota větší než 30, použije se výchozí hodnota.

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, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Určuje, jestli má server v odpovědi vrátit ID požadavku klienta.
ocp-date		string date-time-rfc1123	Čas vydání žádosti. Klientské knihovny obvykle nastavily aktuální systémový čas; explicitně ji nastavte, pokud voláte přímo rozhraní REST API.
If-Match		string	Hodnota ETag přidružená k verzi prostředku známého klientovi. Operace se provede pouze v případě, že aktuální značky ETag prostředku ve službě přesně odpovídají hodnotě určené klientem.
If-None-Match		string	Hodnota ETag přidružená k verzi prostředku známého klientovi. Operace se provede pouze v případě, že aktuální značky ETag prostředku ve službě neodpovídají 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 bude provedena pouze v případě, že byl prostředek ve službě změněn od zadaného času.
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 se prostředek ve službě od zadaného času nezměnil.

Text požadavku

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

Name	Typ	Description
constraints	TaskConstraints	Omezení, která platí pro tento úkol. Pokud tento parametr vynecháte, je úkol nastaven na výchozí omezení. V případě úloh s více instancemi platí aktualizace doby uchovávání pouze pro primární úkol, nikoli dílčí úkoly.

Odpovědi

Name	Typ	Description
200 OK		Požadavek na službu Batch byl úspěšný. Hlavičky 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

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

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Authorization

Typ: apiKey
V: header

Příklady

Task update

Ukázkový požadavek

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"
  }
}

Ukázková odpověď

Stavový kód:

200

Definice

Name	Description
BatchError	Odpověď na chybu přijatá ze služby Azure Batch
BatchErrorDetail	Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch
ErrorMessage	V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.
TaskConstraints	Omezení provádění, která se mají použít pro úlohu.
TaskUpdateParameter	Sada změn, které se mají provést v úkolu.

BatchError

Odpověď na chybu přijatá ze služby Azure Batch

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

BatchErrorDetail

Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch

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

ErrorMessage

V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.

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 opakování úkolu. Služba Batch opakuje úlohu, pokud je jeho ukončovací kód nenulový. Všimněte si, že tato hodnota konkrétně řídí počet opakování spustitelného souboru úlohy kvůli nenulovém ukončovacímu kódu. Služba Batch zkusí úlohu jednou a může to zkusit znovu až do tohoto limitu. Pokud je například maximální počet opakování 3, služba Batch se pokusí úkol opakovat až 4krát (jeden počáteční pokus a 3 opakování). Pokud je maximální počet opakování 0, služba Batch neopakuje úlohu po prvním pokusu. Pokud je maximální počet opakování -1, služba Batch opakuje úkol bez omezení, ale nedoporučuje se to pro spouštěcí úkol ani žádný úkol. Výchozí hodnota je 0 (žádné 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čí v časovém limitu, služba Batch ji ukončí. Pokud není zadaný, neexistuje žádný časový limit, jak dlouho může úloha běžet.
retentionTime	string	Minimální doba uchovávání adresáře úloh na výpočetním uzlu, na kterém byl spuštěný, od okamžiku dokončení provádění. Po této době může služba Batch odstranit adresář úloh a veškerý jeho obsah. Výchozí hodnota je 7 dní, tj. adresář úloh se zachovají po dobu 7 dnů, pokud se neodebere výpočetní uzel nebo se úloha odstraní.

TaskUpdateParameter

Sada změn, které se mají provést v úkolu.

Name	Typ	Description
constraints	TaskConstraints	Omezení, která platí pro tento úkol. Pokud tento parametr vynecháte, je úkol nastaven na výchozí omezení. V případě úloh s více instancemi platí aktualizace doby uchovávání pouze pro primární úkol, nikoli dílčí úkoly.