BatchJobSpecificationOutput interface

Balíček:

@azure-rest/batch

Určuje podrobnosti o úlohách, které se mají vytvořit podle plánu.

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 nastaveny pro všechny úkoly v úlohách vytvořených v rámci tohoto plánu (včetně úloh Správce úloh, Příprava úloh a Úkoly 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 úlohy vytvořené v rámci tohoto plánu.
displayName	Zobrazovaný název pro úlohy vytvořené v rámci tohoto plánu. Název nemusí být jedinečný a může obsahovat znaky Unicode až do maximální délky 1024.
jobManagerTask	Podrobnosti úlohy správce úloh, které se mají spustit při spuštění úlohy v rámci tohoto plánu. Pokud úloha úlohu nezadá, uživatel musí do úlohy explicitně přidat úkoly pomocí rozhraní API úkolu. 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.
jobPreparationTask	Úkol přípravy úlohy pro úlohy vytvořené v rámci tohoto plánu. 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 pro úlohy vytvořené v rámci tohoto plánu. Primárním účelem úlohy uvolnění úlohy je vrátit změny 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. Úkol uvolnění úlohy nelze zadat bez zadání úkolu přípravy úlohy pro úlohu. Služba Batch spustí úlohu uvolnění úlohy na výpočetních uzlech, které mají spuštěnou úlohu 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 ke každé úloze vytvořené v rámci tohoto plánu 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 vytvořené v rámci tohoto plánu 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 v případě selhání jakékoli úlohy v úloze vytvořené v rámci tohoto plánu. Úloha se považuje za neúspěšnou, pokud selhala, pokud obsahuje 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 vytvořené v rámci tohoto plánu.
priority	Priorita úloh vytvořených v rámci tohoto plánu 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. Tato priorita se používá jako výchozí pro všechny úlohy v rámci plánu úlohy. Prioritu úlohy můžete aktualizovat po vytvoření pomocí rozhraní API úlohy aktualizace.
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 nastaveny pro všechny úkoly v úlohách vytvořených v rámci tohoto plánu (včetně úloh Správce úloh, Příprava úloh a Úkoly 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?: EnvironmentSettingOutput[]

Hodnota vlastnosti

EnvironmentSettingOutput[]

constraints

Omezení provádění pro úlohy vytvořené v rámci tohoto plánu.

constraints?: BatchJobConstraintsOutput

Hodnota vlastnosti

BatchJobConstraintsOutput

displayName

Zobrazovaný název pro úlohy vytvořené v rámci tohoto plánu. Název nemusí být jedinečný a může obsahovat znaky Unicode až do maximální délky 1024.

displayName?: string

Hodnota vlastnosti

string

jobManagerTask

Podrobnosti úlohy správce úloh, které se mají spustit při spuštění úlohy v rámci tohoto plánu. Pokud úloha úlohu nezadá, uživatel musí do úlohy explicitně přidat úkoly pomocí rozhraní API úkolu. 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.

jobManagerTask?: BatchJobManagerTaskOutput

Hodnota vlastnosti

BatchJobManagerTaskOutput

jobPreparationTask

Úkol přípravy úlohy pro úlohy vytvořené v rámci tohoto plánu. 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?: BatchJobPreparationTaskOutput

Hodnota vlastnosti

BatchJobPreparationTaskOutput

jobReleaseTask

Úloha uvolnění úlohy pro úlohy vytvořené v rámci tohoto plánu. Primárním účelem úlohy uvolnění úlohy je vrátit změny 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. Úkol uvolnění úlohy nelze zadat bez zadání úkolu přípravy úlohy pro úlohu. Služba Batch spustí úlohu uvolnění úlohy na výpočetních uzlech, které mají spuštěnou úlohu přípravy úlohy.

jobReleaseTask?: BatchJobReleaseTaskOutput

Hodnota vlastnosti

BatchJobReleaseTaskOutput

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 ke každé úloze vytvořené v rámci tohoto plánu 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?: BatchMetadataItemOutput[]

Hodnota vlastnosti

BatchMetadataItemOutput[]

networkConfiguration

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

networkConfiguration?: BatchJobNetworkConfigurationOutput

Hodnota vlastnosti

BatchJobNetworkConfigurationOutput

onAllTasksComplete

Akce, kterou má služba Batch provést, když jsou všechny úkoly v úloze vytvořené v rámci tohoto plánu 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 v případě selhání jakékoli úlohy v úloze vytvořené v rámci tohoto plánu. Úloha se považuje za neúspěšnou, pokud selhala, pokud obsahuje 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 vytvořené v rámci tohoto plánu.

poolInfo: BatchPoolInfoOutput

Hodnota vlastnosti

BatchPoolInfoOutput

priority

Priorita úloh vytvořených v rámci tohoto plánu 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. Tato priorita se používá jako výchozí pro všechny úlohy v rámci plánu úlohy. Prioritu úlohy můžete aktualizovat po vytvoření pomocí rozhraní API úlohy aktualizace.

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