BatchJobSpecificationOutput interface

Paket:

@azure-rest/batch

Gibt Details zu den Aufträgen an, die in einem Zeitplan erstellt werden sollen.

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.
commonEnvironmentSettings	Eine Liste der allgemeinen Umgebungsvariableneinstellungen. Diese Umgebungsvariablen werden für alle Aufgaben in Aufträgen festgelegt, die unter diesem Zeitplan erstellt wurden (einschließlich des Auftrags-Managers, der Auftragsvorbereitung und der Auftragsfreigabeaufgaben). 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 Aufträge, die unter diesem Zeitplan erstellt wurden.
displayName	Der Anzeigename für Aufträge, die unter diesem Zeitplan erstellt wurden. Der Name muss nicht eindeutig sein und kann bis zu einer maximalen Länge von 1024 Unicode-Zeichen enthalten.
jobManagerTask	Die Details einer Job Manager-Aufgabe, die gestartet werden soll, wenn ein Auftrag unter diesem Zeitplan gestartet wird. Wenn der Auftrag keine Auftrags-Manager-Aufgabe angibt, muss der Benutzer mithilfe der Aufgaben-API explizit Aufgaben zum Auftrag 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.
jobPreparationTask	Der Unter diesem Zeitplan erstellte Auftragsvorbereitungsvorgang für Aufträge. 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 Auftragsfreigabeaufgabe für Aufträge, die unter diesem Zeitplan erstellt wurden. Der Hauptzweck der Aufgabe "Auftragsfreigabe" besteht darin, Änderungen an Knoten 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. Eine Auftragsfreigabeaufgabe kann nicht angegeben werden, ohne auch einen Auftragsvorbereitungsvorgang für den Auftrag anzugeben. Der Batchdienst führt die Auftragsfreigabeaufgabe auf den Computeknoten aus, die die Auftragsvorbereitungsaufgabe ausgeführt haben.
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 mit Namen-Wert-Paaren, die jedem Auftrag zugeordnet sind, der unter diesem Zeitplan als Metadaten erstellt wurde. 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.
onAllTasksComplete	Die Aktion, die der Batchdienst ausführen soll, wenn alle Aufgaben in einem unter diesem Zeitplan erstellten Auftrag im Status "Abgeschlossen" sind. 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: "noaction", "terminatejob"
onTaskFailure	Die Aktion, die der Batchdienst ausführen soll, wenn ein Vorgang in einem Auftrag fehlschlägt, der unter diesem Zeitplan erstellt wurde. Eine Aufgabe wird als fehlgeschlagen angesehen, wenn sie fehlgeschlagen ist, wenn ein Fehlerinfo 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: "noaction", "performexitoptionsjobaction"
poolInfo	Der Pool, in dem der Batchdienst die Aufgaben von Aufträgen ausführt, die unter diesem Zeitplan erstellt wurden.
priority	Die Priorität von Aufträgen, die unter diesem Zeitplan erstellt wurden. 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. Diese Priorität wird als Standard für alle Aufträge unter dem Auftragsplan verwendet. Sie können die Priorität eines Auftrags aktualisieren, nachdem er mithilfe der Updateauftrags-API erstellt wurde.
usesTaskDependencies	Gibt an, ob Aufgaben im Auftrag Abhängigkeiten voneinander definieren können. Der Standardwert 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

commonEnvironmentSettings

Eine Liste der allgemeinen Umgebungsvariableneinstellungen. Diese Umgebungsvariablen werden für alle Aufgaben in Aufträgen festgelegt, die unter diesem Zeitplan erstellt wurden (einschließlich des Auftrags-Managers, der Auftragsvorbereitung und der Auftragsfreigabeaufgaben). Einzelne Aufgaben können eine hier angegebene Umgebungseinstellung außer Kraft setzen, indem sie denselben Einstellungsnamen mit einem anderen Wert angeben.

commonEnvironmentSettings?: EnvironmentSettingOutput[]

