BatchJobCreateOptions interface

Balíček:

@azure-rest/batch

Parametry pro vytvoření úlohy Azure Batch

Vlastnosti

allowTaskPreemption	Určuje, zda úkoly v této úloze mohou být zrušeny jinými úlohami s vysokou prioritou. (Tato vlastnost není ve výchozím nastavení dostupná. Pro více informací kontaktujte podporu) Pokud je hodnota nastavena na True, budou mít přednost jiné úlohy s vysokou prioritou odeslané do systému a budou moci znovu zařadit úlohy z této úlohy. Po vytvoření pomocí rozhraní API úlohy aktualizace můžete aktualizovat funkci allowTaskPreemption.
commonEnvironmentSettings	Seznam běžných nastavení proměnných prostředí Tyto proměnné prostředí jsou nastavené pro všechny úkoly v úloze (včetně správce úloh, přípravy úloh a úkolů uvolnění úloh). Jednotlivé úlohy můžou přepsat nastavení prostředí zadané zde zadáním stejného názvu nastavení s jinou hodnotou.
constraints	Omezení provádění pro úlohu.
displayName	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.
id	Řetězec, který jednoznačně identifikuje úlohu v rámci účtu. 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 se zachovává a nerozlišuje malá a velká písmena (to znamená, že v rámci účtu nesmíte mít dvě ID, která se liší pouze v případě).
jobManagerTask	Podrobnosti o úloze správce úloh, která se má spustit při spuštění úlohy Pokud úloha úlohu nezadá, uživatel musí do úlohy explicitně přidat úkoly. Pokud úloha zadá úlohu Správce úloh, služba Batch vytvoří úkol Správce úloh při vytvoření úlohy a pokusí se naplánovat úkol Správce úloh před naplánováním dalších úkolů v úloze. Typickým účelem úlohy správce úloh je řídit a/nebo monitorovat provádění úlohy, například rozhodováním o tom, jaké další úkoly se mají spustit, určit, kdy je práce dokončena atd. (Úloha správce úloh ale není omezena na tyto aktivity – jedná se o plnohodnotný úkol v systému a provádění jakýchkoli akcí požadovaných pro úlohu.) Například úloha Správce úloh může stáhnout soubor zadaný jako parametr, analyzovat obsah tohoto souboru a odeslat další úkoly na základě tohoto obsahu.
jobPreparationTask	Úkol přípravy úlohy. Pokud má úloha úlohu přípravy úlohy, služba Batch spustí úlohu přípravy úlohy na uzlu před spuštěním všech úkolů této úlohy na daném výpočetním uzlu.
jobReleaseTask	Úloha uvolnění úlohy. Úkol uvolnění úlohy nelze zadat bez zadání úkolu přípravy úlohy pro úlohu. Služba Batch spouští úlohu uvolnění úlohy na uzlech, které mají spuštěnou úlohu přípravy úlohy. Primárním účelem úlohy uvolnění úlohy je vrátit změny výpočetních uzlů provedených úkolem přípravy úlohy. Mezi příklady aktivit patří odstranění místních souborů nebo vypnutí služeb, které byly spuštěny v rámci přípravy úlohy.
maxParallelTasks	Maximální počet úkolů, které lze pro úlohu spustit paralelně. (Tato vlastnost není ve výchozím nastavení dostupná. Další informace vám poskytne podpora) Hodnota maxParallelTasks musí být -1 nebo větší než 0, pokud je zadaná. Pokud není zadáno, výchozí hodnota je -1, což znamená, že neexistuje žádný limit počtu úkolů, které lze spustit najednou. Po vytvoření můžete aktualizovat maxParallelTasks úlohy pomocí rozhraní API úlohy aktualizace.
metadata	Seznam párů název-hodnota přidružených k úloze jako metadata Služba Batch nepřiřazuje metadatům žádný význam; je výhradně pro použití uživatelského kódu.
networkConfiguration	(Tato vlastnost není ve výchozím nastavení dostupná. Pro více informací kontaktujte podporu) Síťová konfigurace pro úlohu.
onAllTasksComplete	Akce, kterou má služba Batch provést, když jsou všechny úkoly v úloze v dokončeném stavu. Všimněte si, že pokud úloha neobsahuje žádné úkoly, považují se všechny úkoly za dokončené. Tato možnost se proto nejčastěji používá s úkolem Správce úloh; Pokud chcete použít automatické ukončení úlohy bez Správce úloh, měli byste nejprve nastavit onAllTasksComplete na noaction a aktualizovat vlastnosti úlohy nastavit onAllTasksComplete ukončitjob po dokončení přidávání úkolů. Výchozí hodnota je noaction. Možné hodnoty: "noaction", "terminatejob"
onTaskFailure	Akce, kterou má služba Batch provést, když selže jakýkoli úkol v úloze. Úloha se považuje za neúspěšnou, pokud má informace o selhání. Informace o selhání se nastaví, pokud se úkol dokončí s nenulovým ukončovacím kódem po vyčerpání počtu opakování nebo pokud došlo k chybě při spuštění úlohy, například kvůli chybě při stahování souboru prostředků. Výchozí hodnota je noaction. Možné hodnoty: "noaction", "performexitoptionsjobaction"
poolInfo	Fond, na kterém služba Batch spouští úlohy.
priority	Priorita úlohy. Hodnoty priority mohou být v rozsahu od -1000 do 1 000, přičemž -1000 nejnižší prioritou a 1000 nejvyšší prioritou. Výchozí hodnota je 0.
usesTaskDependencies	Určuje, zda úkoly v úloze mohou definovat závislosti na sobě navzájem. Výchozí hodnota je false.

