Task - Get

Service:

Batch Service

API Version:

2023-11-01.18.0

Získá informace o zadaném úkolu.
Informace o úlohách s více instancemi, jako jsou affinityId, executionInfo a nodeInfo, odkazují na primární úlohu. K načtení informací o dílčích úkolůch použijte rozhraní API seznamu dílčích úkolů.

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

With optional parameters:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?$select={$select}&$expand={$expand}&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 služby Azure Batch.
jobId	path	True	string	ID úlohy, která obsahuje úkol.
taskId	path	True	string	ID úlohy, o které chcete získat informace.
api-version	query	True	string	Verze klientského rozhraní API.
$expand	query		string	Klauzule $expand OData.
$select	query		string	Klauzule $select OData.
timeout	query		integer int32	Maximální čas, který 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 ozdob, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Jestli má server v odpovědi vrátit client-request-id.
ocp-date		string date-time-rfc1123	Čas, kdy byla žádost vystavena. Klientské knihovny obvykle tuto možnost nastaví na aktuální systémový čas. pokud přímo voláte rozhraní REST API, nastavte ho explicitně.
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č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 známého klientovi. 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.

Odpovědi

Name	Typ	Description
200 OK	CloudTask	Odpověď obsahující úkol. 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 kódu ověřování 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 get

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": "testTask",
  "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId",
  "eTag": "0x8D3D62350711C55",
  "creationTime": "2016-09-06T06:59:15.1161429Z",
  "lastModified": "2016-09-06T06:59:15.1161429Z",
  "state": "active",
  "stateTransitionTime": "2016-09-06T06:59:15.1161429Z",
  "commandLine": "cmd /c hostname",
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  },
  "multiInstanceSettings": {
    "numberOfInstances": 3,
    "coordinationCommandLine": "cmd /c echo coordinating"
  },
  "constraints": {
    "maxWallClockTime": "P10675199DT2H48M5.4775807S",
    "retentionTime": "P10675199DT2H48M5.4775807S",
    "maxTaskRetryCount": 0
  },
  "requiredSlots": 2,
  "executionInfo": {
    "retryCount": 0,
    "requeueCount": 0
  }
}

Definice

Name	Description
AccessScope	Prostředky služby Batch, ke kterým token uděluje přístup.
AffinityInformation	Nápověda k umístění, kterou může služba Batch použít k výběru výpočetního uzlu, na kterém se má úkol spustit.
ApplicationPackageReference	Odkaz na balíček, který se má nasadit do výpočetních uzlů.
AuthenticationTokenSettings	Nastavení ověřovacího tokenu, který může úloha použít k provádění operací služby Batch.
AutoUserScope	Obor automatického uživatele
AutoUserSpecification	Určuje parametry pro automatického uživatele, který spouští úlohu ve službě Batch.
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.
CloudTask	Úkol Azure Batch.
ComputeNodeIdentityReference	Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude výpočetní uzel používat.
ComputeNodeInformation	Informace o výpočetním uzlu, na kterém se úloha spustila.
ContainerRegistry	Privátní registr kontejneru.
ContainerWorkingDirectory	Umístění pracovního adresáře úloh kontejneru.
DependencyAction	Akce, kterou služba Batch provádí u úloh, které jsou na této úloze závislé.
ElevationLevel	Úroveň zvýšení oprávnění uživatele.
EnvironmentSetting	Proměnná prostředí, která má být nastavena pro proces úlohy.
ErrorCategory	Kategorie chyby.
ErrorMessage	Chybová zpráva přijatá v Azure Batch chybovou odpověď.
ExitCodeMapping	Jak by měla služba Batch reagovat, když se úloha ukončí s konkrétním ukončovacím kódem.
ExitCodeRangeMapping	Rozsah ukončovací kódy a způsob, jakým má služba Batch reagovat na ukončovací kódy v daném rozsahu.
ExitConditions	Určuje, jak má služba Batch reagovat na dokončení úlohy.
ExitOptions	Určuje, jak služba Batch reaguje na konkrétní ukončovací podmínku.
HttpHeader	Pár název-hodnota hlavičky HTTP
JobAction	Akce, která se má provést s úlohou obsahující úlohu, pokud se úkol dokončí s danou výstupní podmínkou a vlastnost úlohy onTaskFailed je performExitOptionsJobAction.
MultiInstanceSettings	Nastavení určující, jak spustit úlohu s více instancemi.
NameValuePair	Představuje dvojici název-hodnota.
OutputFile	Specifikace pro nahrávání souborů z Azure Batch výpočetního uzlu do jiného umístění po dokončení procesu úkolu službou Batch.
OutputFileBlobContainerDestination	Určuje cíl pro nahrání souboru v kontejneru úložiště objektů blob v Azure.
OutputFileDestination	Cíl, do kterého se má soubor nahrát.
OutputFileUploadCondition	Podmínky, za kterých se má nahrát výstupní soubor úkolu nebo sada souborů.
OutputFileUploadOptions	Podrobnosti o operaci nahrávání výstupního souboru, včetně toho, za jakých podmínek se má nahrávání provést.
ResourceFile	Jeden soubor nebo více souborů ke stažení do výpočetního uzlu.
TaskConstraints	Omezení provádění, která se mají použít pro úlohu.
TaskContainerExecutionInformation	Obsahuje informace o kontejneru, který úloha provádí.
TaskContainerSettings	Nastavení kontejneru pro úlohu.
TaskDependencies	Určuje všechny závislosti úlohy. Každá úloha, která je explicitně určena nebo v rozsahu závislostí, musí být dokončena před naplánování závislé úlohy.
TaskExecutionInformation	Informace o provádění úlohy.
TaskExecutionResult	Výsledek spuštění úlohy.
TaskFailureInformation	Informace o selhání úlohy
TaskIdRange	Rozsah ID úkolů, na které může úkol záviset. Všechny úkoly s ID v rozsahu musí být úspěšně dokončeny před naplánováním závislé úlohy.
TaskState	Stav úkolu.
TaskStatistics	Statistika využití zdrojů pro úkol.
UserIdentity	Definice identity uživatele, pod kterou je úloha spuštěna.

