BatchTask interface

Paket:

@azure/batch

Batch försöker utföra uppgifter igen när en återställningsåtgärd utlöses på en nod. Exempel på återställningsåtgärder är (men är inte begränsade till) när en nod med feltillstånd startas om eller en beräkningsnod försvinner på grund av värdfel. Återförsök på grund av återställningsåtgärder är oberoende av och räknas inte mot maxTaskRetryCount. Även om maxTaskRetryCount är 0 kan ett internt återförsök på grund av en återställningsåtgärd inträffa. Därför bör alla aktiviteter vara idempotent. Det innebär att Uppgifter måste tolerera att avbrytas och startas om utan att orsaka skada eller duplicera data. Bästa praxis för långvariga uppgifter är att använda någon form av kontrollpunkter.

Egenskaper

affinityInfo	En lokalitetstips som kan användas av batchtjänsten för att välja en beräkningsnod där den nya uppgiften ska startas.
applicationPackageReferences	En lista över paket som batchtjänsten kommer att distribuera till beräkningsnoden innan kommandoraden körs. Applikationspaket laddas ner och distribueras till en delad katalog, inte till arbetskatalogen Task. Därför, om ett refererat paket redan finns på Noden och är uppdaterat, så laddas det inte ner igen; den befintliga kopian på Compute Node används. Om ett refererat paket inte kan installeras, till exempel för att paketet har tagits bort eller för att nedladdningen misslyckades, misslyckas uppgiften.
authenticationTokenSettings	Inställningarna för en autentiseringstoken som aktiviteten kan använda för att utföra Batch-tjänståtgärder. Om denna egenskap är inställd förser batchtjänsten uppgiften med en autentiseringstoken som kan användas för att autentisera batchtjänstoperationer utan att behöva en kontoåtkomstnyckel. Token tillhandahålls via miljövariabeln AZ_BATCH_AUTHENTICATION_TOKEN. De operationer som Uppgiften kan utföra med token beror på inställningarna. Till exempel kan en uppgift begära jobbbehörigheter för att lägga till andra uppgifter i jobbet, eller kontrollera statusen för jobbet eller andra uppgifter under jobbet.
commandLine	Kommandoraden för Uppgiften. För multi-instansuppgifter exekveras kommandoraden som primär uppgift, efter att primäruppgiften och alla deluppgifter har kört koordinatraden. Kommandoraden körs inte under ett gränssnitt och kan därför inte dra nytta av gränssnittsfunktioner som miljövariabelexpansion. Om du vill dra nytta av sådana funktioner bör du anropa gränssnittet på kommandoraden, till exempel med hjälp av "cmd /c MyCommand" i Windows eller "/bin/sh -c MyCommand" i Linux. Om kommandoraden refererar till filsökvägar bör den använda en relativ sökväg (i förhållande till arbetskatalogen Uppgift) eller använda miljövariabeln i Batch (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).
constraints	Exekveringsbegränsningarna som gäller för denna uppgift.
containerSettings	Inställningarna för containern under vilken uppgiften körs. Om poolen som ska köra denna uppgift har containerConfiguration inställd, måste detta också ställas in. Om poolen som ska köra denna uppgift inte har containerConfiguration satt, får detta inte sättas. När detta anges mappas alla kataloger rekursivt under AZ_BATCH_NODE_ROOT_DIR (roten till Azure Batch-katalogerna på noden) in i containern, alla Task-miljövariabler mappas in i containern och Task-kommandoraden körs i containern. Filer som produceras i containern utanför AZ_BATCH_NODE_ROOT_DIR kanske inte reflekteras till värddisken, vilket innebär att batchfil-API:er inte kan komma åt dessa filer.
creationTime	Uppdragets skapelsetid.
dependsOn	De uppgifter som denna uppgift beror på. Denna uppgift kommer inte att schemaläggas förrän alla uppgifter den är beroende av har slutförts framgångsrikt. Om någon av dessa uppgifter misslyckas och förbrukar sina försök kommer denna uppgift aldrig att schemaliseras.
displayName	Ett visningsnamn för Uppgiften. Visningsnamnet behöver inte vara unikt och kan innehålla unicode-tecken upp till en maximal längd på 1024.
environmentSettings	En lista över miljövariableinställningar för uppgiften.
eTag	Uppgiftens ETag. Det här är en ogenomskinlig sträng. Du kan använda den för att upptäcka om uppgiften har ändrats mellan förfrågningarna. Specifikt kan du skicka ETag när du uppdaterar en uppgift för att specificera att dina ändringar endast ska träda i kraft om ingen annan har ändrat uppgiften under tiden.
executionInfo	Information om utförandet av uppgiften.
exitConditions	Hur batchtjänsten ska svara när uppgiften slutförs.
id	En sträng som unikt identifierar uppgiften inom jobbet. ID:t kan innehålla valfri kombination av alfanumeriska tecken, inklusive bindestreck och understreck, och får inte innehålla fler än 64 tecken.
lastModified	Den sista modifierade tiden för Uppgiften.
multiInstanceSettings	Ett objekt som indikerar att uppgiften är en multi-instans Task och innehåller information om hur multi-instans-Tasken ska köras.
nodeInfo	Information om den beräkningsnod som uppgiften kördes på.
outputFiles	En lista över filer som Batch-tjänsten laddar upp från Compute Node efter att kommandoraden har körts. För flerinstansuppgifter laddas filerna endast upp från den beräkningsnod där huvuduppgiften körs.
previousState	Uppgiftens tidigare tillstånd. Denna egenskap sätts inte om Uppgiften är i sitt initiala aktiva tillstånd.
previousStateTransitionTime	Den tidpunkt då Uppgiften gick in i sitt tidigare tillstånd. Denna egenskap sätts inte om Uppgiften är i sitt initiala aktiva tillstånd.
requiredSlots	Antalet schemaläggningsplatser som Uppgiften kräver för att köras. Standardvärdet är 1. En Task kan endast schemaläggas att köras på en beräkningsnod om noden har tillräckligt många lediga schemaläggningsplatser tillgängliga. För uppgifter med flera instanser måste detta vara 1.
resourceFiles	En lista över filer som Batch-tjänsten laddar ned till beräkningsnoden innan du kör kommandoraden. För flerinstansuppgifter kommer resursfilerna endast att laddas ner till den beräkningsnod där huvuduppgiften körs. Det finns en maximal storlek för listan över resursfiler. När maxstorleken överskrids misslyckas begäran och svarsfelkoden requestEntityTooLarge. Om detta inträffar måste samlingen av ResourceFiles minskas i storlek. Detta kan uppnås med hjälp av .zip filer, programpaket eller Docker-containrar.
state	Uppgiftens nuvarande tillstånd.
stateTransitionTime	Den tidpunkt då Uppgiften gick in i sitt nuvarande tillstånd.
taskStatistics	Resursanvändningsstatistik för uppgiften.
url	URL:en till uppgiften.
userIdentity	Användaridentiteten under vilken uppgiften körs. Om den utelämnas körs Uppgiften som en icke-administrativ användare unik för uppgiften.