Podrobnosti vlastnosti

allowTaskPreemption

Určuje, zda úkoly v této úloze mohou být zrušeny jinými úlohami s vysokou prioritou. (Tato vlastnost není ve výchozím nastavení dostupná. Pro více informací kontaktujte podporu) Pokud je hodnota nastavena na True, budou mít přednost jiné úlohy s vysokou prioritou odeslané do systému a budou moci znovu zařadit úlohy z této úlohy. Po vytvoření pomocí rozhraní API úlohy aktualizace můžete aktualizovat funkci allowTaskPreemption.

allowTaskPreemption?: boolean

Hodnota vlastnosti

boolean

commonEnvironmentSettings

Seznam běžných nastavení proměnných prostředí Tyto proměnné prostředí jsou nastavené pro všechny úkoly v úloze (včetně správce úloh, přípravy úloh a úkolů uvolnění úloh). Jednotlivé úlohy můžou přepsat nastavení prostředí zadané zde zadáním stejného názvu nastavení s jinou hodnotou.

commonEnvironmentSettings?: EnvironmentSetting[]

Hodnota vlastnosti

EnvironmentSetting[]

constraints

Omezení provádění pro úlohu.

constraints?: BatchJobConstraints

Hodnota vlastnosti

BatchJobConstraints

displayName

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.

displayName?: string

Hodnota vlastnosti

string

id

Řetězec, který jednoznačně identifikuje úlohu v rámci účtu. 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 se zachovává a nerozlišuje malá a velká písmena (to znamená, že v rámci účtu nesmíte mít dvě ID, která se liší pouze v případě).

id: string

Hodnota vlastnosti

string

jobManagerTask

Podrobnosti o úloze správce úloh, která se má spustit při spuštění úlohy Pokud úloha úlohu nezadá, uživatel musí do úlohy explicitně přidat úkoly. Pokud úloha zadá úlohu Správce úloh, služba Batch vytvoří úkol Správce úloh při vytvoření úlohy a pokusí se naplánovat úkol Správce úloh před naplánováním dalších úkolů v úloze. Typickým účelem úlohy správce úloh je řídit a/nebo monitorovat provádění úlohy, například rozhodováním o tom, jaké další úkoly se mají spustit, určit, kdy je práce dokončena atd. (Úloha správce úloh ale není omezena na tyto aktivity – jedná se o plnohodnotný úkol v systému a provádění jakýchkoli akcí požadovaných pro úlohu.) Například úloha Správce úloh může stáhnout soubor zadaný jako parametr, analyzovat obsah tohoto souboru a odeslat další úkoly na základě tohoto obsahu.

jobManagerTask?: BatchJobManagerTask

Hodnota vlastnosti

BatchJobManagerTask

jobPreparationTask

