BatchJobCreateOptions interface

Paket:

@azure-rest/batch

Parametrar för att skapa ett Azure Batch-jobb.

Egenskaper

allowTaskPreemption	Om Aktiviteter i det här jobbet kan föregripas av andra högprioriterade jobb. (Den här egenskapen är inte tillgänglig som standard. Kontakta supporten om du vill ha mer information) Om värdet är inställt på True kommer andra jobb med hög prioritet som skickas till systemet att ha företräde och kommer att kunna köa om uppgifter från det här jobbet. Du kan uppdatera ett jobbs allowTaskPreemption när det har skapats med hjälp av API:et för uppdateringsjobbet.
commonEnvironmentSettings	Listan över vanliga miljövariabler. Dessa miljövariabler har angetts för alla aktiviteter i jobbet (inklusive Jobbhanteraren, Jobbförberedelse och Jobbpubliceringsuppgifter). Enskilda uppgifter kan åsidosätta en miljöinställning som anges här genom att ange samma inställningsnamn med ett annat värde.
constraints	Körningsbegränsningarna för jobbet.
displayName	Visningsnamnet för jobbet. Visningsnamnet behöver inte vara unikt och kan innehålla unicode-tecken upp till en maximal längd på 1024.
id	En sträng som unikt identifierar jobbet i kontot. 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 skiftlägesbevarande och skiftlägesokänsligt (dvs. du kanske inte har två ID:n inom ett konto som endast skiljer sig åt från fall till fall).
jobManagerTask	Information om en Job Manager-uppgift som ska startas när jobbet startas. Om jobbet inte anger någon Job Manager-uppgift måste användaren uttryckligen lägga till Uppgifter i jobbet. Om jobbet anger en Job Manager-uppgift skapar Batch-tjänsten jobbhanterarens uppgift när jobbet skapas och försöker schemalägga Job Manager-aktiviteten innan du schemalägger andra aktiviteter i jobbet. Den jobbansvariga aktivitetens typiska syfte är att styra och/eller övervaka jobbkörning, till exempel genom att bestämma vilka ytterligare aktiviteter som ska köras, avgöra när arbetet är klart osv. (En Jobbhanterare-uppgift är dock inte begränsad till dessa aktiviteter – det är en fullfjädrad uppgift i systemet och utför de åtgärder som krävs för jobbet.) En Job Manager-uppgift kan till exempel ladda ned en fil som anges som en parameter, analysera innehållet i filen och skicka ytterligare uppgifter baserat på innehållet.
jobPreparationTask	Jobbförberedelseaktiviteten. Om ett jobb har en jobbförberedelseaktivitet kör Batch-tjänsten jobbförberedelseaktiviteten på en nod innan du startar några uppgifter för jobbet på beräkningsnoden.
jobReleaseTask	Jobbpubliceringsaktiviteten. Det går inte att ange en jobbpubliceringsaktivitet utan att ange en jobbförberedelseaktivitet för jobbet. Batch-tjänsten kör jobbpubliceringsaktiviteten på noderna som har kört jobbförberedelseaktiviteten. Det primära syftet med jobbpubliceringsaktiviteten är att ångra ändringar i beräkningsnoder som gjorts av jobbförberedelseaktiviteten. Exempelaktiviteter är att ta bort lokala filer eller stänga av tjänster som startades som en del av jobbförberedelsen.
maxParallelTasks	Det maximala antalet aktiviteter som kan köras parallellt för jobbet. (Den här egenskapen är inte tillgänglig som standard. Kontakta supporten om du vill ha mer information) Värdet för maxParallelTasks måste vara -1 eller större än 0 om det anges. Om det inte anges är standardvärdet -1, vilket innebär att det inte finns någon gräns för antalet aktiviteter som kan köras samtidigt. Du kan uppdatera ett jobbs maxParallelTasks när det har skapats med api:et för uppdateringsjobbet.
metadata	En lista över namn/värde-par som är associerade med jobbet som metadata. Batch-tjänsten tilldelar ingen betydelse för metadata. det är endast för användning av användarkod.
networkConfiguration	(Den här egenskapen är inte tillgänglig som standard. Kontakta supporten om du vill ha mer information) Nätverkskonfigurationen för jobbet.
onAllTasksComplete	Den åtgärd som Batch-tjänsten ska vidta när alla uppgifter i jobbet är i slutfört tillstånd. Observera att om ett jobb inte innehåller några aktiviteter anses alla aktiviteter vara slutförda. Det här alternativet används därför oftast med en Job Manager-uppgift. Om du vill använda automatisk jobbavslut utan jobbhanterare bör du först ange onAllTasksComplete till noaction och uppdatera jobbegenskaperna för att ställa in onAllTasksComplete så att det avslutas när du har lagt till Uppgifter. Standardvärdet är noaction. Möjliga värden: "noaction", "terminatejob"
onTaskFailure	Den åtgärd som Batch-tjänsten ska vidta när en aktivitet i jobbet misslyckas. En aktivitet anses ha misslyckats om det finns ett failureInfo. Ett failureInfo anges om aktiviteten slutförs med en slutkod som inte är noll efter att det har förbrukat antalet återförsök, eller om det uppstod ett fel när aktiviteten startades, till exempel på grund av ett fel vid nedladdning av resursfilen. Standardvärdet är noaction. Möjliga värden: "noaction", "performexitoptionsjobaction"
poolInfo	Den pool där Batch-tjänsten kör jobbets uppgifter.
priority	Jobbets prioritet. Prioritetsvärden kan variera från -1000 till 1 000, där -1000 är den lägsta prioriteten och 1 000 som högsta prioritet. Standardvärdet är 0.
usesTaskDependencies	Om Uppgifter i jobbet kan definiera beroenden för varandra. Standardvärdet är falskt.

