BatchTaskCreateOptions interface

Balíček:

@azure-rest/batch

Parametry pro vytvoření úlohy Azure Batch

Vlastnosti

affinityInfo	Nápovědu 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á spustit nový úkol.
applicationPackageReferences	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 stáhnou a nasadí do sdíleného adresáře, nikoli do pracovního adresáře Úlohy. Proto pokud odkazovaný balíček je již v uzlu a je aktuální, pak se znovu nestáhnou; Použije se existující kopie výpočetního 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	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 poskytuje úlohu ověřovací token, který se dá použít k ověřování operací služby Batch, aniž by vyžadovala přístupový klíč úč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	Příkazový řádek úkolu. U úloh s více instancemi se příkazový řádek spustí jako primární úkol, jakmile primární úkol a všechny dílčí úkoly dokončí provádění koordinačního příkazového řádku. Příkazový řádek se nespustí pod prostředím, 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í na 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 (relativní k pracovnímu adresáři úkolu) nebo použít proměnnou prostředí poskytovanou službou Batch (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).
constraints	Omezení provádění, která platí pro tuto úlohu. Pokud nezadáte omezení, maxTaskRetryCount je hodnota maxTaskRetryCount zadaná pro úlohu, maxWallClockTime je nekonečná a doba uchování je 7 dní.
containerSettings	Nastavení kontejneru, pod kterým se úloha spouští. Pokud má fond, který bude tuto úlohu spouštět, nastavený kontejnerConfiguration, musí být také nastaven. Pokud fond, který spustí tuto úlohu, nemá nastavenou konfiguraci kontejneru, nesmí být nastavena. Po zadání se všechny adresáře rekurzivně pod AZ_BATCH_NODE_ROOT_DIR (kořen adresářů Azure Batch na uzlu) mapují do kontejneru, všechny proměnné prostředí úloh se mapují do kontejneru a v kontejneru se spustí příkazový řádek úkolu. Soubory vytvořené v kontejneru mimo AZ_BATCH_NODE_ROOT_DIR se nemusí projevit na hostitelském disku, což znamená, že rozhraní API souborů batch nebudou mít přístup k těmto souborům.
dependsOn	Úkoly, na které tento úkol závisí. Tento úkol nebude naplánován, dokud nebudou všechny úkoly, na kterých závisí, úspěšně dokončeny. Pokud některý z těchto úkolů selže a vyčerpá počet opakování, nebude tento úkol nikdy naplánován. Pokud úloha nemá použitíTaskDependencies nastavena na true a tento prvek je přítomn, požadavek selže s kódem chyby TaskDependenciesNotSpecifiedOnJob.
displayName	Zobrazovaný název úkolu. 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	Jak by služba Batch měla reagovat po dokončení úlohy.
id	Řetězec, který jednoznačně identifikuje úkol v rámci úlohy. ID může obsahovat libovolnou kombinaci alfanumerických znaků včetně pomlček a podtržítka a nesmí obsahovat více než 64 znaků. ID nerozlišuje velká a malá a velká písmena (to znamená, že v úloze nesmíte mít dvě ID, která se liší pouze v případě).
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.
outputFiles	Seznam souborů, které služba Batch nahraje z výpočetního uzlu po spuštění příkazového řádku U úloh s více instancemi se soubory nahrají jenom z výpočetního uzlu, na kterém je spuštěn primární úkol.
requiredSlots	Počet slotů plánování, které úloha vyžaduje ke spuštění. Výchozí hodnota je 1. Úkol je možné naplánovat tak, aby běžel pouze na výpočetním uzlu, pokud má uzel k dispozici dostatek volných slotů plánování. U úloh s více instancemi musí být tato možnost 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. U úloh s více instancemi se soubory prostředků stáhnou jenom do výpočetního uzlu, na kterém je spuštěn primární úkol. Seznam souborů prostředků má 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í být kolekce ResourceFiles zmenšena velikostí. Toho lze dosáhnout pomocí .zip souborů, balíčků aplikací nebo kontejnerů Dockeru.
userIdentity	Identita uživatele, pod kterou se úloha spouští. Pokud tento parametr vynecháte, úloha se spustí jako uživatel, který není správcem, který je pro úlohu jedinečný.

Podrobnosti vlastnosti

affinityInfo

Nápovědu 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á spustit nový úkol.

affinityInfo?: BatchAffinityInfo

Hodnota vlastnosti

BatchAffinityInfo

applicationPackageReferences

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 stáhnou a nasadí do sdíleného adresáře, nikoli do pracovního adresáře Úlohy. Proto pokud odkazovaný balíček je již v uzlu a je aktuální, pak se znovu nestáhnou; Použije se existující kopie výpočetního 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.

applicationPackageReferences?: BatchApplicationPackageReference[]