Úkol přípravy úlohy. Pokud má úloha úlohu přípravy úlohy, služba Batch spustí úlohu přípravy úlohy na uzlu před spuštěním všech úkolů této úlohy na daném výpočetním uzlu.

jobPreparationTask?: BatchJobPreparationTask

Hodnota vlastnosti

BatchJobPreparationTask

jobReleaseTask

Úloha uvolnění úlohy. Úkol uvolnění úlohy nelze zadat bez zadání úkolu přípravy úlohy pro úlohu. Služba Batch spouští úlohu uvolnění úlohy na uzlech, které mají spuštěnou úlohu přípravy úlohy. Primárním účelem úlohy uvolnění úlohy je vrátit změny výpočetních uzlů provedených úkolem přípravy úlohy. Mezi příklady aktivit patří odstranění místních souborů nebo vypnutí služeb, které byly spuštěny v rámci přípravy úlohy.

jobReleaseTask?: BatchJobReleaseTask

Hodnota vlastnosti

BatchJobReleaseTask

maxParallelTasks

Maximální počet úkolů, které lze pro úlohu spustit paralelně. (Tato vlastnost není ve výchozím nastavení dostupná. Další informace vám poskytne podpora) Hodnota maxParallelTasks musí být -1 nebo větší než 0, pokud je zadaná. Pokud není zadáno, výchozí hodnota je -1, což znamená, že neexistuje žádný limit počtu úkolů, které lze spustit najednou. Po vytvoření můžete aktualizovat maxParallelTasks úlohy pomocí rozhraní API úlohy aktualizace.

maxParallelTasks?: number

Hodnota vlastnosti

number

metadata

Seznam párů název-hodnota přidružených k úloze jako metadata Služba Batch nepřiřazuje metadatům žádný význam; je výhradně pro použití uživatelského kódu.

metadata?: BatchMetadataItem[]

Hodnota vlastnosti

BatchMetadataItem[]

networkConfiguration

(Tato vlastnost není ve výchozím nastavení dostupná. Pro více informací kontaktujte podporu) Síťová konfigurace pro úlohu.

networkConfiguration?: BatchJobNetworkConfiguration

Hodnota vlastnosti

BatchJobNetworkConfiguration

onAllTasksComplete

Akce, kterou má služba Batch provést, když jsou všechny úkoly v úloze v dokončeném stavu. Všimněte si, že pokud úloha neobsahuje žádné úkoly, považují se všechny úkoly za dokončené. Tato možnost se proto nejčastěji používá s úkolem Správce úloh; Pokud chcete použít automatické ukončení úlohy bez Správce úloh, měli byste nejprve nastavit onAllTasksComplete na noaction a aktualizovat vlastnosti úlohy nastavit onAllTasksComplete ukončitjob po dokončení přidávání úkolů. Výchozí hodnota je noaction.

Možné hodnoty: "noaction", "terminatejob"

onAllTasksComplete?: string

Hodnota vlastnosti

string

onTaskFailure

Akce, kterou má služba Batch provést, když selže jakýkoli úkol v úloze. Úloha se považuje za neúspěšnou, pokud má informace o selhání. Informace o selhání se nastaví, pokud se úkol dokončí s nenulovým ukončovacím kódem po vyčerpání počtu opakování nebo pokud došlo k chybě při spuštění úlohy, například kvůli chybě při stahování souboru prostředků. Výchozí hodnota je noaction.

Možné hodnoty: "noaction", "performexitoptionsjobaction"

onTaskFailure?: string

Hodnota vlastnosti

string

poolInfo

Fond, na kterém služba Batch spouští úlohy.

poolInfo: BatchPoolInfo

Hodnota vlastnosti

BatchPoolInfo

priority

Priorita úlohy. Hodnoty priority mohou být v rozsahu od -1000 do 1 000, přičemž -1000 nejnižší prioritou a 1000 nejvyšší prioritou. Výchozí hodnota je 0.

priority?: number

Hodnota vlastnosti

number

usesTaskDependencies

Určuje, zda úkoly v úloze mohou definovat závislosti na sobě navzájem. Výchozí hodnota je false.

usesTaskDependencies?: boolean

Hodnota vlastnosti

boolean