BatchJob interface

Paket:

@azure/batch

Ein Azure Batch Job.

Eigenschaften

allowTaskPreemption	Ob Aufgaben in diesem Auftrag von anderen Aufträgen mit hoher Priorität vorgebeutet werden können. (Diese Eigenschaft ist standardmäßig nicht verfügbar. Wenden Sie sich für weitere Informationen an den Support.) Wenn der Wert auf "True" festgelegt ist, haben andere Aufträge mit hoher Priorität, die an das System übermittelt werden, Vorrang und können Aufgaben aus diesem Auftrag erneut in die Warteschlange einreihen. Sie können die AllowTaskPreemption eines Auftrags aktualisieren, nachdem er mithilfe der Updateauftrags-API erstellt wurde.
allTasksCompleteMode	Die Aktion, die der Batchdienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Abgeschlossenen Zustand befinden. Der Standardwert ist keine Aktion.
commonEnvironmentSettings	Die Liste der allgemeinen Umgebungsvariableneinstellungen. Diese Umgebungsvariablen werden für alle Aufgaben im Auftrag festgelegt (einschließlich job manager, Job Preparation and Job Release Tasks). Einzelne Aufgaben können eine hier angegebene Umgebungseinstellung außer Kraft setzen, indem sie denselben Einstellungsnamen mit einem anderen Wert angeben.
constraints	Die Ausführungseinschränkungen für den Auftrag.
creationTime	Die Erstellungszeit des Auftrags.
displayName	Der Anzeigename für den Auftrag.
eTag	Das ETag des Auftrags. Dies ist eine undurchsichtige Zeichenfolge. Sie können es verwenden, um zu erkennen, ob sich der Auftrag zwischen Anforderungen geändert hat. Insbesondere können Sie das ETag übergeben, wenn Sie einen Auftrag aktualisieren, um anzugeben, dass Ihre Änderungen nur wirksam werden sollen, wenn niemand sonst den Auftrag in der Zwischenzeit geändert hat.
executionInfo	Die Ausführungsinformationen für den Auftrag.
id	Eine Zeichenfolge, die den Auftrag innerhalb des Kontos eindeutig identifiziert. Bei der ID wird die Groß-/Kleinschreibung beibehalten und die Groß-/Kleinschreibung nicht beachtet (d. h., Sie verfügen möglicherweise nicht über zwei IDs innerhalb eines Kontos, die nur nach Groß-/Kleinschreibung abweichen).
jobManagerTask	Details zu einer Job Manager-Aufgabe, die gestartet werden soll, wenn der Auftrag gestartet wird.
jobPreparationTask	Der Vorgang zur Auftragsvorbereitung. Der Auftragsvorbereitungsvorgang ist eine spezielle Aufgabe, die auf jedem Computeknoten ausgeführt wird, bevor eine andere Aufgabe des Auftrags ausgeführt wird.
jobReleaseTask	Die Aufgabe "Auftragsfreigabe". Die Auftragsfreigabeaufgabe ist eine spezielle Aufgabe, die am Ende des Auftrags auf jedem Computeknoten ausgeführt wird, der eine andere Aufgabe des Auftrags ausgeführt hat.
jobStatistics	Ressourcennutzungsstatistiken für die gesamte Lebensdauer des Auftrags. Diese Eigenschaft wird nur aufgefüllt, wenn der BatchJob mit einer Erweiterungsklausel abgerufen wurde, einschließlich des Attributs "stats"; andernfalls ist sie NULL. Die Statistiken sind möglicherweise nicht sofort verfügbar. Der Batchdienst führt regelmäßige Rollups von Statistiken durch. Die typische Verzögerung beträgt ca. 30 Minuten.
lastModified	Der Zeitpunkt der letzten Änderung des Auftrags. Dies ist das letzte Mal, zu dem die Daten auf Auftragsebene, z. B. der Auftragsstatus oder die Priorität, geändert wurden. Es spielt keine Rolle bei Änderungen auf Vorgangsebene, z. B. beim Hinzufügen neuer Vorgänge oder von Vorgängen, die den Zustand ändern.
maxParallelTasks	Die maximale Anzahl von Vorgängen, die parallel für den Auftrag ausgeführt werden können. (Diese Eigenschaft ist standardmäßig nicht verfügbar. Wenden Sie sich für weitere Informationen an den Support.) Der Wert von maxParallelTasks muss -1 oder größer als 0 sein, falls angegeben. Wenn nicht angegeben, ist der Standardwert -1, was bedeutet, dass es keine Beschränkung für die Anzahl der Aufgaben gibt, die gleichzeitig ausgeführt werden können. Sie können die maxParallelTasks eines Auftrags aktualisieren, nachdem er mithilfe der Updateauftrags-API erstellt wurde.
metadata	Eine Liste von Name-Wert-Paaren, die dem Auftrag als Metadaten zugeordnet sind. Der Batchdienst weist Metadaten keine Bedeutung zu; sie ist ausschließlich für die Verwendung von Benutzercode vorgesehen.
networkConfiguration	(Diese Eigenschaft ist standardmäßig nicht verfügbar. Weitere Informationen erhalten Sie vom Support) Die Netzwerkkonfiguration für den Job.
poolInfo	Die Pooleinstellungen, die dem Auftrag zugeordnet sind.
previousState	Der vorherige Status des Auftrags. Diese Eigenschaft wird nicht festgelegt, wenn sich der Auftrag im anfangs aktiven Zustand befindet.
previousStateTransitionTime	Die Zeit, zu der der Auftrag seinen vorherigen Zustand eingegeben hat. Diese Eigenschaft wird nicht festgelegt, wenn sich der Auftrag im anfangs aktiven Zustand befindet.
priority	Die Priorität des Auftrags. Prioritätswerte können zwischen -1000 und 1000 liegen, wobei -1000 die niedrigste Priorität und 1000 die höchste Priorität sind. Der Standardwert ist 0.
state	Der aktuelle Status des Auftrags.
stateTransitionTime	Die Zeit, zu der der Auftrag seinen aktuellen Zustand eingegeben hat.
taskFailureMode	Die Aktion, die der Batchdienst ausführen soll, wenn eine Aufgabe im Auftrag fehlschlägt. Eine Aufgabe wird als fehlgeschlagen betrachtet, wenn eine failureInfo vorhanden ist. Eine failureInfo wird festgelegt, wenn der Vorgang mit einem Nicht-Null-Beendigungscode abgeschlossen wird, nachdem die Wiederholungsanzahl aufgebraucht wurde, oder wenn ein Fehler beim Starten des Vorgangs aufgetreten ist, z. B. aufgrund eines Fehlers beim Herunterladen einer Ressourcendatei. Der Standardwert ist keine Aktion.
url	Die URL des Auftrags.
usesTaskDependencies	Gibt an, ob Aufgaben im Auftrag Abhängigkeiten voneinander definieren können. Die Standardeinstellung ist „false“.

