JobAddParameter interface

Paket:

@azure/batch

Eine Schnittstelle, die JobAddParameter darstellt.

Eigenschaften

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.
displayName	Der Anzeigename für den Auftrag. Der Anzeigename muss nicht eindeutig sein und kann alle Unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten.
id	Eine Zeichenfolge, die den Auftrag innerhalb des Kontos eindeutig identifiziert. Die ID kann eine beliebige Kombination aus alphanumerischen Zeichen einschließlich Bindestrichen und Unterstrichen enthalten und darf nicht mehr als 64 Zeichen enthalten. 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. Wenn der Auftrag keine Auftrags-Manager-Aufgabe angibt, muss der Benutzer dem Auftrag explizit Aufgaben hinzufügen. Wenn der Auftrag eine Auftrags-Manager-Aufgabe angibt, erstellt der Batchdienst die Auftrags-Manager-Aufgabe, wenn der Auftrag erstellt wird, und versucht, die Auftrags-Manager-Aufgabe vor der Planung anderer Aufgaben im Auftrag zu planen. Der typische Zweck der Aufgabe des Auftrags-Managers besteht darin, die Ausführung des Auftrags zu steuern und/oder zu überwachen, z. B. indem sie entscheiden, welche zusätzlichen Aufgaben ausgeführt werden sollen, bestimmen, wann die Arbeit abgeschlossen ist usw. (Eine Auftrags-Manager-Aufgabe ist jedoch nicht auf diese Aktivitäten beschränkt - es handelt sich um einen vollständigen Vorgang im System und ausführen, welche Aktionen für den Auftrag erforderlich sind.) Beispielsweise kann eine Auftrags-Manager-Aufgabe eine datei herunterladen, die als Parameter angegeben ist, den Inhalt dieser Datei analysieren und zusätzliche Aufgaben basierend auf diesen Inhalten übermitteln.
jobPreparationTask	Der Vorgang zur Auftragsvorbereitung. Wenn ein Auftrag über einen Auftragsvorbereitungsvorgang verfügt, führt der Batchdienst den Auftragvorbereitungsvorgang auf einem Knoten aus, bevor er Aufgaben dieses Auftrags auf diesem Computeknoten startet.
jobReleaseTask	Die Aufgabe "Auftragsfreigabe". Eine Auftragsfreigabeaufgabe kann nicht angegeben werden, ohne auch einen Auftragsvorbereitungsvorgang für den Auftrag anzugeben. Der Batchdienst führt die Aufgabe "Auftragsfreigabe" auf den Knoten aus, die den Auftragsvorbereitungsvorgang ausgeführt haben. Der Hauptzweck der Aufgabe "Auftragsfreigabe" besteht darin, Änderungen an Computeknoten rückgängig zu machen, die von der Auftragsvorbereitungsaufgabe vorgenommen wurden. Beispielaktivitäten umfassen das Löschen lokaler Dateien oder das Herunterfahren von Diensten, die als Teil der Auftragsvorbereitung gestartet wurden.
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	Die Netzwerkkonfiguration für den Auftrag.
onAllTasksComplete	Die Aktion, die der Batchdienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Abgeschlossenen Zustand befinden. Beachten Sie, dass alle Vorgänge als erledigt betrachtet werden, wenn ein Auftrag keine Aufgaben enthält. Diese Option wird daher am häufigsten mit einer Job Manager-Aufgabe verwendet; Wenn Sie die automatische Beendigung des Auftrags ohne Job Manager verwenden möchten, sollten Sie zunächst "onAllTasksComplete" auf "noaction" festlegen und die Auftragseigenschaften so aktualisieren, dass "onAllTasksComplete" auf "terminatejob" festgelegt wird, nachdem Sie das Hinzufügen von Aufgaben abgeschlossen haben. Der Standardwert ist keine Aktion. Mögliche Werte sind: 'noAction', 'terminateJob'
onTaskFailure	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. Mögliche Werte sind: 'noAction', 'performExitOptionsJobAction'
poolInfo	Der Pool, in dem der Batchdienst die Aufgaben des Auftrags ausführt.
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.
usesTaskDependencies	Gibt an, ob Aufgaben im Auftrag Abhängigkeiten voneinander definieren können. Der Standardwert ist "false".

Details zur Eigenschaft

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

Eigenschaftswert

JobConstraints

displayName

Der Anzeigename für den Auftrag. Der Anzeigename muss nicht eindeutig sein und kann alle Unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten.

displayName?: string

Eigenschaftswert

string

id