AccessScope

Prostředky služby Batch, ke kterým token uděluje přístup.

Name	Typ	Description
job	string	Uděluje přístup k provádění všech operací s úlohou obsahující úlohu.

AffinityInformation

Nápověda k umístění, kterou může služba Batch použít k výběru výpočetního uzlu, na kterém se má úkol spustit.

Name	Typ	Description
affinityId	string	Neprůžný řetězec představující umístění výpočetního uzlu nebo úlohy, která byla dříve spuštěna. Můžete předat ID přidružení uzlu a tím označit, že tato úloha musí běžet na tomto výpočetním uzlu. Všimněte si, že je to jen měkké spřažení. Pokud je cílový výpočetní uzel v době, kdy je úkol naplánovaný, zaneprázdněný nebo nedostupný, pak se úkol naplánuje jinde.

ApplicationPackageReference

Odkaz na balíček, který se má nasadit do výpočetních uzlů.

Name	Typ	Description
applicationId	string	ID aplikace, která se má nasadit. Při vytváření fondu musí být ID aplikace balíčku plně kvalifikované (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Verze aplikace, která se má nasadit. Pokud tento parametr vynecháte, nasadí se výchozí verze. Pokud je ve fondu vynechána a pro tuto aplikaci není zadána žádná výchozí verze, požadavek selže s kódem chyby InvalidApplicationPackageReferences a stavovým kódem HTTP 409. Pokud je tato možnost u úlohy vynechána a pro tuto aplikaci není zadána žádná výchozí verze, úloha selže s chybou předběžného zpracování.

AuthenticationTokenSettings

Nastavení ověřovacího tokenu, který může úloha použít k provádění operací služby Batch.

Name	Typ	Description
access	AccessScope[]	Prostředky služby Batch, ke kterým token uděluje přístup. Ověřovací token uděluje přístup k omezené sadě operací služby Batch. V současné době je jedinou podporovanou hodnotou vlastnosti přístupu "job", která uděluje přístup ke všem operacím souvisejícím s úlohou, která obsahuje úlohu.

AutoUserScope

Obor automatického uživatele

Name	Typ	Description
pool	string	Určuje, že úloha se spustí jako běžný účet automatického uživatele, který se vytvoří na každém výpočetním uzlu ve fondu.
task	string	Určuje, že služba by měla pro úlohu vytvořit nového uživatele.

AutoUserSpecification

Určuje parametry pro automatického uživatele, který spouští úlohu ve službě Batch.

Name	Typ	Description
elevationLevel	ElevationLevel	Úroveň zvýšení oprávnění automatického uživatele. Výchozí hodnota je nonAdmin.
scope	AutoUserScope	Obor automatického uživatele Výchozí hodnota je fond. Pokud fond používá Systém Windows, měla by být zadána hodnota Úloha, pokud je vyžadována přísnější izolace mezi úkoly. Pokud například úloha zmutuje registr způsobem, který by mohl mít vliv na jiné úlohy, nebo pokud byly ve fondu zadány certifikáty, které by neměly být přístupné pro běžné úlohy, ale měly by být přístupné pro StartTasks.

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.

CloudTask

Úkol Azure Batch.

Name	Typ	Description
affinityInfo	AffinityInformation	Tip lokality, který může služba Batch použít k výběru výpočetního uzlu, na kterém se má nový úkol spustit.
applicationPackageReferences	ApplicationPackageReference[]	Seznam balíčků, které služba Batch nasadí do výpočetního uzlu před spuštěním příkazového řádku. Balíčky aplikací se stahují a nasazují do sdíleného adresáře, nikoli do pracovního adresáře úloh. Proto pokud odkazovaný balíček je již na uzlu a je aktuální, pak není znovu stažen; Použije se existující kopie na výpočetním uzlu. Pokud odkazovaný balíček nelze nainstalovat, například proto, že balíček byl odstraněn nebo protože stahování selhalo, úloha selže.
authenticationTokenSettings	AuthenticationTokenSettings	Nastavení ověřovacího tokenu, který může úloha použít k provádění operací služby Batch. Pokud je tato vlastnost nastavená, služba Batch poskytne úloze ověřovací token, který lze použít k ověření operací služby Batch bez nutnosti přístupového klíče účtu. Token se poskytuje prostřednictvím proměnné prostředí AZ_BATCH_AUTHENTICATION_TOKEN. Operace, které může úloha provádět pomocí tokenu, závisí na nastavení. Úkol může například požádat o oprávnění úlohy, aby mohl do úlohy přidat další úkoly, nebo zkontrolovat stav úlohy nebo jiných úkolů v rámci úlohy.
commandLine	string	Příkazový řádek úkolu. V případě úloh s více instancemi se příkazový řádek spustí jako primární úloha po dokončení primární úlohy a všech dílčích úkolů spuštění koordinačního příkazového řádku. Příkazový řádek se nespouští v prostředí, a proto nemůže využívat funkce prostředí, jako je rozšíření proměnné prostředí. Pokud chcete tyto funkce využít, měli byste vyvolat prostředí v příkazovém řádku, například pomocí příkazu "cmd /c MyCommand" ve Windows nebo "/bin/sh -c MyCommand" v Linuxu. Pokud příkazový řádek odkazuje na cesty k souborům, měl by použít relativní cestu (vzhledem k pracovnímu adresáři úkolů) nebo proměnnou prostředí poskytnutou službou Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
constraints	TaskConstraints	Omezení provádění, která se vztahují na tuto úlohu.
containerSettings	TaskContainerSettings	Nastavení kontejneru, ve kterém se úloha spouští. Pokud má fond, který bude tuto úlohu spouštět, nastavený parametr containerConfiguration, musí se nastavit také. Pokud fond, který bude tuto úlohu spouštět, nemá nastavený parametr containerConfiguration, nesmí se nastavit. Při zadání se všechny adresáře rekurzivně pod AZ_BATCH_NODE_ROOT_DIR (kořen Azure Batch adresářů na uzlu) namapují do kontejneru, všechny proměnné prostředí task se mapují do kontejneru a příkazový řádek Task se spustí v kontejneru. Soubory vytvořené v kontejneru mimo AZ_BATCH_NODE_ROOT_DIR se nemusí projevit na disku hostitele, což znamená, že rozhraní API pro soubory služby Batch nebudou mít k těmto souborům přístup.
creationTime	string	Čas vytvoření úkolu.
dependsOn	TaskDependencies	Úkoly, na které závisí tento úkol. Tato úloha nebude naplánována, dokud nebudou úspěšně dokončeny všechny úkoly, na kterých závisí. Pokud některá z těchto úloh selže a vyčerpá počet opakování, nebude tato úloha nikdy naplánována.
displayName	string	Zobrazovaný název úkolu. Zobrazovaný název nemusí být jedinečný a může obsahovat jakékoli znaky Unicode až do maximální délky 1024.
eTag	string	Značka ETag úkolu. Jedná se o neprůzrůzný řetězec. Můžete ho použít ke zjištění, jestli se úloha mezi požadavky změnila. Konkrétně můžete při aktualizaci úkolu předat ETag a určit, že se změny projeví pouze v případě, že mezitím úkol nikdo jiný neupraví.
environmentSettings	EnvironmentSetting[]	Seznam nastavení proměnných prostředí pro úlohu.
executionInfo	TaskExecutionInformation	Informace o provádění úlohy.
exitConditions	ExitConditions	Určuje, jak má služba Batch reagovat na dokončení úlohy. Jak by měla služba Batch reagovat na dokončení úlohy.
id	string	Řetězec, který jednoznačně identifikuje úkol v rámci úlohy. ID může obsahovat libovolnou kombinaci alfanumerických znaků včetně spojovníků a podtržítků a nesmí obsahovat více než 64 znaků.
lastModified	string	Čas poslední změny úkolu.
multiInstanceSettings	MultiInstanceSettings	Objekt, který označuje, že úloha je úloha s více instancemi a obsahuje informace o tom, jak spustit úlohu s více instancemi. Úlohy s více instancemi se běžně používají k podpoře úloh MPI. Pokud v případě MPI některý z dílčích úkolů selže (například kvůli ukončení s nenulovým ukončovacím kódem), celá úloha s více instancemi selže. Úloha s více instancemi se pak ukončí a zopakuje až do limitu opakování.
nodeInfo	ComputeNodeInformation	Informace o výpočetním uzlu, na kterém se úloha spustila.
outputFiles	OutputFile[]	Seznam souborů, které služba Batch nahraje z výpočetního uzlu po spuštění příkazového řádku. U úkolů s více instancemi se soubory nahrají jenom z výpočetního uzlu, na kterém se provádí primární úkol.
previousState	TaskState	Předchozí stav úkolu. Tato vlastnost není nastavena, pokud je úkol v počátečním stavu Aktivní.
previousStateTransitionTime	string	Čas, kdy úkol vstoupil do předchozího stavu. Tato vlastnost není nastavena, pokud je úkol v počátečním stavu Aktivní.
requiredSlots	integer	Počet slotů plánování, které úloha vyžaduje ke spuštění. Výchozí hodnota je 1. Úkol lze naplánovat tak, aby běžel na výpočetním uzlu pouze v případě, že má uzel k dispozici dostatek volných slotů plánování. Pro úlohy s více instancemi to musí být 1.
resourceFiles	ResourceFile[]	Seznam souborů, které služba Batch stáhne do výpočetního uzlu před spuštěním příkazového řádku. U úloh s více instancemi se soubory prostředků stáhnou jenom do výpočetního uzlu, na kterém se provádí primární úkol. Pro seznam souborů prostředků platí maximální velikost. Při překročení maximální velikosti požadavek selže a kód chyby odpovědi bude RequestEntityTooLarge. Pokud k tomu dojde, musí se zmenšit velikost kolekce ResourceFiles. Toho můžete dosáhnout pomocí souborů .zip, balíčků aplikací nebo kontejnerů Dockeru.
state	TaskState	Aktuální stav úkolu.
stateTransitionTime	string	Čas, kdy úkol vstoupil do aktuálního stavu.
stats	TaskStatistics	Statistika využití zdrojů pro úkol.
url	string	Adresa URL úkolu.
userIdentity	UserIdentity	Identita uživatele, pod kterou je úloha spuštěna. Pokud tento parametr vynecháte, spustí se úloha jako uživatel bez oprávnění správce, který je pro úlohu jedinečný.

ComputeNodeIdentityReference

Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude výpočetní uzel používat.

Name	Typ	Description
resourceId	string	ID prostředku ARM identity přiřazené uživatelem.

ComputeNodeInformation

Informace o výpočetním uzlu, na kterém se úloha spustila.

Name	Typ	Description
affinityId	string	Identifikátor uzlu, na kterém byl úkol spuštěn, který lze předat při přidávání úkolu, který vyžaduje naplánování úkolu na tomto výpočetním uzlu.
nodeId	string	ID výpočetního uzlu, na kterém se úloha spustila.
nodeUrl	string	Adresa URL výpočetního uzlu, na kterém se úloha spustila.
poolId	string	ID fondu, ve kterém se úloha spustila.
taskRootDirectory	string	Kořenový adresář úlohy na výpočetním uzlu.
taskRootDirectoryUrl	string	Adresa URL kořenového adresáře úlohy na výpočetním uzlu.

ContainerRegistry

Privátní registr kontejneru.

Name	Typ	Description
identityReference	ComputeNodeIdentityReference	Odkaz na identitu přiřazenou uživatelem, která se použije pro přístup k Azure Container Registry místo uživatelského jména a hesla. Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude výpočetní uzel používat.
password	string	Heslo pro přihlášení k serveru registru.
registryServer	string	Adresa URL registru. Pokud ho vynecháte, výchozí hodnota je "docker.io".
username	string	Uživatelské jméno pro přihlášení k serveru registru.

ContainerWorkingDirectory

Umístění pracovního adresáře úloh kontejneru.

Name	Typ	Description
containerImageDefault	string	Použijte pracovní adresář definovaný v imagi kontejneru. Mějte na pozoru, že tento adresář nebude obsahovat soubory prostředků stažené službou Batch.
taskWorkingDirectory	string	Použijte standardní pracovní adresář úkolů služby Batch, který bude obsahovat soubory zdrojů úkolů naplněné službou Batch.

DependencyAction

Akce, kterou služba Batch provádí u úloh, které jsou na této úloze závislé.

Name	Typ	Description
block	string	Blokuje úkoly čekající na tento úkol a brání jejich naplánování.
satisfy	string	Splnění úkolů čekajících na tento úkol; Jakmile budou všechny závislosti splněny, bude úloha naplánovaná na spuštění.

ElevationLevel

Úroveň zvýšení oprávnění uživatele.

Name	Typ	Description
admin	string	Uživatel je uživatel se zvýšeným přístupem a pracuje s úplnými oprávněními správce.
nonadmin	string	Uživatel je standardní uživatel bez zvýšeného přístupu.

EnvironmentSetting

Proměnná prostředí, která má být nastavena pro proces úlohy.

Name	Typ	Description
name	string	Název proměnné prostředí.
value	string	Hodnota proměnné prostředí.

ErrorCategory

Kategorie chyby.

Name	Typ	Description
servererror	string	Příčinou chyby je interní problém se serverem.
usererror	string	Příčinou chyby je problém s uživatelem, například chybná konfigurace.

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

ExitCodeMapping

Jak by měla služba Batch reagovat, když se úloha ukončí s konkrétním ukončovacím kódem.

Name	Typ	Description
code	integer	Ukončovací kód procesu.
exitOptions	ExitOptions	Jak by měla služba Batch reagovat, pokud se úloha ukončí s tímto ukončovacím kódem.

ExitCodeRangeMapping

Rozsah ukončovací kódy a způsob, jakým má služba Batch reagovat na ukončovací kódy v daném rozsahu.

Name	Typ	Description
end	integer	Poslední ukončovací kód v rozsahu.
exitOptions	ExitOptions	Jak by měla služba Batch reagovat, pokud se úloha ukončí s ukončovacím kódem v rozsahu od začátku do konce (včetně).
start	integer	První ukončovací kód v rozsahu.

ExitConditions

Určuje, jak má služba Batch reagovat na dokončení úlohy.

Name	Typ	Description
default	ExitOptions	Jak by měla služba Batch reagovat, pokud úloha selže s výstupní podmínkou, která není pokryta žádnou z ostatních vlastností. Tato hodnota se používá, pokud úloha skončí s jakýmkoli nenulovým ukončovacím kódem, který není uveden v kolekci exitCodes nebo exitCodeRanges, s chybou předběžného zpracování, pokud není k dispozici vlastnost preProcessingError, nebo s chybou nahrávání souboru, pokud vlastnost fileUploadError neexistuje. Pokud chcete pro ukončovací kód 0 použít jiné než výchozí chování, musíte ho explicitně vypsat pomocí kolekce exitCodes nebo exitCodeRanges.
exitCodeRanges	ExitCodeRangeMapping[]	Seznam rozsahů ukončovacích kódů úlohy a způsob, jakým na ně má služba Batch reagovat.
exitCodes	ExitCodeMapping[]	Seznam jednotlivých ukončovací kódy úkolu a způsob, jakým na ně má služba Batch reagovat.
fileUploadError	ExitOptions	Jak by měla služba Batch reagovat, pokud dojde k chybě nahrávání souboru. Pokud úloha skončila s ukončovacím kódem zadaným prostřednictvím exitCodes nebo exitCodeRanges a pak došlo k chybě nahrávání souboru, bude mít přednost akce určená ukončovacím kódem.
preProcessingError	ExitOptions	Jak by měla služba Batch reagovat, pokud se úloha nespustí kvůli chybě.

ExitOptions

Určuje, jak služba Batch reaguje na konkrétní ukončovací podmínku.

Name	Typ	Description
dependencyAction	DependencyAction	Akce, kterou služba Batch provádí u úkolů závislých na tomto úkolu. Možné hodnoty jsou "satisfy" (umožňující průběh závislých úkolů) a "block" (závislé úkoly nadále čekají). Služba Batch zatím nepodporuje zrušení závislých úkolů.
jobAction	JobAction	Akce, která se má provést u úlohy obsahující úkol, pokud se úkol dokončí s danou výstupní podmínkou a vlastností úlohy onTaskFailed je performExitOptionsJobAction. Výchozí hodnota je none pro ukončovací kód 0 a ukončení pro všechny ostatní podmínky ukončení. Pokud je vlastnost úlohy onTaskFailed noaction, zadání této vlastnosti vrátí chybu a požadavek přidat úkol selže s chybou neplatné hodnoty vlastnosti; Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 400 (Chybný požadavek).

HttpHeader

Pár název-hodnota hlavičky HTTP

Name	Typ	Description
name	string	Název hlavičky, která se má použít při nahrávání výstupních souborů, nerozlišují malá a velká písmena.
value	string	Hodnota hlavičky, která se má použít při nahrávání výstupních souborů

JobAction

Akce, která se má provést s úlohou obsahující úlohu, pokud se úkol dokončí s danou výstupní podmínkou a vlastnost úlohy onTaskFailed je performExitOptionsJobAction.

Name	Typ	Description
disable	string	Zakažte úlohu. To je ekvivalent volání rozhraní API pro úlohy disable s hodnotou disableTasks requeue.
none	string	Nechejte žádnou akci.
terminate	string	Ukončete úlohu. TerminateReason v sadě ExecutionInfo úlohy je nastavená na TaskFailed.

MultiInstanceSettings

Nastavení určující, jak spustit úlohu s více instancemi.

Name	Typ	Description
commonResourceFiles	ResourceFile[]	Seznam souborů, které služba Batch stáhne před spuštěním příkazového řádku pro koordinaci. Rozdíl mezi soubory společných zdrojů a soubory zdrojů úkolů spočívá v tom, že společné soubory zdrojů se stahují pro všechny dílčí úkoly včetně primárního, zatímco soubory zdrojů úkolů se stahují jenom pro primární. Všimněte si také, že tyto soubory prostředků se nestáhnou do pracovního adresáře úloh, ale do kořenového adresáře úlohy (jeden adresář nad pracovním adresářem). Pro seznam souborů prostředků platí maximální velikost. Při překročení maximální velikosti požadavek selže a kód chyby odpovědi bude RequestEntityTooLarge. Pokud k tomu dojde, musí se zmenšit velikost kolekce ResourceFiles. Toho můžete dosáhnout pomocí souborů .zip, balíčků aplikací nebo kontejnerů Dockeru.
coordinationCommandLine	string	Příkazový řádek, který se spustí na všech výpočetních uzlech, aby mohly koordinovat, když primární uzel spustí hlavní příkaz Task. Typický koordinační příkazový řádek spustí službu na pozadí a ověří, že je připravená zpracovávat zprávy mezi uzly.
numberOfInstances	integer	Počet výpočetních uzlů požadovaných úlohou. Pokud ho vynecháte, výchozí hodnota je 1.

NameValuePair

Představuje dvojici název-hodnota.

Name	Typ	Description
name	string	Název ve dvojici název-hodnota.
value	string	Hodnota ve dvojici název-hodnota.

OutputFile

Specifikace pro nahrávání souborů z Azure Batch výpočetního uzlu do jiného umístění po dokončení procesu úkolu službou Batch.

Name	Typ	Description
destination	OutputFileDestination	Cíl pro výstupní soubory.
filePattern	string	Vzor označující, které soubory se mají nahrát. Podporují se relativní i absolutní cesty. Relativní cesty jsou relativní vzhledem k pracovnímu adresáři úkolů. Podporují se následující zástupné znaky: * odpovídá 0 nebo více znakům (například vzor abc* odpovídá abc nebo abcdef), ** odpovídá jakémukoli adresáři, ? odpovídá jakémukoli jednotlivému znaku, [abc] odpovídá jednomu znaku v hranatých závorkách a [a-c] odpovídá jednomu znaku v rozsahu. Hranaté závorky můžou obsahovat negaci odpovídající libovolnému nezadanému znaku (například [!abc] odpovídá libovolnému znaku kromě a, b nebo c). Pokud název souboru začíná na . je ve výchozím nastavení ignorován, ale může se shodovat explicitním zadáním (například .gif nebude odpovídat .a.gif, ale ..gif bude). Jednoduchý příklad: ***.txt odpovídá libovolnému souboru, který nezačíná na ., a končí .txt v pracovním adresáři úkolu nebo v libovolném podadresáři. Pokud název souboru obsahuje zástupný znak, můžete ho utéct pomocí hranatých závorek (například abc[] odpovídá souboru s názvem abc). Všimněte si, že \ i / jsou ve Windows považovány za oddělovače adresářů, ale pouze / je v Linuxu. Proměnné prostředí (%var% ve Windows nebo $var v Linuxu) jsou před použitím vzoru rozbalené.
uploadOptions	OutputFileUploadOptions	Další možnosti operace nahrávání, včetně toho, za jakých podmínek se má nahrávání provést.

OutputFileBlobContainerDestination

Určuje cíl pro nahrání souboru v kontejneru úložiště objektů blob v Azure.

Name	Typ	Description
containerUrl	string	Adresa URL kontejneru v rámci Azure Blob Storage, do které se mají nahrát soubory. Pokud spravovanou identitu nepoužíváte, musí adresa URL obsahovat sdílený přístupový podpis (SAS) udělující oprávnění k zápisu do kontejneru.
identityReference	ComputeNodeIdentityReference	Odkaz na identitu přiřazenou uživatelem, která se má použít pro přístup k Azure Blob Storage určené pomocí containerUrl Identita musí mít oprávnění k zápisu do kontejneru Azure Blob Storage.
path	string	Cílový objekt blob nebo virtuální adresář v kontejneru Azure Storage. Pokud filePattern odkazuje na konkrétní soubor (tj. neobsahuje žádné zástupné é kódy), pak cesta je název objektu blob, do kterého se má soubor nahrát. Pokud filePattern obsahuje jeden nebo více zástupných znaků (a proto se může shodovat s více soubory), pak cesta je název virtuálního adresáře objektů blob (který je před každým názvem objektu blob), do kterého se mají nahrát soubory. Pokud je vynechán, soubory se nahrají do kořenového adresáře kontejneru s názvem objektu blob, který odpovídá názvu souboru.
uploadHeaders	HttpHeader[]	Seznam dvojic název-hodnota pro hlavičky, které se mají použít při nahrávání výstupních souborů Tyto hlavičky se zadají při nahrávání souborů do služby Azure Storage. Oficiální dokument o povolených hlavicích při nahrávání objektů blob: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

Cíl, do kterého se má soubor nahrát.

Name	Typ	Description
container	OutputFileBlobContainerDestination	Umístění v úložišti objektů blob v Azure, do kterého se nahrají soubory.

OutputFileUploadCondition

Podmínky, za kterých se má nahrát výstupní soubor úkolu nebo sada souborů.

Name	Typ	Description
taskcompletion	string	Po ukončení procesu úlohy nahrajte soubory bez ohledu na to, jaký byl ukončovací kód.
taskfailure	string	Nahrajte soubory až po ukončení procesu úlohy s nenulovým ukončovacím kódem.
tasksuccess	string	Nahrajte soubory až po ukončení procesu úlohy s ukončovacím kódem 0.

OutputFileUploadOptions

Podrobnosti o operaci nahrávání výstupního souboru, včetně toho, za jakých podmínek se má nahrávání provést.

Name	Typ	Description
uploadCondition	OutputFileUploadCondition	Podmínky, za kterých se má výstupní soubor úkolu nebo sada souborů nahrát. Výchozí hodnota je taskcompletion.

ResourceFile

Jeden soubor nebo více souborů ke stažení do výpočetního uzlu.

Name	Typ	Description
autoStorageContainerName	string	Název kontejneru úložiště v účtu automatického úložiště. Vlastnosti autoStorageContainerName, storageContainerUrl a httpUrl se vzájemně vylučují a jeden z nich musí být zadán.
blobPrefix	string	Předpona objektu blob, která se má použít při stahování objektů blob z kontejneru Azure Storage. Stáhnou se jenom objekty blob, jejichž názvy začínají zadanou předponou. Vlastnost je platná pouze v případě, že se používá autoStorageContainerName nebo storageContainerUrl. Touto předponou může být částečný název souboru nebo podadresář. Pokud předpona není zadaná, stáhnou se všechny soubory v kontejneru.
fileMode	string	Atribut režimu oprávnění k souboru v osmičkovém formátu. Tato vlastnost se vztahuje pouze na soubory stahované do výpočetních uzlů s Linuxem. Pokud je zadaný pro prostředekFile, který se stáhne do výpočetního uzlu Windows, bude ignorován. Pokud tato vlastnost není určena pro výpočetní uzel s Linuxem, použije se pro soubor výchozí hodnota 0770.
filePath	string	Umístění na výpočetním uzlu, do kterého se mají soubory stáhnout, vzhledem k pracovnímu adresáři úkolu. Pokud je zadána vlastnost httpUrl, parametr filePath je povinný a popisuje cestu, do které se soubor stáhne, včetně názvu souboru. Jinak pokud je zadána vlastnost autoStorageContainerName nebo storageContainerUrl, je parametr filePath volitelný a jedná se o adresář ke stažení souborů. V případě, že se filePath použije jako adresář, jakákoli adresářová struktura, která je již přidružena ke vstupním datům, se zachovají v plném rozsahu a připojí se k zadanému adresáři filePath. Zadaná relativní cesta nemůže přerušit pracovní adresář úkolu (například pomocí ..).
httpUrl	string	Adresa URL souboru, který se má stáhnout. Vlastnosti autoStorageContainerName, storageContainerUrl a httpUrl se vzájemně vylučují a jeden z nich musí být zadán. Pokud adresa URL odkazuje na Azure Blob Storage, musí být čitelná z výpočetních uzlů. Existují tři způsoby, jak získat takovou adresu URL objektu blob v úložišti Azure: zahrnují sdílený přístupový podpis (SAS) udělující oprávnění ke čtení objektu blob, použití spravované identity s oprávněním ke čtení nebo nastavení seznamu ACL pro objekt blob nebo jeho kontejner tak, aby umožňoval veřejný přístup.
identityReference	ComputeNodeIdentityReference	Odkaz na identitu přiřazenou uživatelem pro přístup k Azure Blob Storage určený storageContainerUrl nebo httpUrl Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude výpočetní uzel používat.
storageContainerUrl	string	Adresa URL kontejneru objektů blob v rámci Azure Blob Storage. Vlastnosti autoStorageContainerName, storageContainerUrl a httpUrl se vzájemně vylučují a jeden z nich musí být zadán. Tato adresa URL musí být čitelná a vypsatelná z výpočetních uzlů. Existují tři způsoby, jak takovou adresu URL pro kontejner v úložišti Azure získat: zahrnují sdílený přístupový podpis (SAS) udělující oprávnění ke čtení a výpisu kontejneru, použití spravované identity s oprávněními ke čtení a výpisu nebo nastavení seznamu ACL pro kontejner tak, aby umožňoval veřejný přístup.

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.

TaskContainerExecutionInformation

Obsahuje informace o kontejneru, který úloha provádí.

Name	Typ	Description
containerId	string	ID kontejneru.
error	string	Podrobné informace o chybě o kontejneru Toto je podrobný řetězec chyby ze služby Dockeru, pokud je k dispozici. Je ekvivalentní chybovému poli, které vrátil docker inspect.
state	string	Stav kontejneru. Toto je stav kontejneru podle služby Dockeru. Je ekvivalentní poli stavu, které vrátil docker inspect.

TaskContainerSettings

Nastavení kontejneru pro úlohu.

Name	Typ	Description
containerRunOptions	string	Další možnosti příkazu container create Tyto další možnosti jsou kromě možností řízených službou Batch k dispozici jako argumenty příkazu docker create.
imageName	string	Image, která se má použít k vytvoření kontejneru, ve kterém bude úloha spuštěna. Toto je úplný odkaz na image, jak by bylo určeno pro "docker pull". Pokud se jako součást názvu image nezadá žádná značka, použije se jako výchozí značka :latest.
registry	ContainerRegistry	Privátní registr, který obsahuje image kontejneru. Toto nastavení můžete vynechat, pokud už bylo zadané při vytváření fondu.
workingDirectory	ContainerWorkingDirectory	Umístění pracovního adresáře úloh kontejneru. Výchozí hodnota je taskWorkingDirectory.

TaskDependencies

Určuje všechny závislosti úlohy. Každá úloha, která je explicitně určena nebo v rozsahu závislostí, musí být dokončena před naplánování závislé úlohy.

Name	Typ	Description
taskIdRanges	TaskIdRange[]	Seznam rozsahů ID úlohy, na které závisí tento úkol. Před naplánování závislé úlohy musí být všechny úkoly ve všech oblastech úspěšně dokončeny.
taskIds	string[]	Seznam ID úkolů, na které závisí tento úkol. Všechny úkoly v tomto seznamu musí být úspěšně dokončeny před tím, než bude možné naplánovat závislý úkol. Kolekce taskIds je omezená na celkem 64 000 znaků (tj. celková délka všech ID úkolů). Pokud kolekce taskIds překročí maximální délku, požadavek Přidat úlohu selže s kódem chyby TaskDependencyListTooLong. V takovém případě zvažte místo toho použití rozsahů ID úlohy.

TaskExecutionInformation

Informace o provádění úlohy.

Name	Typ	Description
containerInfo	TaskContainerExecutionInformation	Informace o kontejneru, ve kterém se úloha spouští. Tato vlastnost je nastavena pouze v případě, že úloha běží v kontextu kontejneru.
endTime	string	Čas dokončení úkolu. Tato vlastnost je nastavena pouze v případě, že je úkol ve stavu Dokončeno.
exitCode	integer	Ukončovací kód programu zadaný na příkazovém řádku úkolu. Tato vlastnost je nastavena pouze v případě, že je úkol v dokončeném stavu. Obecně platí, že ukončovací kód procesu odráží konkrétní konvenci implementovanou vývojářem aplikace pro daný proces. Pokud k rozhodování v kódu použijete hodnotu ukončovacího kódu, ujistěte se, že znáte konvenci ukončovacího kódu používanou procesem aplikace. Pokud ale služba Batch úlohu ukončí (kvůli vypršení časového limitu nebo ukončení uživatele prostřednictvím rozhraní API), může se zobrazit ukončovací kód definovaný operačním systémem.
failureInfo	TaskFailureInformation	Informace popisující selhání úlohy, pokud existuje. Tato vlastnost je nastavena pouze v případě, že je úloha v dokončeném stavu a došlo k selhání.
lastRequeueTime	string	Poslední čas, kdy byla úloha znovu zadána službou Batch na základě požadavku uživatele. Tato vlastnost je nastavena pouze v případě, že hodnota requeueCount je nenulová.
lastRetryTime	string	Poslední čas, kdy se spustilo opakování úlohy. Tento prvek je k dispozici pouze v případě, že byl pokus o opakování úkolu (tj. retryCount je nenulový). Pokud je k dispozici, obvykle je to stejné jako startTime, ale může se lišit, pokud úloha byla restartována z jiných důvodů než opakování; Pokud například došlo k restartování výpočetního uzlu během opakování, čas spuštění se aktualizuje, ale hodnota lastRetryTime nikoli.
requeueCount	integer	Počet opětovného zařazení úlohy do fronty službou Batch v důsledku požadavku uživatele. Když uživatel odebere výpočetní uzly z fondu (změnou velikosti nebo zmenšením fondu) nebo když je úloha zakázaná, může uživatel určit, aby spuštěné úkoly na výpočetních uzlech byly znovu seřazeny do fronty ke spuštění. Tento počet sleduje, kolikrát byla úloha z těchto důvodů znovu zadaná do fronty.
result	TaskExecutionResult	Výsledek spuštění úlohy. Pokud je hodnota "failed", podrobnosti o selhání najdete ve vlastnosti failureInfo.
retryCount	integer	Kolikrát služba Batch úlohu zopakovala. Selhání aplikace úloh (nenulový ukončovací kód) se opakují, dojde k chybám předběžného zpracování (úloha se nedá spustit) a chyby odeslání souboru se neopakují. Služba Batch zopakuje úlohu až do limitu určeného omezeními.
startTime	string	Čas, kdy úloha začala běžet. Hodnota Spuštěno odpovídá stavu spuštěno, takže pokud úloha určuje soubory prostředků nebo balíčky, pak čas spuštění odráží čas, kdy úloha začala tyto soubory stahovat nebo nasazovat. Pokud se úloha restartovala nebo se zopakovala, jedná se o poslední čas, kdy se úloha spustila. Tato vlastnost je k dispozici pouze pro úlohy, které jsou ve spuštěném nebo dokončeném stavu.

TaskExecutionResult

Výsledek spuštění úlohy.

Name	Typ	Description
failure	string	Při zpracování úlohy došlo k chybě. K selhání mohlo dojít před spuštěním procesu úkolu, během provádění procesu úkolu nebo po ukončení procesu úkolu.
success	string	Úloha se úspěšně spustila.

TaskFailureInformation

Informace o selhání úlohy

Name	Typ	Description
category	ErrorCategory	Kategorie chyby Úlohy.
code	string	Identifikátor chyby úlohy. Kódy jsou invariantní a mají být využívány programově.
details	NameValuePair[]	Seznam dalších podrobností souvisejících s chybou
message	string	Zpráva popisující chybu Úlohy, která má být vhodná pro zobrazení v uživatelském rozhraní.

TaskIdRange

Rozsah ID úkolů, na které může úkol záviset. Všechny úkoly s ID v rozsahu musí být úspěšně dokončeny před naplánováním závislé úlohy.

Name	Typ	Description
end	integer	ID posledního úkolu v oblasti.
start	integer	Id prvního úkolu v oblasti.

TaskState

Stav úkolu.

Name	Typ	Description
active	string	Úloha je zařazená do fronty a může se spustit, ale aktuálně není přiřazená k výpočetnímu uzlu. Úloha přejde do tohoto stavu, když je vytvořena, když je povolena po zakázání nebo když čeká na opakování po neúspěšném spuštění.
completed	string	Úloha již není způsobilá ke spuštění, obvykle z důvodu úspěšného dokončení úlohy nebo neúspěšného dokončení a vyčerpání limitu opakování. Úkol je také označen jako dokončený, pokud při spouštění úlohy došlo k chybě nebo když byl úkol ukončen.
preparing	string	Úkol byl přiřazen výpočetnímu uzlu, ale čeká na dokončení požadovaného úkolu přípravy úlohy na výpočetním uzlu. Pokud je úkol přípravy úlohy úspěšný, přesune se do spuštěného úkolu. Pokud úkol přípravy úlohy selže, úkol se vrátí do aktivního a bude mít nárok na přiřazení k jinému výpočetnímu uzlu.
running	string	Úkol běží na výpočetním uzlu. To zahrnuje přípravu na úrovni úkolu, jako je stahování souborů prostředků nebo nasazení balíčků zadaných u úkolu – nemusí to nutně znamenat, že se spustil příkazový řádek úkolu.

TaskStatistics

Statistika využití zdrojů pro úkol.

Name	Typ	Description
kernelCPUTime	string	Celkový čas procesoru v režimu jádra (sečtený napříč všemi jádry a všemi výpočetními uzly) spotřebovaný úlohou.
lastUpdateTime	string	Čas, kdy byly statistiky naposledy aktualizovány. Všechny statistiky jsou omezené na rozsah mezi startTime a lastUpdateTime.
readIOGiB	number	Celkový počet gibibajtů přečtených z disku úlohou.
readIOps	integer	Celkový počet operací čtení z disku provedených úlohou.
startTime	string	Počáteční čas časového rozsahu, na který se statistika vztahuje.
url	string	Adresa URL statistiky.
userCPUTime	string	Celkový čas procesoru v uživatelském režimu (sečtený napříč všemi jádry a všemi výpočetními uzly) spotřebovaný úlohou.
waitTime	string	Celková doba čekání úlohy. Čekací doba úlohy je definována jako uplynulý čas mezi vytvořením úlohy a spuštěním úlohy. (Pokud se úloha zopakuje kvůli selháním, čekací doba je doba do posledního spuštění úlohy.)
wallClockTime	string	Celkový čas hodin úkolu. Čas časového limitu je uplynulý čas od spuštění úlohy na výpočetním uzlu do dokončení (nebo k poslední aktualizaci statistik, pokud se úkol do té doby nedokončil). Pokud byl úkol zopakován, zahrnuje to i čas hodin všech opakování úkolu.
writeIOGiB	number	Celkový počet gibibajtů zapsaných na disk úlohou.
writeIOps	integer	Celkový počet operací zápisu na disk provedených úlohou.

UserIdentity

Definice identity uživatele, pod kterou je úloha spuštěna.

Name	Typ	Description
autoUser	AutoUserSpecification	Automatický uživatel, pod kterým je úloha spuštěna. Vlastnosti userName a autoUser se vzájemně vylučují; musíte zadat jednu, ale ne obě.
username	string	Název identity uživatele, pod kterou je úloha spuštěna. Vlastnosti userName a autoUser se vzájemně vylučují; musíte zadat jednu, ale ne obě.