Details zur Eigenschaft

allowTaskPreemption

Ob Aufgaben in diesem Auftrag von anderen Aufträgen mit hoher Priorität vorgebeutet werden können. (Diese Eigenschaft ist standardmäßig nicht verfügbar. Wenden Sie sich für weitere Informationen an den Support.) Wenn der Wert auf "True" festgelegt ist, haben andere Aufträge mit hoher Priorität, die an das System übermittelt werden, Vorrang und können Aufgaben aus diesem Auftrag erneut in die Warteschlange einreihen. Sie können die AllowTaskPreemption eines Auftrags aktualisieren, nachdem er mithilfe der Updateauftrags-API erstellt wurde.

allowTaskPreemption?: boolean

Eigenschaftswert

boolean

allTasksCompleteMode

Die Aktion, die der Batchdienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Abgeschlossenen Zustand befinden. Der Standardwert ist keine Aktion.

allTasksCompleteMode?: BatchAllTasksCompleteMode

Eigenschaftswert

BatchAllTasksCompleteMode

commonEnvironmentSettings

Die Liste der allgemeinen Umgebungsvariableneinstellungen. Diese Umgebungsvariablen werden für alle Aufgaben im Auftrag festgelegt (einschließlich job manager, Job Preparation and Job Release Tasks). Einzelne Aufgaben können eine hier angegebene Umgebungseinstellung außer Kraft setzen, indem sie denselben Einstellungsnamen mit einem anderen Wert angeben.

