BatchJobOutput interface

Paket:

@azure-rest/batch

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.
creationTime	Tiden då jobbet skapades.
displayName	Visningsnamnet för jobbet.
eTag	ETag för jobbet. Det här är en ogenomskinlig sträng. Du kan använda den för att identifiera om jobbet har ändrats mellan begäranden. I synnerhet kan du skicka ETag när du uppdaterar ett jobb för att ange att ändringarna endast ska börja gälla om ingen annan har ändrat jobbet under tiden.
executionInfo	Körningsinformationen för jobbet.
id	En sträng som unikt identifierar jobbet i kontot. 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.
jobPreparationTask	Jobbförberedelseaktiviteten. Jobbförberedelseaktiviteten är en särskild aktivitet som körs på varje beräkningsnod före någon annan uppgift i jobbet.
jobReleaseTask	Jobbpubliceringsaktiviteten. Jobbpubliceringsaktiviteten är en särskild aktivitetskörning i slutet av jobbet på varje beräkningsnod som har kört någon annan uppgift i jobbet.
lastModified	Den senaste ändrade tiden för jobbet. Det här är den sista gången som data på jobbnivå, till exempel jobbtillstånd eller prioritet, ändrades. Den tar inte hänsyn till ändringar på aktivitetsnivå, till exempel att lägga till nya aktiviteter eller ändra tillstånd för aktiviteter.
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. 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	Poolinställningarna som är associerade med jobbet.
previousState	Det tidigare tillståndet för jobbet. Den här egenskapen anges inte om jobbet är i sitt ursprungliga aktiva tillstånd. Möjliga värden: "active", "disabling", "disabled", "enabling", "terminating", "completed", "ta bort"
previousStateTransitionTime	Den tid då jobbet angav sitt tidigare tillstånd. Den här egenskapen anges inte om jobbet är i sitt ursprungliga aktiva tillstånd.
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.
state	Jobbets aktuella tillstånd. Möjliga värden: "active", "disabling", "disabled", "enabling", "terminating", "completed", "ta bort"
stateTransitionTime	Den tid då jobbet angav sitt aktuella tillstånd.
stats	Resursanvändningsstatistik för hela jobbets livslängd. Den här egenskapen fylls bara i om BatchJob hämtades med en expanderingssats, inklusive attributet stats. annars är den null. Statistiken kanske inte är omedelbart tillgänglig. Batch-tjänsten utför periodisk sammanslagning av statistik. Den typiska fördröjningen är cirka 30 minuter.
url	Jobbets URL.
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?: EnvironmentSettingOutput[]

Egenskapsvärde

EnvironmentSettingOutput[]

constraints

Körningsbegränsningarna för jobbet.

constraints?: BatchJobConstraintsOutput

Egenskapsvärde

BatchJobConstraintsOutput

creationTime

Tiden då jobbet skapades.

creationTime: string

Egenskapsvärde

string

displayName

Visningsnamnet för jobbet.

displayName?: string

Egenskapsvärde

string

eTag

ETag för jobbet. Det här är en ogenomskinlig sträng. Du kan använda den för att identifiera om jobbet har ändrats mellan begäranden. I synnerhet kan du skicka ETag när du uppdaterar ett jobb för att ange att ändringarna endast ska börja gälla om ingen annan har ändrat jobbet under tiden.

eTag: string

Egenskapsvärde

string

executionInfo

Körningsinformationen för jobbet.

executionInfo?: BatchJobExecutionInfoOutput

Egenskapsvärde

BatchJobExecutionInfoOutput

id

En sträng som unikt identifierar jobbet i kontot. 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.

jobManagerTask?: BatchJobManagerTaskOutput

Egenskapsvärde

BatchJobManagerTaskOutput

jobPreparationTask

Jobbförberedelseaktiviteten. Jobbförberedelseaktiviteten är en särskild aktivitet som körs på varje beräkningsnod före någon annan uppgift i jobbet.

jobPreparationTask?: BatchJobPreparationTaskOutput

Egenskapsvärde

BatchJobPreparationTaskOutput

jobReleaseTask

Jobbpubliceringsaktiviteten. Jobbpubliceringsaktiviteten är en särskild aktivitetskörning i slutet av jobbet på varje beräkningsnod som har kört någon annan uppgift i jobbet.

jobReleaseTask?: BatchJobReleaseTaskOutput

Egenskapsvärde

BatchJobReleaseTaskOutput

lastModified

Den senaste ändrade tiden för jobbet. Det här är den sista gången som data på jobbnivå, till exempel jobbtillstånd eller prioritet, ändrades. Den tar inte hänsyn till ändringar på aktivitetsnivå, till exempel att lägga till nya aktiviteter eller ändra tillstånd för aktiviteter.

lastModified: string

Egenskapsvärde

string

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?: BatchMetadataItemOutput[]

Egenskapsvärde

BatchMetadataItemOutput[]

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?: BatchJobNetworkConfigurationOutput

Egenskapsvärde

BatchJobNetworkConfigurationOutput

onAllTasksComplete

Den åtgärd som Batch-tjänsten ska vidta när alla uppgifter i jobbet är i slutfört tillstånd. 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

Poolinställningarna som är associerade med jobbet.

poolInfo: BatchPoolInfoOutput

Egenskapsvärde

BatchPoolInfoOutput

previousState

Det tidigare tillståndet för jobbet. Den här egenskapen anges inte om jobbet är i sitt ursprungliga aktiva tillstånd.

Möjliga värden: "active", "disabling", "disabled", "enabling", "terminating", "completed", "ta bort"

previousState?: string

Egenskapsvärde

string

previousStateTransitionTime

Den tid då jobbet angav sitt tidigare tillstånd. Den här egenskapen anges inte om jobbet är i sitt ursprungliga aktiva tillstånd.

previousStateTransitionTime?: string

Egenskapsvärde

string

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

state

Jobbets aktuella tillstånd.

Möjliga värden: "active", "disabling", "disabled", "enabling", "terminating", "completed", "ta bort"

state: string

Egenskapsvärde

string

stateTransitionTime

Den tid då jobbet angav sitt aktuella tillstånd.

stateTransitionTime: string

Egenskapsvärde

string

stats

Resursanvändningsstatistik för hela jobbets livslängd. Den här egenskapen fylls bara i om BatchJob hämtades med en expanderingssats, inklusive attributet stats. annars är den null. Statistiken kanske inte är omedelbart tillgänglig. Batch-tjänsten utför periodisk sammanslagning av statistik. Den typiska fördröjningen är cirka 30 minuter.

stats?: BatchJobStatisticsOutput

Egenskapsvärde

BatchJobStatisticsOutput

url

Jobbets URL.

url: string

Egenskapsvärde

string

usesTaskDependencies

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

usesTaskDependencies?: boolean

Egenskapsvärde

boolean