Fastighetsdetaljer

affinityInfo

En lokalitetstips som kan användas av batchtjänsten för att välja en beräkningsnod där den nya uppgiften ska startas.

affinityInfo?: BatchAffinityInfo

Fastighetsvärde

BatchAffinityInfo

applicationPackageReferences

En lista över paket som batchtjänsten kommer att distribuera till beräkningsnoden innan kommandoraden körs. Applikationspaket laddas ner och distribueras till en delad katalog, inte till arbetskatalogen Task. Därför, om ett refererat paket redan finns på Noden och är uppdaterat, så laddas det inte ner igen; den befintliga kopian på Compute Node används. Om ett refererat paket inte kan installeras, till exempel för att paketet har tagits bort eller för att nedladdningen misslyckades, misslyckas uppgiften.

applicationPackageReferences?: BatchApplicationPackageReference[]

Fastighetsvärde

BatchApplicationPackageReference[]

authenticationTokenSettings

Inställningarna för en autentiseringstoken som aktiviteten kan använda för att utföra Batch-tjänståtgärder. Om denna egenskap är inställd förser batchtjänsten uppgiften med en autentiseringstoken som kan användas för att autentisera batchtjänstoperationer utan att behöva en kontoåtkomstnyckel. Token tillhandahålls via miljövariabeln AZ_BATCH_AUTHENTICATION_TOKEN. De operationer som Uppgiften kan utföra med token beror på inställningarna. Till exempel kan en uppgift begära jobbbehörigheter för att lägga till andra uppgifter i jobbet, eller kontrollera statusen för jobbet eller andra uppgifter under jobbet.

