BatchTaskCreateOptions interface

Paket:

@azure/batch

Parametrar för att skapa en Azure Batch-uppgift.

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. Om du inte specificerar begränsningar är maxTaskRetryCount maxTaskRetryCount som specificerats för jobbet, maxWallClockTime är oändlig, och retentionTime är 7 dagar.
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.
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. Om Jobbet inte har usesTaskDependencies satt till true, och detta element finns, misslyckas förfrågan med felkoden TaskDependenciesNotSpecificifiedOnJob.
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.
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. ID:t är fallbevarande och kasus-okänsligt (det vill säga, du kanske inte har två ID:n inom ett jobb som skiljer sig endast åt med enus).
multiInstanceSettings	Ett objekt som indikerar att uppgiften är en multi-instans Task och innehåller information om hur multi-instans-Tasken ska köras.
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.
requiredSlots	Antalet schemaläggningsplatser som Uppgiften krävde 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.
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. Om du inte specificerar begränsningar är maxTaskRetryCount maxTaskRetryCount som specificerats för jobbet, maxWallClockTime är oändlig, och retentionTime är 7 dagar.

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

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. Om Jobbet inte har usesTaskDependencies satt till true, och detta element finns, misslyckas förfrågan med felkoden TaskDependenciesNotSpecificifiedOnJob.

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[]

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:t är fallbevarande och kasus-okänsligt (det vill säga, du kanske inte har två ID:n inom ett jobb som skiljer sig endast åt med enus).

id: string

Fastighetsvärde

string

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

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[]

requiredSlots

Antalet schemaläggningsplatser som Uppgiften krävde 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[]

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