Task - Add

Přidá úkol do zadané úlohy.
Maximální doba života úkolu od doplnění k dokončení je 180 dní. Pokud se úloha nedokončila během 180 dnů od přidání, ukončí služba Batch a zůstane v jakémkoli stavu, ve kterém byla v daném čase.

POST {batchUrl}/jobs/{jobId}/tasks?api-version=2020-09-01.12.0
POST {batchUrl}/jobs/{jobId}/tasks?timeout={timeout}&api-version=2020-09-01.12.0

Parametry identifikátoru URI

Name In Required Type Description
batchUrl
path True
  • string

Základní adresa URL všech žádostí Azure Batch služby

jobId
path True
  • string

ID úlohy, ke které se má úkol přidat

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í žádosti (v sekundách). Výchozí hodnota je 30 sekund.

Hlavička požadavku

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

Name Required Type Description
client-request-id
  • string
uuid

Identita žádosti vygenerovaná volajícím, ve formě identifikátoru GUID bez dekorace, jako jsou například složené závorky, např. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id
  • boolean

Určuje, zda má server vrátit požadavek Client-Request-ID v odpovědi.

ocp-date
  • string
date-time-rfc1123

Čas vydání žádosti. Klientské knihovny jsou obvykle nastavené na aktuální systémový čas. nastavte ji explicitně, pokud voláte REST API přímo.

Text požadavku

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

Name Required Type Description
commandLine True
  • string

Příkazový řádek úkolu.
V případě úkolů s více instancemi je příkazový řádek spuštěn jako primární úkol, poté co primární úloha a všechny dílčí úkoly dokončily provádění koordinačního příkazového řádku. Příkazový řádek neběží pod prostředím, takže nemůže využít funkce prostředí, jako je například rozšíření proměnné prostředí. Chcete-li využít výhod těchto funkcí, 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 systému Linux. Pokud příkazový řádek odkazuje na cesty k souboru, měl by použít relativní cestu (relativní vzhledem k pracovnímu adresáři úkolu) nebo použít proměnnou prostředí dávkovou dávkou ( https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) .

id True
  • string

Řetězec, který jedinečně identifikuje úlohu v rámci úlohy.
ID může obsahovat libovolnou kombinaci alfanumerických znaků včetně spojovníků a podtržítka a nesmí obsahovat více než 64 znaků. V ID se nerozlišují velká a malá písmena (to znamená, že v rámci úlohy nesmíte mít dvě ID, která se liší pouze případem).

affinityInfo

Pomocný parametr místní hodnoty, 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

Seznam balíčků, které bude služba Batch nasazovat do výpočetního uzlu před spuštěním příkazového řádku.
Balíčky aplikací se stáhnou a nasazují do sdíleného adresáře, nikoli do pracovního adresáře úkolů. Proto pokud je už odkazovaný balíček na uzlu a je aktuální, pak se nestáhne znovu. použije se existující kopie na výpočetním uzlu. Pokud se odkazovaný balíček nedá nainstalovat, například proto, že balíček je odstraněný nebo protože stažení selhalo, úloha se nezdařila.

authenticationTokenSettings

Nastavení ověřovacího tokenu, které může úkol použít k provádění operací služby Batch.
Pokud je tato vlastnost nastavená, služba Batch poskytuje úlohu s ověřovacím tokenem, který se dá použít k ověřování operací služby Batch bez vyžadování přístupového klíče účtu. Token se poskytuje prostřednictvím proměnné prostředí AZ_BATCH_AUTHENTICATION_TOKEN. Operace, které úloha může provádět pomocí tokenu, závisí na nastavení. Úkol může například požádat o oprávnění úlohy, aby bylo možné do úlohy přidat další úkoly, nebo zjistit stav úlohy nebo dalších úloh v rámci úlohy.

constraints

Omezení provádění, která se vztahují na tento úkol.
Pokud nezadáte omezení, maxTaskRetryCount je maxTaskRetryCount pro úlohu, proměnné maxwallclocktime je nekonečno a retentionTime je 7 dní.

containerSettings

Nastavení kontejneru, pod kterým je úloha spuštěna.
Pokud fond, který spustí tuto úlohu, má containerConfiguration sadu, je nutné ji nastavit také. Pokud fond, který úlohu spustí, nemá containerConfiguration sadu, nesmí být nastavena. Je-li tento parametr zadán, budou všechny adresáře rekurzivně pod AZ_BATCH_NODE_ROOT_DIR (kořen Azure Batch adresářů na uzlu) mapovány do kontejneru, všechny proměnné prostředí úlohy jsou namapovány do kontejneru a příkazový řádek úkolu je spuštěn v kontejneru. Soubory vytvořené v kontejneru mimo AZ_BATCH_NODE_ROOT_DIR se nemusí odrazit na hostitelském disku, což znamená, že rozhraní API dávkového souboru nebudou mít přístup k těmto souborům.