commonEnvironmentSettings?: EnvironmentSetting[]

Eigenschaftswert

EnvironmentSetting[]

constraints

Die Ausführungseinschränkungen für den Auftrag.

constraints?: BatchJobConstraints

Eigenschaftswert

BatchJobConstraints

creationTime

Die Erstellungszeit des Auftrags.

creationTime: Date

Eigenschaftswert

Date

displayName

Der Anzeigename für den Auftrag.

displayName?: string

Eigenschaftswert

string

eTag

Das ETag des Auftrags. Dies ist eine undurchsichtige Zeichenfolge. Sie können es verwenden, um zu erkennen, ob sich der Auftrag zwischen Anforderungen geändert hat. Insbesondere können Sie das ETag übergeben, wenn Sie einen Auftrag aktualisieren, um anzugeben, dass Ihre Änderungen nur wirksam werden sollen, wenn niemand sonst den Auftrag in der Zwischenzeit geändert hat.

eTag: string

Eigenschaftswert

string

executionInfo

Die Ausführungsinformationen für den Auftrag.

executionInfo?: BatchJobExecutionInfo

Eigenschaftswert

BatchJobExecutionInfo

id

Eine Zeichenfolge, die den Auftrag innerhalb des Kontos eindeutig identifiziert. Bei der ID wird die Groß-/Kleinschreibung beibehalten und die Groß-/Kleinschreibung nicht beachtet (d. h., Sie verfügen möglicherweise nicht über zwei IDs innerhalb eines Kontos, die nur nach Groß-/Kleinschreibung abweichen).

id: string

Eigenschaftswert

string

jobManagerTask

Details zu einer Job Manager-Aufgabe, die gestartet werden soll, wenn der Auftrag gestartet wird.

jobManagerTask?: BatchJobManagerTask

Eigenschaftswert

BatchJobManagerTask

jobPreparationTask

Der Vorgang zur Auftragsvorbereitung. Der Auftragsvorbereitungsvorgang ist eine spezielle Aufgabe, die auf jedem Computeknoten ausgeführt wird, bevor eine andere Aufgabe des Auftrags ausgeführt wird.

jobPreparationTask?: BatchJobPreparationTask

Eigenschaftswert

BatchJobPreparationTask

jobReleaseTask

Die Aufgabe "Auftragsfreigabe". Die Auftragsfreigabeaufgabe ist eine spezielle Aufgabe, die am Ende des Auftrags auf jedem Computeknoten ausgeführt wird, der eine andere Aufgabe des Auftrags ausgeführt hat.

jobReleaseTask?: BatchJobReleaseTask

Eigenschaftswert

BatchJobReleaseTask

jobStatistics

Ressourcennutzungsstatistiken für die gesamte Lebensdauer des Auftrags. Diese Eigenschaft wird nur aufgefüllt, wenn der BatchJob mit einer Erweiterungsklausel abgerufen wurde, einschließlich des Attributs "stats"; andernfalls ist sie NULL. Die Statistiken sind möglicherweise nicht sofort verfügbar. Der Batchdienst führt regelmäßige Rollups von Statistiken durch. Die typische Verzögerung beträgt ca. 30 Minuten.

jobStatistics?: BatchJobStatistics

Eigenschaftswert

BatchJobStatistics

lastModified

Der Zeitpunkt der letzten Änderung des Auftrags. Dies ist das letzte Mal, zu dem die Daten auf Auftragsebene, z. B. der Auftragsstatus oder die Priorität, geändert wurden. Es spielt keine Rolle bei Änderungen auf Vorgangsebene, z. B. beim Hinzufügen neuer Vorgänge oder von Vorgängen, die den Zustand ändern.