authenticationTokenSettings?: AuthenticationTokenSettings

Fastighetsvärde

AuthenticationTokenSettings

commandLine

Kommandoraden för Uppgiften. För multi-instansuppgifter exekveras kommandoraden som primär uppgift, efter att primäruppgiften och alla deluppgifter har kört koordinatraden. Kommandoraden körs inte under ett gränssnitt och kan därför inte dra nytta av gränssnittsfunktioner som miljövariabelexpansion. Om du vill dra nytta av sådana funktioner bör du anropa gränssnittet på kommandoraden, till exempel med hjälp av "cmd /c MyCommand" i Windows eller "/bin/sh -c MyCommand" i Linux. Om kommandoraden refererar till filsökvägar bör den använda en relativ sökväg (i förhållande till arbetskatalogen Uppgift) eller använda miljövariabeln i Batch (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

commandLine: string

Fastighetsvärde

string

constraints

Exekveringsbegränsningarna som gäller för denna uppgift.

constraints?: BatchTaskConstraints

Fastighetsvärde

BatchTaskConstraints

containerSettings

Inställningarna för containern under vilken uppgiften körs. Om poolen som ska köra denna uppgift har containerConfiguration inställd, måste detta också ställas in. Om poolen som ska köra denna uppgift inte har containerConfiguration satt, får detta inte sättas. När detta anges mappas alla kataloger rekursivt under AZ_BATCH_NODE_ROOT_DIR (roten till Azure Batch-katalogerna på noden) in i containern, alla Task-miljövariabler mappas in i containern och Task-kommandoraden körs i containern. Filer som produceras i containern utanför AZ_BATCH_NODE_ROOT_DIR kanske inte reflekteras till värddisken, vilket innebär att batchfil-API:er inte kan komma åt dessa filer.

containerSettings?: BatchTaskContainerSettings

Fastighetsvärde

BatchTaskContainerSettings

creationTime

Uppdragets skapelsetid.

creationTime: Date

Fastighetsvärde

Date

dependsOn

De uppgifter som denna uppgift beror på. Denna uppgift kommer inte att schemaläggas förrän alla uppgifter den är beroende av har slutförts framgångsrikt. Om någon av dessa uppgifter misslyckas och förbrukar sina försök kommer denna uppgift aldrig att schemaliseras.

dependsOn?: BatchTaskDependencies

Fastighetsvärde

BatchTaskDependencies

displayName

Ett visningsnamn för Uppgiften. Visningsnamnet behöver inte vara unikt och kan innehålla unicode-tecken upp till en maximal längd på 1024.

displayName?: string

Fastighetsvärde

string

environmentSettings

En lista över miljövariableinställningar för uppgiften.

environmentSettings?: EnvironmentSetting[]

Fastighetsvärde

EnvironmentSetting[]

eTag

Uppgiftens ETag. Det här är en ogenomskinlig sträng. Du kan använda den för att upptäcka om uppgiften har ändrats mellan förfrågningarna. Specifikt kan du skicka ETag när du uppdaterar en uppgift för att specificera att dina ändringar endast ska träda i kraft om ingen annan har ändrat uppgiften under tiden.

eTag: string

Fastighetsvärde

string

executionInfo

Information om utförandet av uppgiften.

executionInfo?: BatchTaskExecutionInfo

Fastighetsvärde

BatchTaskExecutionInfo

exitConditions

Hur batchtjänsten ska svara när uppgiften slutförs.

exitConditions?: ExitConditions

Fastighetsvärde

ExitConditions

id

En sträng som unikt identifierar uppgiften inom jobbet. ID:t kan innehålla valfri kombination av alfanumeriska tecken, inklusive bindestreck och understreck, och får inte innehålla fler än 64 tecken.

id: string

Fastighetsvärde

string

lastModified

Den sista modifierade tiden för Uppgiften.

lastModified: Date

Fastighetsvärde

Date

multiInstanceSettings

Ett objekt som indikerar att uppgiften är en multi-instans Task och innehåller information om hur multi-instans-Tasken ska köras.

multiInstanceSettings?: MultiInstanceSettings

Fastighetsvärde

MultiInstanceSettings

nodeInfo

Information om den beräkningsnod som uppgiften kördes på.

nodeInfo?: BatchNodeInfo

Fastighetsvärde

BatchNodeInfo

outputFiles

En lista över filer som Batch-tjänsten laddar upp från Compute Node efter att kommandoraden har körts. För flerinstansuppgifter laddas filerna endast upp från den beräkningsnod där huvuduppgiften körs.

outputFiles?: OutputFile[]

Fastighetsvärde

OutputFile[]

previousState

Uppgiftens tidigare tillstånd. Denna egenskap sätts inte om Uppgiften är i sitt initiala aktiva tillstånd.

previousState?: BatchTaskState

Fastighetsvärde

BatchTaskState

previousStateTransitionTime

Den tidpunkt då Uppgiften gick in i sitt tidigare tillstånd. Denna egenskap sätts inte om Uppgiften är i sitt initiala aktiva tillstånd.

previousStateTransitionTime?: Date

Fastighetsvärde

Date

requiredSlots

Antalet schemaläggningsplatser som Uppgiften kräver för att köras. Standardvärdet är 1. En Task kan endast schemaläggas att köras på en beräkningsnod om noden har tillräckligt många lediga schemaläggningsplatser tillgängliga. För uppgifter med flera instanser måste detta vara 1.

requiredSlots?: number

Fastighetsvärde

number

resourceFiles

En lista över filer som Batch-tjänsten laddar ned till beräkningsnoden innan du kör kommandoraden. För flerinstansuppgifter kommer resursfilerna endast att laddas ner till den beräkningsnod där huvuduppgiften körs. Det finns en maximal storlek för listan över resursfiler. När maxstorleken överskrids misslyckas begäran och svarsfelkoden requestEntityTooLarge. Om detta inträffar måste samlingen av ResourceFiles minskas i storlek. Detta kan uppnås med hjälp av .zip filer, programpaket eller Docker-containrar.

resourceFiles?: ResourceFile[]

Fastighetsvärde

ResourceFile[]

state

Uppgiftens nuvarande tillstånd.

state: BatchTaskState

Fastighetsvärde

BatchTaskState

stateTransitionTime

Den tidpunkt då Uppgiften gick in i sitt nuvarande tillstånd.

stateTransitionTime: Date

Fastighetsvärde

Date

taskStatistics

Resursanvändningsstatistik för uppgiften.

taskStatistics?: BatchTaskStatistics

Fastighetsvärde

BatchTaskStatistics

url

URL:en till uppgiften.

url: string

Fastighetsvärde

string

userIdentity

Användaridentiteten under vilken uppgiften körs. Om den utelämnas körs Uppgiften som en icke-administrativ användare unik för uppgiften.

userIdentity?: UserIdentity

Fastighetsvärde

UserIdentity