dependsOn

Úkoly, na kterých tento úkol závisí.
Tato úloha nebude naplánována, dokud nebudou úspěšně dokončeny všechny úlohy, na kterých jsou závislé. Pokud některý z těchto úloh selže a vyčerpá jejich počet opakování, tato úloha nebude nikdy naplánována. Pokud úloha nemá usesTaskDependencies nastavenou na hodnotu true a tento prvek je přítomen, požadavek se nezdařil s kódem chyby TaskDependenciesNotSpecifiedOnJob.

displayName
  • string

Zobrazovaný název úlohy.
Zobrazovaný název nemusí být jedinečný a může obsahovat libovolné znaky Unicode až do maximální délky 1024.

environmentSettings

Seznam nastavení proměnných prostředí pro úlohu.

exitConditions

Určuje, jak má služba Batch reagovat po dokončení úlohy.
Způsob, jakým má služba Batch reagovat po dokončení úlohy.

multiInstanceSettings

Objekt, který označuje, že úkol je úloha s více instancemi, a obsahuje informace o tom, jak spustit úlohu s více instancemi.
Úkoly s více instancemi se běžně používají k podpoře úloh MPI. V případě, že se některý z dílčích úkolů nezdaří (například kvůli ukončení s nenulovým ukončovacím kódem), selže celá úloha s více instancemi. Úloha s více instancemi se pak ukončí a zopakuje, až do jejího limitu opakování.

outputFiles

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 budou nahrávat jenom z výpočetního uzlu, na kterém je primární úkol spuštěný.

requiredSlots
  • integer

Počet slotů plánování, které úloha vyžaduje pro spuštění.
Výchozí hodnota je 1. Úloha může být naplánována pouze na výpočetní uzel, pokud má uzel dostatek volných slotů k dispozici. U úkolů s více instancemi musí být 1.

resourceFiles

Seznam souborů, které služba Batch stáhne do výpočetního uzlu před spuštěním příkazového řádku.
Pro úlohy s více instancemi se soubory prostředků stáhnou jenom do výpočetního uzlu, na kterém je primární úkol spuštěný. Existuje maximální velikost seznamu souborů prostředků. Při překročení maximální velikosti se požadavek nezdaří a kód chyby odpovědi bude RequestEntityTooLarge. Pokud k tomu dojde, musí být kolekce ResourceFiles zmenšena velikosti. Toho lze dosáhnout pomocí souborů. zip, balíčků aplikací nebo kontejnerů Docker.

userIdentity

Identita uživatele, pod kterou je úloha spuštěna.
Je-li tento parametr vynechán, je úloha spuštěna jako uživatel bez oprávnění správce, který je pro úkol jedinečný.

Odpovědi

Name Type Description
201 Created

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

Chyba služby Batch.

Zabezpečení

azure_auth

Azure Active Directory tok OAuth2

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

Add a basic task
Add a task with container settings
Add a task with exit conditions
Add a task with extra slot requirement

Add a basic task

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "task1",
  "commandLine": "cmd /c echo task1"
}

Sample Response

