BatchJobOutput interface

Balíček:

@azure-rest/batch

Úloha 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.
creationTime	Čas vytvoření úlohy.
displayName	Zobrazovaný název úlohy.
eTag	ETag úlohy. Jedná se o neprůhlený ř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 úlohy předat značku ETag, abyste určili, že se změny projeví jenom v případě, že do té doby úlohu nikdo jiný nezměnil.
executionInfo	Informace o spuštění úlohy.
id	Řetězec, který jednoznačně identifikuje úlohu v rámci účtu. 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
jobPreparationTask	Úkol přípravy úlohy. Úkol přípravy úlohy je speciální úkol spuštěný na každém výpočetním uzlu před jakýmkoli jiným úkolem úlohy.
jobReleaseTask	Úloha uvolnění úlohy. Úloha uvolnění úlohy je zvláštní úkol spuštěný na konci úlohy na každém výpočetním uzlu, který spustil jakoukoli jinou úlohu úlohy.
lastModified	Čas poslední změny úlohy. Jedná se o čas poslední změny dat na úrovni úlohy, jako je stav úlohy nebo priorita. Nefaktoruje změny na úrovni úkolu, jako je přidání nových úkolů nebo změny stavu úkolů.
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ý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	Nastavení fondu přidružené k úloze.
previousState	Předchozí stav úlohy. Tato vlastnost není nastavena, pokud je úloha v počátečním aktivním stavu. Možné hodnoty: "active", "zákaz", "disabled", "povolení", "ukončování", "dokončeno", "odstranění"
previousStateTransitionTime	Čas, kdy úloha přešla do předchozího stavu. Tato vlastnost není nastavena, pokud je úloha v počátečním aktivním stavu.
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.
state	Aktuální stav úlohy. Možné hodnoty: "active", "zákaz", "disabled", "povolení", "ukončování", "dokončeno", "odstranění"
stateTransitionTime	Čas, kdy úloha vstoupila do aktuálního stavu.
stats	Statistika využití prostředků po celou dobu životnosti úlohy. Tato vlastnost je naplněna pouze v případě, že služba BatchJob byla načtena s klauzulí rozbalení, včetně atributu 'stats'; jinak má hodnotu null. Statistiky nemusí být okamžitě dostupné. Služba Batch provádí pravidelné zavedení statistik. Typické zpoždění je asi 30 minut.
url	Adresa URL úlohy.
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?: EnvironmentSettingOutput[]

Hodnota vlastnosti

EnvironmentSettingOutput[]

constraints

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

constraints?: BatchJobConstraintsOutput

Hodnota vlastnosti

BatchJobConstraintsOutput

creationTime

Čas vytvoření úlohy.

creationTime: string

Hodnota vlastnosti

string

displayName

Zobrazovaný název úlohy.

displayName?: string

Hodnota vlastnosti

string

eTag

ETag úlohy. Jedná se o neprůhlený ř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 úlohy předat značku ETag, abyste určili, že se změny projeví jenom v případě, že do té doby úlohu nikdo jiný nezměnil.

eTag: string

Hodnota vlastnosti

string

executionInfo

Informace o spuštění úlohy.

executionInfo?: BatchJobExecutionInfoOutput

Hodnota vlastnosti

BatchJobExecutionInfoOutput

id

Řetězec, který jednoznačně identifikuje úlohu v rámci účtu. 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

jobManagerTask?: BatchJobManagerTaskOutput

Hodnota vlastnosti

BatchJobManagerTaskOutput

jobPreparationTask

Úkol přípravy úlohy. Úkol přípravy úlohy je speciální úkol spuštěný na každém výpočetním uzlu před jakýmkoli jiným úkolem úlohy.

jobPreparationTask?: BatchJobPreparationTaskOutput

Hodnota vlastnosti

BatchJobPreparationTaskOutput

jobReleaseTask

Úloha uvolnění úlohy. Úloha uvolnění úlohy je zvláštní úkol spuštěný na konci úlohy na každém výpočetním uzlu, který spustil jakoukoli jinou úlohu úlohy.

jobReleaseTask?: BatchJobReleaseTaskOutput

Hodnota vlastnosti

BatchJobReleaseTaskOutput

lastModified

Čas poslední změny úlohy. Jedná se o čas poslední změny dat na úrovni úlohy, jako je stav úlohy nebo priorita. Nefaktoruje změny na úrovni úkolu, jako je přidání nových úkolů nebo změny stavu úkolů.

lastModified: string

Hodnota vlastnosti

string

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?: 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 v dokončeném stavu. 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

Nastavení fondu přidružené k úloze.

poolInfo: BatchPoolInfoOutput

Hodnota vlastnosti

BatchPoolInfoOutput

previousState

Předchozí stav úlohy. Tato vlastnost není nastavena, pokud je úloha v počátečním aktivním stavu.

Možné hodnoty: "active", "zákaz", "disabled", "povolení", "ukončování", "dokončeno", "odstranění"

previousState?: string

Hodnota vlastnosti

string

previousStateTransitionTime

Čas, kdy úloha přešla do předchozího stavu. Tato vlastnost není nastavena, pokud je úloha v počátečním aktivním stavu.

previousStateTransitionTime?: string

Hodnota vlastnosti

string

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

state

Aktuální stav úlohy.

Možné hodnoty: "active", "zákaz", "disabled", "povolení", "ukončování", "dokončeno", "odstranění"

state: string

Hodnota vlastnosti

string

stateTransitionTime

Čas, kdy úloha vstoupila do aktuálního stavu.

stateTransitionTime: string

Hodnota vlastnosti

string

stats

Statistika využití prostředků po celou dobu životnosti úlohy. Tato vlastnost je naplněna pouze v případě, že služba BatchJob byla načtena s klauzulí rozbalení, včetně atributu 'stats'; jinak má hodnotu null. Statistiky nemusí být okamžitě dostupné. Služba Batch provádí pravidelné zavedení statistik. Typické zpoždění je asi 30 minut.

stats?: BatchJobStatisticsOutput

Hodnota vlastnosti

BatchJobStatisticsOutput

url

Adresa URL úlohy.

url: string

Hodnota vlastnosti

string

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