Egenskapsinformation

allowTaskPreemption

Om Aktiviteter i det här jobbet kan föregripas av andra högprioriterade jobb. (Den här egenskapen är inte tillgänglig som standard. Kontakta supporten om du vill ha mer information) Om värdet är inställt på True kommer andra jobb med hög prioritet som skickas till systemet att ha företräde och kommer att kunna köa om uppgifter från det här jobbet. Du kan uppdatera ett jobbs allowTaskPreemption när det har skapats med hjälp av API:et för uppdateringsjobbet.

allowTaskPreemption?: boolean

Egenskapsvärde

boolean

commonEnvironmentSettings

Listan över vanliga miljövariabler. Dessa miljövariabler har angetts för alla aktiviteter i jobbet (inklusive Jobbhanteraren, Jobbförberedelse och Jobbpubliceringsuppgifter). Enskilda uppgifter kan åsidosätta en miljöinställning som anges här genom att ange samma inställningsnamn med ett annat värde.

commonEnvironmentSettings?: EnvironmentSetting[]

Egenskapsvärde

EnvironmentSetting[]

constraints

Körningsbegränsningarna för jobbet.

constraints?: BatchJobConstraints

Egenskapsvärde

BatchJobConstraints

displayName

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

displayName?: string

Egenskapsvärde

string

id

En sträng som unikt identifierar jobbet i kontot. 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 skiftlägesbevarande och skiftlägesokänsligt (dvs. du kanske inte har två ID:n inom ett konto som endast skiljer sig åt från fall till fall).

id: string

Egenskapsvärde

string

jobManagerTask

Information om en Job Manager-uppgift som ska startas när jobbet startas. Om jobbet inte anger någon Job Manager-uppgift måste användaren uttryckligen lägga till Uppgifter i jobbet. Om jobbet anger en Job Manager-uppgift skapar Batch-tjänsten jobbhanterarens uppgift när jobbet skapas och försöker schemalägga Job Manager-aktiviteten innan du schemalägger andra aktiviteter i jobbet. Den jobbansvariga aktivitetens typiska syfte är att styra och/eller övervaka jobbkörning, till exempel genom att bestämma vilka ytterligare aktiviteter som ska köras, avgöra när arbetet är klart osv. (En Jobbhanterare-uppgift är dock inte begränsad till dessa aktiviteter – det är en fullfjädrad uppgift i systemet och utför de åtgärder som krävs för jobbet.) En Job Manager-uppgift kan till exempel ladda ned en fil som anges som en parameter, analysera innehållet i filen och skicka ytterligare uppgifter baserat på innehållet.

jobManagerTask?: BatchJobManagerTask