Add a task with container settings

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "taskId",
  "commandLine": "bash -c 'echo hello'",
  "containerSettings": {
    "imageName": "ubuntu",
    "containerRunOptions": "--rm"
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Sample Response

Add a task with exit conditions

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "taskId",
  "commandLine": "cmd /c exit 3",
  "exitConditions": {
    "exitCodeRanges": [
      {
        "start": 2,
        "end": 4,
        "exitOptions": {
          "jobAction": "terminate"
        }
      }
    ]
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Sample Response

Add a task with extra slot requirement

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "task1",
  "requiredSlots": 2,
  "commandLine": "cmd /c echo task1"
}

Sample Response

Definice

AffinityInformation

Pomocný parametr místní hodnoty, který může služba Batch použít k výběru výpočetního uzlu, na kterém se má úloha 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 úkol použít k provádění operací služby Batch.

AutoUserScope

Rozsah pro automatického uživatele

AutoUserSpecification

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

BatchError

Od služby Azure Batch přijata chybová odpověď.

BatchErrorDetail

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

ContainerRegistry

Privátní registr kontejnerů.

ContainerWorkingDirectory

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

DependencyAction

Akce, kterou služba Batch provede pro úlohy, které jsou závislé na této úloze.

ElevationLevel

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

EnvironmentSetting

Proměnná prostředí, která se má nastavit pro proces úlohy.

ErrorMessage

Chybová zpráva byla přijata v odpovědi na chybu Azure Batch.

ExitCodeMapping

Způsob, jakým má služba Batch reagovat, pokud se úloha ukončí s určitým ukončovacím kódem.

ExitCodeRangeMapping

Rozsah ukončovacích kódů a způsob, jakým služba Batch reaguje na ukončovací kódy v rámci daného rozsahu.

ExitConditions

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

ExitOptions

Určuje, jak služba Batch reaguje na určitou podmínku ukončení.

JobAction

Akce, která se má provést u úlohy obsahující úlohu, pokud se úloha dokončí s daným výstupním stavem a vlastností onTaskFailed úlohy je "performExitOptionsJobAction".

MultiInstanceSettings

Nastavení, které určuje, jak se má spustit úloha s více instancemi

OutputFile

Specifikace pro nahrávání souborů z Azure Batch výpočetního uzlu do jiného umístění poté, co služba Batch dokončila provádění procesu úlohy.

OutputFileBlobContainerDestination

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

OutputFileDestination

Cíl, do kterého má být soubor nahrán.

OutputFileUploadCondition

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

OutputFileUploadOptions

Podrobnosti o operaci odeslá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ů, které se mají stáhnout do výpočetního uzlu.

TaskAddParameter

Azure Batch úkol, který se má přidat

TaskConstraints

Omezení spouštění pro použití pro úlohu.

TaskContainerSettings

Nastavení kontejneru pro úlohu.

TaskDependencies

Určuje všechny závislosti úkolu. Všechny úkoly, které jsou explicitně zadány nebo v rozsahu závislosti, musí být dokončeny, aby se naplánovala závislá úloha.

TaskIdRange

Rozsah ID úkolů, na kterém může úkol záviset. Všechny úlohy s ID v rozsahu musí být úspěšně dokončeny, aby bylo možné naplánovat závislou úlohu.

UserIdentity

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

AffinityInformation

Pomocný parametr místní hodnoty, který může služba Batch použít k výběru výpočetního uzlu, na kterém se má úloha spustit.

Name Type Description
affinityId
  • string

Neprůhledný řetězec představující umístění výpočetního uzlu nebo úlohy, která byla spuštěna dříve.
Můžete předat affinityId uzlu, abyste označili, že tato úloha musí běžet na tomto výpočetním uzlu. Všimněte si, že toto je pouze měkké spřažení. Pokud je cílový výpočetní uzel zaneprázdněný nebo nedostupný v době, kdy je úkol naplánován, bude úkol naplánovaný jinde.

ApplicationPackageReference

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

Name Type Description
applicationId
  • string

ID aplikace, která se má nasadit

version
  • string

Verze aplikace, která se má nasadit Je-li tento parametr vynechán, je nasazena výchozí verze.
Pokud je tento parametr vynechán v rámci fondu a pro tuto aplikaci není zadána žádná výchozí verze, požadavek se nezdařil s kódem chyby InvalidApplicationPackageReferences a stavovým kódem HTTP 409. Pokud je tato operace vynechána u úlohy a pro tuto aplikaci není zadána žádná výchozí verze, úloha se nezdařila s chybou předběžného zpracování.

AuthenticationTokenSettings

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

Name Type Description
access
  • string[]

Prostředky Batch, ke kterým token uděluje přístup.
Ověřovací token uděluje přístup k omezené sadě operací služby Batch. Aktuálně jediná podporovaná hodnota pro vlastnost Access je "Job", která uděluje přístup ke všem operacím souvisejícím s úlohou, která úlohu obsahuje.

AutoUserScope

Rozsah pro automatického uživatele

Name Type Description
pool
  • string

Určuje, že se úloha spouští jako společný automatický uživatelský účet, který se vytvoří na všech výpočetních uzlech ve fondu.

task
  • string

Určuje, že by služba 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 Type Description
elevationLevel

Úroveň zvýšení úrovně automatického uživatele.
Výchozí hodnota je nesprávce.

scope

Rozsah pro automatického uživatele
Výchozí hodnota je fond. Pokud fond používá systém Windows, musí být zadána hodnota úlohy, pokud je vyžadována přísnější izolace mezi úkoly. Například pokud úloha prochází registr způsobem, který by mohl ovlivnit jiné úkoly, 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

Od služby Azure Batch přijata chybová odpověď.

Name Type Description
code
  • string

Identifikátor chyby Kódy jsou invariantní a mají být zpracovány programově.

message

Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.

values

Kolekce párů klíč-hodnota, které obsahují další podrobnosti o chybě.

BatchErrorDetail

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

Name Type Description
key
  • string

Identifikátor určující význam vlastnosti Value.

value
  • string

Další informace, které jsou součástí chybové odpovědi.

ContainerRegistry

Privátní registr kontejnerů.

Name Type Description
password
  • string

Heslo pro přihlášení k serveru registru.

registryServer
  • string

Adresa URL registru.
Je-li tento parametr vynechán, bude použita výchozí hodnota "docker.io".

username
  • string

Uživatelské jméno pro přihlášení k serveru registru.

ContainerWorkingDirectory

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

Name Type Description
containerImageDefault
  • string

Použijte pracovní adresář definovaný v imagi kontejneru. Upozorňujeme, že tento adresář nebude obsahovat soubory prostředků stažené službou Batch.

taskWorkingDirectory
  • string

Použijte standardní pracovní adresář úlohy služby Batch, který bude obsahovat soubory prostředků úkolu vyplněné dávkou.

DependencyAction

Akce, kterou služba Batch provede pro úlohy, které jsou závislé na této úloze.

Name Type Description
block
  • string

Blokuje úlohy, které čekají na tomto úkolu, a brání tak jejich naplánování.

satisfy
  • string

Vyhovět úlohám čekajícím na tuto úlohu; po splnění všech závislostí bude naplánováno spuštění úlohy.

ElevationLevel

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

Name Type Description
admin
  • string

Uživatel je uživatel se zvýšeným přístupem a pracuje s oprávněními úplný správce.

nonadmin
  • string

Uživatel je standardním uživatelem bez přístupu se zvýšeným oprávněním.

EnvironmentSetting

Proměnná prostředí, která se má nastavit pro proces úlohy.

Name Type Description
name
  • string

Název proměnné prostředí

value
  • string

Hodnota proměnné prostředí.

ErrorMessage

Chybová zpráva byla přijata v odpovědi na chybu Azure Batch.

Name Type Description
lang
  • string

Kód jazyka chybové zprávy

value
  • string

Text zprávy

ExitCodeMapping

Způsob, jakým má služba Batch reagovat, pokud se úloha ukončí s určitým ukončovacím kódem.

Name Type Description
code
  • integer

Ukončovací kód procesu.

exitOptions

Způsob, jakým má služba Batch reagovat, pokud se úloha ukončí pomocí tohoto ukončovacího kódu.

ExitCodeRangeMapping

Rozsah ukončovacích kódů a způsob, jakým služba Batch reaguje na ukončovací kódy v rámci daného rozsahu.

Name Type Description
end
  • integer

Poslední ukončovací kód v rozsahu.

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 po dokončení úlohy.

Name Type Description
default

Jak by měla služba Batch reagovat, pokud se úloha nezdařila s podmínkou ukončení, která není pokryta žádnou z ostatních vlastností.
Tato hodnota se používá v případě, že se úloha ukončí s žádným nenulovým ukončovacím kódem, který není uveden v kolekci exitCodes nebo exitCodeRanges, pokud není k dispozici vlastnost preProcessingError nebo pokud není k dispozici chyba nahrávání souboru, pokud není přítomna vlastnost fileUploadError. Pokud chcete, aby se při ukončovacím kódu 0 nedošlo k výchozímu chování, je nutné ho uvést explicitně pomocí kolekce exitCodes nebo exitCodeRanges.

exitCodeRanges

Seznam rozsahů ukončovacího kódu úlohy a způsob, jakým služba Batch reaguje na ně.

exitCodes

Seznam ukončovacích kódů jednotlivých úkolů a způsob, jakým služba Batch reaguje na ně.

fileUploadError

Způsob, jakým má služba Batch reagovat, pokud dojde k chybě nahrávání souboru.
Pokud úloha skončila s ukončovacím kódem, který byl zadán prostřednictvím exitCodes nebo exitCodeRanges, a poté došlo k chybě při nahrávání souboru, má přednost akce určená ukončovacím kódem.

preProcessingError

Způsob, jakým má služba Batch reagovat, pokud se úloha nespustí z důvodu chyby.

ExitOptions

Určuje, jak služba Batch reaguje na určitou podmínku ukončení.

Name Type Description
dependencyAction

Akce, kterou služba Batch provede pro úlohy, které jsou závislé na této úloze.
Možné hodnoty jsou "uspokojení" (povolující závislé úlohy ke zpracování) a "Block" (závislé úlohy budou i nadále čekat). Batch zatím nepodporuje zrušení závislých úkolů.

jobAction

Akce, která se má provést u úlohy obsahující úlohu, pokud se úloha dokončí s daným výstupním stavem a vlastností onTaskFailed úlohy je "performExitOptionsJobAction".
Výchozí hodnota je None pro ukončovací kód 0 a končí pro všechny ostatní podmínky ukončení. Pokud vlastnost onTaskFailed úlohy je nenastavená, pak zadáním této vlastnosti vrátí chybu a žádost o přidání úlohy se nezdařila s chybou neplatné hodnoty vlastnosti; Pokud voláte REST API přímo, stavový kód HTTP je 400 (chybný požadavek).

JobAction

Akce, která se má provést u úlohy obsahující úlohu, pokud se úloha dokončí s daným výstupním stavem a vlastností onTaskFailed úlohy je "performExitOptionsJobAction".

Name Type Description
disable
  • string

Zakažte úlohu. Jedná se o ekvivalent volání rozhraní API úlohy Disable s hodnotou disableTasks requeue.

none
  • string

Neprovádět žádnou akci.

terminate
  • string

Ukončete úlohu. TerminateReason v executionInfo úlohy je nastavená na "TaskFailed".

MultiInstanceSettings

Nastavení, které určuje, jak se má spustit úloha s více instancemi

Name Type Description
commonResourceFiles

Seznam souborů, které bude služba Batch stahovat před spuštěním koordinačního příkazového řádku.
Rozdíl mezi běžnými soubory prostředků a zdrojovými soubory úloh spočívá v tom, že se stáhnou běžné soubory prostředků pro všechny dílčí úkoly, jako je primární, zatímco soubory prostředků úlohy se stáhnou jenom pro primární. Všimněte si také, že tyto soubory prostředků nejsou stahovány do pracovního adresáře úkolů, ale místo toho se stáhnou do kořenového adresáře úkolů (jeden adresář nad pracovním adresářem). Existuje maximální velikost seznamu souborů prostředků. Při překročení maximální velikosti se požadavek nezdaří a kód chyby odpovědi bude RequestEntityTooLarge. Pokud k tomu dojde, musí být kolekce ResourceFiles zmenšena velikosti. Toho lze dosáhnout pomocí souborů. zip, balíčků aplikací nebo kontejnerů Docker.

coordinationCommandLine
  • string

Příkazový řádek, který se má spustit na všech výpočetních uzlech, aby se mohl koordinovat při primárním spuštění příkazu hlavního úkolu.
Typický příkazový řádek pro koordinaci spouští službu na pozadí a ověřuje, že je služba připravená na zpracování zpráv mezi uzly.

numberOfInstances
  • integer

Počet výpočetních uzlů vyžadovaných úkolem.
Je-li tento parametr vynechán, je použita výchozí hodnota 1.

OutputFile

Specifikace pro nahrávání souborů z Azure Batch výpočetního uzlu do jiného umístění poté, co služba Batch dokončila provádění procesu úlohy.

Name Type Description
destination

Cíl pro výstupní soubor (y).

filePattern
  • string

Vzor, který označuje, které soubory se mají nahrát
Jsou podporovány relativní i absolutní cesty. Relativní cesty jsou relativní vzhledem k pracovnímu adresáři úkolu. Jsou podporovány následující zástupné znaky: * odpovídá 0 nebo více znakům (například vzor ABC * by odpovídal ABC nebo abcdef), * * odpovídá jakémukoli adresáři? odpovídá jakémukoli jednomu znaku, [abc] odpovídá jednomu znaku v závorkách a [a-c] odpovídá jednomu znaku v rozsahu. Hranaté závorky můžou zahrnovat negaci, která odpovídá jakémukoli nespecifikovanému znaku (například [! abc] odpovídá jakémukoli znaku, ale a, b nebo c). Pokud název souboru začíná na "." se ve výchozím nastavení ignoruje, ale může se shodovat zadáním explicitně (například . gif se neshoduje s .a.gif, ale.. GIF). Jednoduchý příklad: ** * . txt odpovídá jakémukoli souboru, který nezačíná na '. ' a končí na. txt v pracovním adresáři úlohy nebo v jakémkoli podadresáři. Pokud název souboru obsahuje zástupný znak, může být uvozený pomocí závorek (například ABC [*] odpovídá souboru s názvem ABC *). Všimněte si, že oba \ a/jsou považovány za oddělovače adresářů ve Windows, ale pouze/se nacházejí v systému Linux. Proměnné prostředí (% var% ve Windows nebo $var v systému Linux) jsou rozbaleny před použitím vzoru.

uploadOptions

Další možnosti pro operaci nahrávání, včetně toho, za jakých podmínek se má nahrávání provést.

OutputFileBlobContainerDestination

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

Name Type Description
containerUrl
  • string

Adresa URL kontejneru v rámci Azure Blob Storage, do kterého se mají nahrát tyto soubory:
Adresa URL musí obsahovat sdílený přístupový podpis (SAS) udělující oprávnění k zápisu do kontejneru.

path
  • string

Cílový objekt BLOB nebo virtuální adresář v rámci kontejneru Azure Storage.
Pokud vzor souboru odkazuje na konkrétní soubor (tj. neobsahuje žádné zástupné znaky), pak cesta je název objektu blob, do kterého chcete tento soubor odeslat. Pokud vzor souboru 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 objektu BLOB (který se přiřadí ke každému názvu objektu BLOB), do kterého se mají nahrát soubory. Pokud tento parametr vynecháte, soubory se nahrají do kořenového adresáře kontejneru s názvem objektu blob, který odpovídá názvu souboru.

OutputFileDestination

Cíl, do kterého má být soubor nahrán.

Name Type Description
container

Umístění v úložišti objektů BLOB v Azure, do kterého se mají soubory nahrávat

OutputFileUploadCondition

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

Name Type Description
taskcompletion
  • string

Nahrajte soubory po ukončení procesu úlohy bez ohledu na to, jaký byl ukončovací kód.

taskfailure
  • string

Soubory se nahrávají až po ukončení procesu úlohy pomocí nenulového ukončovacího kódu.

tasksuccess
  • string

Soubory se nahrávají až po ukončení procesu úlohy s ukončovacím kódem 0.

OutputFileUploadOptions

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

Name Type Description
uploadCondition

Podmínky, za kterých se má nahrát výstupní soubor úlohy nebo sada souborů
Výchozí hodnota je taskcompletion.

ResourceFile

Jeden soubor nebo více souborů, které se mají stáhnout do výpočetního uzlu.

Name Type 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 jedna z nich musí být zadaná.

blobPrefix
  • string

Předpona objektu blob, která se má použít při stahování objektů BLOB z kontejneru Azure Storage. Budou staženy pouze objekty blob, jejichž názvy začínají zadanou předponou.
Vlastnost je platná pouze v případě, že je použit autoStorageContainerName nebo storageContainerUrl. Tato předpona může být částečný název souboru nebo podadresář. Není-li zadána předpona, budou staženy všechny soubory v kontejneru.

fileMode
  • string

Atribut režimu oprávnění souboru v osmičkovém formátu.
Tato vlastnost se vztahuje pouze na soubory, které jsou stahovány do výpočetních uzlů se systémem Linux. Bude ignorována, pokud je zadána pro resourceFile, který bude stažen do výpočetního uzlu Windows. Pokud není tato vlastnost pro výpočetní uzel se systémem Linux určena, bude pro soubor použita výchozí hodnota 0770.

filePath
  • string

Umístění na výpočetním uzlu, do kterého se mají stáhnout soubory relativní vzhledem k pracovnímu adresáři úkolu.
Pokud je zadána vlastnost httpUrl, vyžaduje se filePath a popisuje cestu, do které bude soubor stažen, včetně názvu souboru. V opačném případě, pokud je zadána vlastnost autoStorageContainerName nebo storageContainerUrl, filePath je volitelné a je adresář, do kterého se mají soubory stáhnout. V případě, že se filePath používá jako adresář, všechna adresářová struktura, která je už přidružená ke vstupním datům, se zachová v plném rozsahu a připojí se k zadanému adresáři filePath. Zadaná relativní cesta nemůže oddělit pracovní adresář úlohy (například pomocí '.. ').

httpUrl
  • string

Adresa URL souboru, který se má stáhnout.
Vlastnosti autoStorageContainerName, storageContainerUrl a httpUrl se vzájemně vylučují a jedna z nich musí být zadaná. Pokud adresa URL odkazuje na službu Azure Blob Storage, musí být čitelná pomocí anonymního přístupu; To znamená, že služba Batch při stahování objektu BLOB nezobrazuje žádné přihlašovací údaje. Existují dva způsoby, jak tuto adresu URL pro objekt BLOB ve službě Azure Storage získat: zahrňte do objektu BLOB oprávnění ke čtení (SAS), nebo nastavte seznam ACL pro objekt BLOB nebo jeho kontejner, aby byl veřejný přístup povolen.

storageContainerUrl
  • string

Adresa URL kontejneru objektů BLOB v rámci služby Azure Blob Storage.
Vlastnosti autoStorageContainerName, storageContainerUrl a httpUrl se vzájemně vylučují a jedna z nich musí být zadaná. Tato adresa URL musí být čitelná a musí být vypsána pomocí anonymního přístupu. To znamená, že služba Batch při stahování objektů BLOB z kontejneru nezobrazuje žádné přihlašovací údaje. Existují dva způsoby, jak získat takovou adresu URL pro kontejner ve službě Azure Storage: zahrňte sdílený přístupový podpis (SAS), který uděluje oprávnění ke čtení a výpisům kontejneru, nebo nastavte seznam řízení přístupu pro kontejner tak, aby umožňoval veřejný přístup.

TaskAddParameter

Azure Batch úkol, který se má přidat

Name Type Description
affinityInfo

Pomocný parametr místní hodnoty, 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

Seznam balíčků, které bude služba Batch nasazovat do výpočetního uzlu před spuštěním příkazového řádku.
Balíčky aplikací se stáhnou a nasazují do sdíleného adresáře, nikoli do pracovního adresáře úkolů. Proto pokud je už odkazovaný balíček na uzlu a je aktuální, pak se nestáhne znovu. použije se existující kopie na výpočetním uzlu. Pokud se odkazovaný balíček nedá nainstalovat, například proto, že balíček je odstraněný nebo protože stažení selhalo, úloha se nezdařila.

authenticationTokenSettings

Nastavení ověřovacího tokenu, které může úkol použít k provádění operací služby Batch.
Pokud je tato vlastnost nastavená, služba Batch poskytuje úlohu s ověřovacím tokenem, který se dá použít k ověřování operací služby Batch bez vyžadování přístupového klíče účtu. Token se poskytuje prostřednictvím proměnné prostředí AZ_BATCH_AUTHENTICATION_TOKEN. Operace, které úloha může provádět pomocí tokenu, závisí na nastavení. Úkol může například požádat o oprávnění úlohy, aby bylo možné do úlohy přidat další úkoly, nebo zjistit stav úlohy nebo dalších úloh v rámci úlohy.

commandLine
  • string

Příkazový řádek úkolu.
V případě úkolů s více instancemi je příkazový řádek spuštěn jako primární úkol, poté co primární úloha a všechny dílčí úkoly dokončily provádění koordinačního příkazového řádku. Příkazový řádek neběží pod prostředím, takže nemůže využít funkce prostředí, jako je například rozšíření proměnné prostředí. Chcete-li využít výhod těchto funkcí, 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 systému Linux. Pokud příkazový řádek odkazuje na cesty k souboru, měl by použít relativní cestu (relativní vzhledem k pracovnímu adresáři úkolu) nebo použít proměnnou prostředí dávkovou dávkou ( https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) .

constraints

Omezení provádění, která se vztahují na tento úkol.
Pokud nezadáte omezení, maxTaskRetryCount je maxTaskRetryCount pro úlohu, proměnné maxwallclocktime je nekonečno a retentionTime je 7 dní.

containerSettings

Nastavení kontejneru, pod kterým je úloha spuštěna.
Pokud fond, který spustí tuto úlohu, má containerConfiguration sadu, je nutné ji nastavit také. Pokud fond, který úlohu spustí, nemá containerConfiguration sadu, nesmí být nastavena. Je-li tento parametr zadán, budou všechny adresáře rekurzivně pod AZ_BATCH_NODE_ROOT_DIR (kořen Azure Batch adresářů na uzlu) mapovány do kontejneru, všechny proměnné prostředí úlohy jsou namapovány do kontejneru a příkazový řádek úkolu je spuštěn v kontejneru. Soubory vytvořené v kontejneru mimo AZ_BATCH_NODE_ROOT_DIR se nemusí odrazit na hostitelském disku, což znamená, že rozhraní API dávkového souboru nebudou mít přístup k těmto souborům.

dependsOn

Úkoly, na kterých tento úkol závisí.
Tato úloha nebude naplánována, dokud nebudou úspěšně dokončeny všechny úlohy, na kterých jsou závislé. Pokud některý z těchto úloh selže a vyčerpá jejich počet opakování, tato úloha nebude nikdy naplánována. Pokud úloha nemá usesTaskDependencies nastavenou na hodnotu true a tento prvek je přítomen, požadavek se nezdařil s kódem chyby TaskDependenciesNotSpecifiedOnJob.

displayName
  • string

Zobrazovaný název úlohy.
Zobrazovaný název nemusí být jedinečný a může obsahovat libovolné znaky Unicode až do maximální délky 1024.

environmentSettings

Seznam nastavení proměnných prostředí pro úlohu.

exitConditions

Určuje, jak má služba Batch reagovat po dokončení úlohy.
Způsob, jakým má služba Batch reagovat po dokončení úlohy.

id
  • string

Řetězec, který jedinečně identifikuje úlohu v rámci úlohy.
ID může obsahovat libovolnou kombinaci alfanumerických znaků včetně spojovníků a podtržítka a nesmí obsahovat více než 64 znaků. V ID se nerozlišují velká a malá písmena (to znamená, že v rámci úlohy nesmíte mít dvě ID, která se liší pouze případem).

multiInstanceSettings

Objekt, který označuje, že úkol je úloha s více instancemi, a obsahuje informace o tom, jak spustit úlohu s více instancemi.
Úkoly s více instancemi se běžně používají k podpoře úloh MPI. V případě, že se některý z dílčích úkolů nezdaří (například kvůli ukončení s nenulovým ukončovacím kódem), selže celá úloha s více instancemi. Úloha s více instancemi se pak ukončí a zopakuje, až do jejího limitu opakování.

outputFiles

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 budou nahrávat jenom z výpočetního uzlu, na kterém je primární úkol spuštěný.

requiredSlots
  • integer

Počet slotů plánování, které úloha vyžaduje pro spuštění.
Výchozí hodnota je 1. Úloha může být naplánována pouze na výpočetní uzel, pokud má uzel dostatek volných slotů k dispozici. U úkolů s více instancemi musí být 1.

resourceFiles

Seznam souborů, které služba Batch stáhne do výpočetního uzlu před spuštěním příkazového řádku.
Pro úlohy s více instancemi se soubory prostředků stáhnou jenom do výpočetního uzlu, na kterém je primární úkol spuštěný. Existuje maximální velikost seznamu souborů prostředků. Při překročení maximální velikosti se požadavek nezdaří a kód chyby odpovědi bude RequestEntityTooLarge. Pokud k tomu dojde, musí být kolekce ResourceFiles zmenšena velikosti. Toho lze dosáhnout pomocí souborů. zip, balíčků aplikací nebo kontejnerů Docker.

userIdentity

Identita uživatele, pod kterou je úloha spuštěna.
Je-li tento parametr vynechán, je úloha spuštěna jako uživatel bez oprávnění správce, který je pro úkol jedinečný.

TaskConstraints

Omezení spouštění pro použití pro úlohu.

Name Type Description
maxTaskRetryCount
  • integer

Maximální počet pokusů, kolikrát může být úloha opakována. 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í pro spustitelný soubor úlohy z důvodu nenulového ukončovacího kódu. Služba Batch úlohu zopakuje a potom ji můžete opakovat až do tohoto limitu. Například pokud je maximální počet opakování 3, Batch se pokusí úlohu provést až čtyřikrát (jeden počáteční pokus a 3 opakování). Pokud je maximální počet opakování 0, služba Batch úlohu po prvním pokusu neopakuje. Pokud je maximální počet opakování-1, služba Batch úlohu zopakuje bez omezení.

maxWallClockTime
  • string

Maximální uplynulý čas, kdy se úloha může spustit, měřená od doby, kdy je úloha spuštěna. Pokud se úloha v rámci časového limitu nedokončí, služba Batch je ukončí.
Pokud tento parametr nezadáte, nebudete mít žádný časový limit na to, jak dlouho může být úloha spuštěna.

retentionTime
  • string

Minimální doba uchování adresáře úloh na výpočetním uzlu, ve 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í, to znamená, že se adresář úloh bude uchovávat 7 dní, pokud se výpočetní uzel neodebere nebo pokud se úloha odstraní.

TaskContainerSettings

Nastavení kontejneru pro úlohu.

Name Type Description
containerRunOptions
  • string

Další možnosti příkazu pro vytvoření kontejneru
Tyto další možnosti se dodávají jako argumenty příkazu Docker Create, a to kromě těch, které spravuje služba Batch.

imageName
  • string

Obrázek, který se má použít k vytvoření kontejneru, ve kterém se úloha spustí.
Toto je úplný odkaz na obrázek, který by byl uveden jako "docker pull". Pokud není k dispozici žádná značka jako součást názvu bitové kopie, použije se jako výchozí značka ": nejnovější".

registry

Privátní registr, který obsahuje image kontejneru.
Toto nastavení může být vynecháno, pokud bylo již zadáno při vytváření fondu.

workingDirectory

Umístění pracovního adresáře úlohy kontejneru
Výchozí hodnota je ' taskWorkingDirectory '.

TaskDependencies

Určuje všechny závislosti úkolu. Všechny úkoly, které jsou explicitně zadány nebo v rozsahu závislosti, musí být dokončeny, aby se naplánovala závislá úloha.

Name Type Description
taskIdRanges

Seznam rozsahů ID úloh, na kterých je tato úloha závislá Aby bylo možné naplánovat závislý úkol, musí být všechny úlohy ve všech oblastech úspěšně dokončeny.

taskIds
  • string[]

Seznam ID úloh, na kterých je tato úloha závislá Všechny úlohy v tomto seznamu musí být úspěšně dokončeny, aby bylo možné naplánovat závislou úlohu.
TaskIds kolekce je omezena na celkem 64000 znaků (tj. kombinovanou délku všech ID úloh). Pokud kolekce taskIds překračuje maximální délku, požadavek přidat úlohu se nezdařil s kódem chyby TaskDependencyListTooLong. V tomto případě zvažte místo toho použití rozsahů ID úloh.

TaskIdRange

Rozsah ID úkolů, na kterém může úkol záviset. Všechny úlohy s ID v rozsahu musí být úspěšně dokončeny, aby bylo možné naplánovat závislou úlohu.

Name Type Description
end
  • integer

Poslední ID úkolu v rozsahu

start
  • integer

První ID úkolu v rozsahu

UserIdentity

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

Name Type Description
autoUser

Automatický uživatel, pod kterým je úloha spuštěna.
Vlastnosti uživatelského jména a autouser se vzájemně vylučují; je nutné zadat jeden, ale ne obojí.

username
  • string

Název identity uživatele, pod kterou je úloha spuštěna.
Vlastnosti uživatelského jména a autouser se vzájemně vylučují; je nutné zadat jeden, ale ne obojí.