Eigenschaftswert

EnvironmentSettingOutput[]

constraints

Die Ausführungseinschränkungen für Aufträge, die unter diesem Zeitplan erstellt wurden.

constraints?: BatchJobConstraintsOutput

Eigenschaftswert

BatchJobConstraintsOutput

displayName

Der Anzeigename für Aufträge, die unter diesem Zeitplan erstellt wurden. Der Name muss nicht eindeutig sein und kann bis zu einer maximalen Länge von 1024 Unicode-Zeichen enthalten.

displayName?: string

Eigenschaftswert

string

jobManagerTask

Die Details einer Job Manager-Aufgabe, die gestartet werden soll, wenn ein Auftrag unter diesem Zeitplan gestartet wird. Wenn der Auftrag keine Auftrags-Manager-Aufgabe angibt, muss der Benutzer mithilfe der Aufgaben-API explizit Aufgaben zum Auftrag 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.

jobManagerTask?: BatchJobManagerTaskOutput

Eigenschaftswert

BatchJobManagerTaskOutput

jobPreparationTask

Der Unter diesem Zeitplan erstellte Auftragsvorbereitungsvorgang für Aufträge. 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?: BatchJobPreparationTaskOutput

Eigenschaftswert

BatchJobPreparationTaskOutput

jobReleaseTask

Die Auftragsfreigabeaufgabe für Aufträge, die unter diesem Zeitplan erstellt wurden. Der Hauptzweck der Aufgabe "Auftragsfreigabe" besteht darin, Änderungen an Knoten 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. Eine Auftragsfreigabeaufgabe kann nicht angegeben werden, ohne auch einen Auftragsvorbereitungsvorgang für den Auftrag anzugeben. Der Batchdienst führt die Auftragsfreigabeaufgabe auf den Computeknoten aus, die die Auftragsvorbereitungsaufgabe ausgeführt haben.

jobReleaseTask?: BatchJobReleaseTaskOutput

Eigenschaftswert

BatchJobReleaseTaskOutput

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 mit Namen-Wert-Paaren, die jedem Auftrag zugeordnet sind, der unter diesem Zeitplan als Metadaten erstellt wurde. Der Batchdienst weist Metadaten keine Bedeutung zu; sie ist ausschließlich für die Verwendung von Benutzercode vorgesehen.

metadata?: BatchMetadataItemOutput[]

Eigenschaftswert

BatchMetadataItemOutput[]

networkConfiguration

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

networkConfiguration?: BatchJobNetworkConfigurationOutput

Eigenschaftswert

BatchJobNetworkConfigurationOutput

onAllTasksComplete

Die Aktion, die der Batchdienst ausführen soll, wenn alle Aufgaben in einem unter diesem Zeitplan erstellten Auftrag im Status "Abgeschlossen" sind. 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: "noaction", "terminatejob"

onAllTasksComplete?: string

Eigenschaftswert

string

onTaskFailure

Die Aktion, die der Batchdienst ausführen soll, wenn ein Vorgang in einem Auftrag fehlschlägt, der unter diesem Zeitplan erstellt wurde. Eine Aufgabe wird als fehlgeschlagen angesehen, wenn sie fehlgeschlagen ist, wenn ein Fehlerinfo 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: "noaction", "performexitoptionsjobaction"

onTaskFailure?: string

Eigenschaftswert

string

poolInfo

Der Pool, in dem der Batchdienst die Aufgaben von Aufträgen ausführt, die unter diesem Zeitplan erstellt wurden.

poolInfo: BatchPoolInfoOutput

Eigenschaftswert

BatchPoolInfoOutput

priority

Die Priorität von Aufträgen, die unter diesem Zeitplan erstellt wurden. 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. Diese Priorität wird als Standard für alle Aufträge unter dem Auftragsplan verwendet. Sie können die Priorität eines Auftrags aktualisieren, nachdem er mithilfe der Updateauftrags-API erstellt wurde.

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