lastModified: Date

Eigenschaftswert

Date

maxParallelTasks

Die maximale Anzahl von Vorgängen, die parallel für den Auftrag ausgeführt werden können. (Diese Eigenschaft ist standardmäßig nicht verfügbar. Wenden Sie sich für weitere Informationen an den Support.) Der Wert von maxParallelTasks muss -1 oder größer als 0 sein, falls angegeben. Wenn nicht angegeben, ist der Standardwert -1, was bedeutet, dass es keine Beschränkung für die Anzahl der Aufgaben gibt, die gleichzeitig ausgeführt werden können. Sie können die maxParallelTasks eines Auftrags aktualisieren, nachdem er mithilfe der Updateauftrags-API erstellt wurde.

maxParallelTasks?: number

Eigenschaftswert

number

metadata

Eine Liste von Name-Wert-Paaren, die dem Auftrag als Metadaten zugeordnet sind. Der Batchdienst weist Metadaten keine Bedeutung zu; sie ist ausschließlich für die Verwendung von Benutzercode vorgesehen.

metadata?: BatchMetadataItem[]

Eigenschaftswert

BatchMetadataItem[]

networkConfiguration

(Diese Eigenschaft ist standardmäßig nicht verfügbar. Weitere Informationen erhalten Sie vom Support) Die Netzwerkkonfiguration für den Job.

networkConfiguration?: BatchJobNetworkConfiguration

Eigenschaftswert

BatchJobNetworkConfiguration

poolInfo

Die Pooleinstellungen, die dem Auftrag zugeordnet sind.

poolInfo: BatchPoolInfo

Eigenschaftswert

BatchPoolInfo

previousState

Der vorherige Status des Auftrags. Diese Eigenschaft wird nicht festgelegt, wenn sich der Auftrag im anfangs aktiven Zustand befindet.

previousState?: BatchJobState

Eigenschaftswert

BatchJobState

previousStateTransitionTime

Die Zeit, zu der der Auftrag seinen vorherigen Zustand eingegeben hat. Diese Eigenschaft wird nicht festgelegt, wenn sich der Auftrag im anfangs aktiven Zustand befindet.

previousStateTransitionTime?: Date

Eigenschaftswert

Date

priority

Die Priorität des Auftrags. Prioritätswerte können zwischen -1000 und 1000 liegen, wobei -1000 die niedrigste Priorität und 1000 die höchste Priorität sind. Der Standardwert ist 0.

priority?: number

Eigenschaftswert

number

state

Der aktuelle Status des Auftrags.

state: BatchJobState

Eigenschaftswert

BatchJobState

stateTransitionTime

Die Zeit, zu der der Auftrag seinen aktuellen Zustand eingegeben hat.

stateTransitionTime: Date

Eigenschaftswert

Date

taskFailureMode

Die Aktion, die der Batchdienst ausführen soll, wenn eine Aufgabe im Auftrag fehlschlägt. Eine Aufgabe wird als fehlgeschlagen betrachtet, wenn eine failureInfo vorhanden ist. Eine failureInfo wird festgelegt, wenn der Vorgang mit einem Nicht-Null-Beendigungscode abgeschlossen wird, nachdem die Wiederholungsanzahl aufgebraucht wurde, oder wenn ein Fehler beim Starten des Vorgangs aufgetreten ist, z. B. aufgrund eines Fehlers beim Herunterladen einer Ressourcendatei. Der Standardwert ist keine Aktion.

taskFailureMode?: BatchTaskFailureMode

Eigenschaftswert

BatchTaskFailureMode

url

Die URL des Auftrags.

url: string

Eigenschaftswert

string

usesTaskDependencies

Gibt an, ob Aufgaben im Auftrag Abhängigkeiten voneinander definieren können. Die Standardeinstellung ist „false“.

usesTaskDependencies?: boolean

Eigenschaftswert

boolean