Hodnota vlastnosti

BatchApplicationPackageReference[]

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 poskytuje úlohu ověřovací token, který se dá použít k ověřování operací služby Batch, aniž by vyžadovala přístupový klíč úč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.

authenticationTokenSettings?: AuthenticationTokenSettings

Hodnota vlastnosti

AuthenticationTokenSettings

commandLine

Příkazový řádek úkolu. U úloh s více instancemi se příkazový řádek spustí jako primární úkol, jakmile primární úkol a všechny dílčí úkoly dokončí provádění koordinačního příkazového řádku. Příkazový řádek se nespustí pod prostředím, 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í na 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 (relativní k pracovnímu adresáři úkolu) nebo použít proměnnou prostředí poskytovanou službou Batch (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

commandLine: string

Hodnota vlastnosti

string

constraints

Omezení provádění, která platí pro tuto úlohu. Pokud nezadáte omezení, maxTaskRetryCount je hodnota maxTaskRetryCount zadaná pro úlohu, maxWallClockTime je nekonečná a doba uchování je 7 dní.

constraints?: BatchTaskConstraints

Hodnota vlastnosti

BatchTaskConstraints

containerSettings

Nastavení kontejneru, pod kterým se úloha spouští. Pokud má fond, který bude tuto úlohu spouštět, nastavený kontejnerConfiguration, musí být také nastaven. Pokud fond, který spustí tuto úlohu, nemá nastavenou konfiguraci kontejneru, nesmí být nastavena. Po zadání se všechny adresáře rekurzivně pod AZ_BATCH_NODE_ROOT_DIR (kořen adresářů Azure Batch na uzlu) mapují do kontejneru, všechny proměnné prostředí úloh se mapují do kontejneru a v kontejneru se spustí příkazový řádek úkolu. Soubory vytvořené v kontejneru mimo AZ_BATCH_NODE_ROOT_DIR se nemusí projevit na hostitelském disku, což znamená, že rozhraní API souborů batch nebudou mít přístup k těmto souborům.

containerSettings?: BatchTaskContainerSettings

Hodnota vlastnosti

BatchTaskContainerSettings

dependsOn

Úkoly, na které tento úkol závisí. Tento úkol nebude naplánován, dokud nebudou všechny úkoly, na kterých závisí, úspěšně dokončeny. Pokud některý z těchto úkolů selže a vyčerpá počet opakování, nebude tento úkol nikdy naplánován. Pokud úloha nemá použitíTaskDependencies nastavena na true a tento prvek je přítomn, požadavek selže s kódem chyby TaskDependenciesNotSpecifiedOnJob.

dependsOn?: BatchTaskDependencies

Hodnota vlastnosti

BatchTaskDependencies

displayName

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

displayName?: string

Hodnota vlastnosti

string

environmentSettings

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

environmentSettings?: EnvironmentSetting[]

Hodnota vlastnosti

EnvironmentSetting[]

exitConditions

Jak by služba Batch měla reagovat po dokončení úlohy.

exitConditions?: ExitConditions

Hodnota vlastnosti

ExitConditions

id

Řetězec, který jednoznačně identifikuje úkol v rámci úlohy. ID může obsahovat libovolnou kombinaci alfanumerických znaků včetně pomlček a podtržítka a nesmí obsahovat více než 64 znaků. ID nerozlišuje velká a malá a velká písmena (to znamená, že v úloze nesmíte mít dvě ID, která se liší pouze v případě).

id: string

Hodnota vlastnosti

string

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.

multiInstanceSettings?: MultiInstanceSettings

Hodnota vlastnosti

MultiInstanceSettings

outputFiles

Seznam souborů, které služba Batch nahraje z výpočetního uzlu po spuštění příkazového řádku U úloh s více instancemi se soubory nahrají jenom z výpočetního uzlu, na kterém je spuštěn primární úkol.

outputFiles?: OutputFile[]

Hodnota vlastnosti

OutputFile[]

requiredSlots

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

requiredSlots?: number

Hodnota vlastnosti

number

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. U úloh s více instancemi se soubory prostředků stáhnou jenom do výpočetního uzlu, na kterém je spuštěn primární úkol. Seznam souborů prostředků má 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í být kolekce ResourceFiles zmenšena velikostí. Toho lze dosáhnout pomocí .zip souborů, balíčků aplikací nebo kontejnerů Dockeru.

resourceFiles?: ResourceFile[]

Hodnota vlastnosti

ResourceFile[]

userIdentity

Identita uživatele, pod kterou se úloha spouští. Pokud tento parametr vynecháte, úloha se spustí jako uživatel, který není správcem, který je pro úlohu jedinečný.

userIdentity?: UserIdentity

Hodnota vlastnosti

UserIdentity