Eine Zeichenfolge, die den Auftrag innerhalb des Kontos eindeutig identifiziert. Die ID kann eine beliebige Kombination aus alphanumerischen Zeichen einschließlich Bindestrichen und Unterstrichen enthalten und darf nicht mehr als 64 Zeichen enthalten. 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. Wenn der Auftrag keine Auftrags-Manager-Aufgabe angibt, muss der Benutzer dem Auftrag explizit Aufgaben hinzufügen. Wenn der Auftrag eine Auftrags-Manager-Aufgabe angibt, erstellt der Batchdienst die Auftrags-Manager-Aufgabe, wenn der Auftrag erstellt wird, und versucht, die Auftrags-Manager-Aufgabe vor der Planung anderer Aufgaben im Auftrag zu planen. Der typische Zweck der Aufgabe des Auftrags-Managers besteht darin, die Ausführung des Auftrags zu steuern und/oder zu überwachen, z. B. indem sie entscheiden, welche zusätzlichen Aufgaben ausgeführt werden sollen, bestimmen, wann die Arbeit abgeschlossen ist usw. (Eine Auftrags-Manager-Aufgabe ist jedoch nicht auf diese Aktivitäten beschränkt - es handelt sich um einen vollständigen Vorgang im System und ausführen, welche Aktionen für den Auftrag erforderlich sind.) Beispielsweise kann eine Auftrags-Manager-Aufgabe eine datei herunterladen, die als Parameter angegeben ist, den Inhalt dieser Datei analysieren und zusätzliche Aufgaben basierend auf diesen Inhalten übermitteln.

jobManagerTask?: JobManagerTask

Eigenschaftswert

JobManagerTask

jobPreparationTask

Der Vorgang zur Auftragsvorbereitung. Wenn ein Auftrag über einen Auftragsvorbereitungsvorgang verfügt, führt der Batchdienst den Auftragvorbereitungsvorgang auf einem Knoten aus, bevor er Aufgaben dieses Auftrags auf diesem Computeknoten startet.

jobPreparationTask?: JobPreparationTask

Eigenschaftswert

JobPreparationTask

jobReleaseTask

Die Aufgabe "Auftragsfreigabe". Eine Auftragsfreigabeaufgabe kann nicht angegeben werden, ohne auch einen Auftragsvorbereitungsvorgang für den Auftrag anzugeben. Der Batchdienst führt die Aufgabe "Auftragsfreigabe" auf den Knoten aus, die den Auftragsvorbereitungsvorgang ausgeführt haben. Der Hauptzweck der Aufgabe "Auftragsfreigabe" besteht darin, Änderungen an Computeknoten rückgängig zu machen, die von der Auftragsvorbereitungsaufgabe vorgenommen wurden. Beispielaktivitäten umfassen das Löschen lokaler Dateien oder das Herunterfahren von Diensten, die als Teil der Auftragsvorbereitung gestartet wurden.

jobReleaseTask?: JobReleaseTask

Eigenschaftswert

JobReleaseTask

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

Eigenschaftswert

MetadataItem[]

networkConfiguration

Die Netzwerkkonfiguration für den Auftrag.

networkConfiguration?: JobNetworkConfiguration

Eigenschaftswert

JobNetworkConfiguration

onAllTasksComplete

Die Aktion, die der Batchdienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Abgeschlossenen Zustand befinden. Beachten Sie, dass alle Vorgänge als erledigt betrachtet werden, wenn ein Auftrag keine Aufgaben enthält. Diese Option wird daher am häufigsten mit einer Job Manager-Aufgabe verwendet; Wenn Sie die automatische Beendigung des Auftrags ohne Job Manager verwenden möchten, sollten Sie zunächst "onAllTasksComplete" auf "noaction" festlegen und die Auftragseigenschaften so aktualisieren, dass "onAllTasksComplete" auf "terminatejob" festgelegt wird, nachdem Sie das Hinzufügen von Aufgaben abgeschlossen haben. Der Standardwert ist keine Aktion. Mögliche Werte sind: 'noAction', 'terminateJob'

onAllTasksComplete?: OnAllTasksComplete

Eigenschaftswert

OnAllTasksComplete

onTaskFailure

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. Mögliche Werte sind: 'noAction', 'performExitOptionsJobAction'

onTaskFailure?: OnTaskFailure

Eigenschaftswert

OnTaskFailure

poolInfo

Der Pool, in dem der Batchdienst die Aufgaben des Auftrags ausführt.

poolInfo: PoolInformation

Eigenschaftswert

PoolInformation

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

usesTaskDependencies

Gibt an, ob Aufgaben im Auftrag Abhängigkeiten voneinander definieren können. Der Standardwert ist "false".

usesTaskDependencies?: boolean

Eigenschaftswert

boolean