Egenskapsvärde

BatchJobManagerTask

jobPreparationTask

Jobbförberedelseaktiviteten. Om ett jobb har en jobbförberedelseaktivitet kör Batch-tjänsten jobbförberedelseaktiviteten på en nod innan du startar några uppgifter för jobbet på beräkningsnoden.

jobPreparationTask?: BatchJobPreparationTask

Egenskapsvärde

BatchJobPreparationTask

jobReleaseTask

Jobbpubliceringsaktiviteten. Det går inte att ange en jobbpubliceringsaktivitet utan att ange en jobbförberedelseaktivitet för jobbet. Batch-tjänsten kör jobbpubliceringsaktiviteten på noderna som har kört jobbförberedelseaktiviteten. Det primära syftet med jobbpubliceringsaktiviteten är att ångra ändringar i beräkningsnoder som gjorts av jobbförberedelseaktiviteten. Exempelaktiviteter är att ta bort lokala filer eller stänga av tjänster som startades som en del av jobbförberedelsen.

jobReleaseTask?: BatchJobReleaseTask

Egenskapsvärde

BatchJobReleaseTask

maxParallelTasks

Det maximala antalet aktiviteter som kan köras parallellt för jobbet. (Den här egenskapen är inte tillgänglig som standard. Kontakta supporten om du vill ha mer information) Värdet för maxParallelTasks måste vara -1 eller större än 0 om det anges. Om det inte anges är standardvärdet -1, vilket innebär att det inte finns någon gräns för antalet aktiviteter som kan köras samtidigt. Du kan uppdatera ett jobbs maxParallelTasks när det har skapats med api:et för uppdateringsjobbet.

maxParallelTasks?: number

Egenskapsvärde

number

metadata

En lista över namn/värde-par som är associerade med jobbet som metadata. Batch-tjänsten tilldelar ingen betydelse för metadata. det är endast för användning av användarkod.

metadata?: BatchMetadataItem[]

Egenskapsvärde

BatchMetadataItem[]

networkConfiguration

(Den här egenskapen är inte tillgänglig som standard. Kontakta supporten om du vill ha mer information) Nätverkskonfigurationen för jobbet.

networkConfiguration?: BatchJobNetworkConfiguration

Egenskapsvärde

BatchJobNetworkConfiguration

onAllTasksComplete

Den åtgärd som Batch-tjänsten ska vidta när alla uppgifter i jobbet är i slutfört tillstånd. Observera att om ett jobb inte innehåller några aktiviteter anses alla aktiviteter vara slutförda. Det här alternativet används därför oftast med en Job Manager-uppgift. Om du vill använda automatisk jobbavslut utan jobbhanterare bör du först ange onAllTasksComplete till noaction och uppdatera jobbegenskaperna för att ställa in onAllTasksComplete så att det avslutas när du har lagt till Uppgifter. Standardvärdet är noaction.

Möjliga värden: "noaction", "terminatejob"

onAllTasksComplete?: string

Egenskapsvärde

string

onTaskFailure

Den åtgärd som Batch-tjänsten ska vidta när en aktivitet i jobbet misslyckas. En aktivitet anses ha misslyckats om det finns ett failureInfo. Ett failureInfo anges om aktiviteten slutförs med en slutkod som inte är noll efter att det har förbrukat antalet återförsök, eller om det uppstod ett fel när aktiviteten startades, till exempel på grund av ett fel vid nedladdning av resursfilen. Standardvärdet är noaction.

Möjliga värden: "noaction", "performexitoptionsjobaction"

onTaskFailure?: string

Egenskapsvärde

string

poolInfo

Den pool där Batch-tjänsten kör jobbets uppgifter.

poolInfo: BatchPoolInfo

Egenskapsvärde

BatchPoolInfo

priority

Jobbets prioritet. Prioritetsvärden kan variera från -1000 till 1 000, där -1000 är den lägsta prioriteten och 1 000 som högsta prioritet. Standardvärdet är 0.

priority?: number

Egenskapsvärde

number

usesTaskDependencies

Om Uppgifter i jobbet kan definiera beroenden för varandra. Standardvärdet är falskt.

usesTaskDependencies?: boolean

Egenskapsvärde

boolean