BatchJobUpdateOptions interface

Paket:

@azure-rest/batch

Parameter für die Aktualisierung eines Azure-Batchauftrags.

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.
constraints	Die Ausführungseinschränkungen für den Auftrag. Ohne Angabe bleiben die vorhandenen Ausführungseinschränkungen unverändert.
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. Ohne Angabe bleiben die vorhandenen Auftragsmetadaten unverändert.
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 sich alle Aufgaben im Auftrag im Abgeschlossenen Zustand befinden. Wenn nicht angegeben, bleibt das Vervollständigungsverhalten unverändert. Sie können den Wert nicht von "terminatejob" in "noaction" ändern – d. h., nachdem Sie die automatische Beendigung des Auftrags aktiviert haben, können Sie ihn nicht wieder deaktivieren. Wenn Sie versuchen, dies zu tun, schlägt die Anforderung mit der Fehlerantwort "Ungültiger Eigenschaftswert" fehl. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung). Mögliche Werte: "noaction", "terminatejob"
poolInfo	Der Pool, in dem der Batchdienst die Aufgaben des Auftrags ausführt. Sie können den Pool für einen Auftrag nur ändern, wenn der Auftrag deaktiviert ist. Der Patchauftragsaufruf schlägt fehl, wenn Sie das poolInfo-Element einschließen und der Auftrag nicht deaktiviert ist. Wenn Sie eine autoPoolSpecification in der poolInfo angeben, kann nur die keepAlive-Eigenschaft der autoPoolSpecification aktualisiert werden, und dann nur, wenn die autoPoolSpecification über eine poolLifetimeOption of Job verfügt (andere Auftragseigenschaften können normal aktualisiert werden). Wenn dieser Wert nicht angegeben wird, wird der Auftrag weiterhin auf dem aktuellen Pool ausgefü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. Wenn sie weggelassen wird, bleibt die Priorität des Auftrags unverändert.

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

constraints

Die Ausführungseinschränkungen für den Auftrag. Ohne Angabe bleiben die vorhandenen Ausführungseinschränkungen unverändert.

constraints?: BatchJobConstraints

Eigenschaftswert

BatchJobConstraints

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. Ohne Angabe bleiben die vorhandenen Auftragsmetadaten unverändert.

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

onAllTasksComplete

Die Aktion, die der Batchdienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Abgeschlossenen Zustand befinden. Wenn nicht angegeben, bleibt das Vervollständigungsverhalten unverändert. Sie können den Wert nicht von "terminatejob" in "noaction" ändern – d. h., nachdem Sie die automatische Beendigung des Auftrags aktiviert haben, können Sie ihn nicht wieder deaktivieren. Wenn Sie versuchen, dies zu tun, schlägt die Anforderung mit der Fehlerantwort "Ungültiger Eigenschaftswert" fehl. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).

Mögliche Werte: "noaction", "terminatejob"

onAllTasksComplete?: string

Eigenschaftswert

string

poolInfo

Der Pool, in dem der Batchdienst die Aufgaben des Auftrags ausführt. Sie können den Pool für einen Auftrag nur ändern, wenn der Auftrag deaktiviert ist. Der Patchauftragsaufruf schlägt fehl, wenn Sie das poolInfo-Element einschließen und der Auftrag nicht deaktiviert ist. Wenn Sie eine autoPoolSpecification in der poolInfo angeben, kann nur die keepAlive-Eigenschaft der autoPoolSpecification aktualisiert werden, und dann nur, wenn die autoPoolSpecification über eine poolLifetimeOption of Job verfügt (andere Auftragseigenschaften können normal aktualisiert werden). Wenn dieser Wert nicht angegeben wird, wird der Auftrag weiterhin auf dem aktuellen Pool ausgeführt.

poolInfo?: BatchPoolInfo

Eigenschaftswert

BatchPoolInfo

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. Wenn sie weggelassen wird, bleibt die Priorität des Auftrags unverändert.

priority?: number

Eigenschaftswert

number