BatchTaskOutput interface

Paket:

@azure-rest/batch

Batch wiederholt Aufgaben, wenn ein Wiederherstellungsvorgang auf einem Knoten ausgelöst wird. Beispiele für Wiederherstellungsvorgänge sind (aber nicht beschränkt darauf), wenn ein fehlerhafter Knoten neu gestartet wird oder ein Computeknoten aufgrund eines Hostfehlers verschwunden ist. Wiederholungen aufgrund von Wiederherstellungsvorgängen sind unabhängig von und werden nicht für das maxTaskRetryCount gezählt. Auch wenn das maxTaskRetryCount 0 ist, kann ein interner Wiederholungsversuch aufgrund eines Wiederherstellungsvorgangs auftreten. Aus diesem Gründen sollten alle Aufgaben idempotent sein. Dies bedeutet, dass Aufgaben unterbrochen und neu gestartet werden müssen, ohne dass Beschädigte oder doppelte Daten verursacht werden. Die bewährte Methode für lange ausgeführte Aufgaben besteht darin, eine Form der Prüfpunkterstellung zu verwenden.

Eigenschaften

affinityInfo	Ein Gebietsschemahinweis, der vom Batchdienst verwendet werden kann, um einen Computeknoten auszuwählen, auf dem die neue Aufgabe gestartet werden soll.
applicationPackageReferences	Eine Liste der Pakete, die der Batchdienst vor dem Ausführen der Befehlszeile auf dem Computeknoten bereitstellen wird. Anwendungspakete werden heruntergeladen und in ein freigegebenes Verzeichnis bereitgestellt, nicht das Arbeitsverzeichnis "Aufgabe". Wenn sich daher ein referenziertes Paket bereits im Knoten befindet und auf dem neuesten Stand ist, wird es nicht erneut heruntergeladen. die vorhandene Kopie auf dem Computeknoten verwendet wird. Wenn ein referenziertes Paket nicht installiert werden kann, z. B. weil das Paket gelöscht wurde oder weil der Download fehlgeschlagen ist, schlägt die Aufgabe fehl.
authenticationTokenSettings	Die Einstellungen für ein Authentifizierungstoken, das von der Aufgabe zum Ausführen von Batchdienstvorgängen verwendet werden kann. Wenn diese Eigenschaft festgelegt ist, stellt der Batchdienst die Aufgabe mit einem Authentifizierungstoken bereit, das zum Authentifizieren von Batchdienstvorgängen verwendet werden kann, ohne dass ein Kontozugriffsschlüssel erforderlich ist. Das Token wird über die AZ_BATCH_AUTHENTICATION_TOKEN Umgebungsvariable bereitgestellt. Die Vorgänge, die die Aufgabe mit dem Token ausführen kann, sind von den Einstellungen abhängig. Beispielsweise kann eine Aufgabe Auftragsberechtigungen anfordern, um dem Auftrag weitere Aufgaben hinzuzufügen, oder den Status des Auftrags oder anderer Aufgaben unter dem Auftrag zu überprüfen.
commandLine	Die Befehlszeile der Aufgabe. Bei Aufgaben mit mehreren Instanzen wird die Befehlszeile als primäre Aufgabe ausgeführt, nachdem die primäre Aufgabe und alle Teilvorgänge die Ausführung der Koordinations-Befehlszeile abgeschlossen haben. Die Befehlszeile wird nicht unter einer Shell ausgeführt und kann daher nicht von Shellfeatures wie der Erweiterung der Umgebungsvariablen profitieren. Wenn Sie diese Features nutzen möchten, sollten Sie die Shell in der Befehlszeile aufrufen, z. B. mit "cmd /c MyCommand" in Windows oder "/bin/sh -c MyCommand" in Linux. Wenn sich die Befehlszeile auf Dateipfade bezieht, sollte sie einen relativen Pfad (relativ zum Arbeitsverzeichnis "Aufgabe") verwenden oder die vom Batch bereitgestellte Umgebungsvariable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables) verwenden.
constraints	Die Ausführungseinschränkungen, die für diesen Vorgang gelten.
containerSettings	Die Einstellungen für den Container, unter dem die Aufgabe ausgeführt wird. Wenn der Pool, der diese Aufgabe ausführt, containerConfiguration festgelegt ist, muss dies ebenfalls festgelegt werden. Wenn der Pool, der diese Aufgabe ausführt, keinen containerConfiguration-Satz aufweist, darf dies nicht festgelegt werden. Wenn dies angegeben wird, werden alle Verzeichnisse rekursiv unterhalb der AZ_BATCH_NODE_ROOT_DIR (der Stamm von Azure Batchverzeichnissen auf dem Knoten) dem Container zugeordnet, alle Taskumgebungsvariablen werden dem Container zugeordnet, und die Task-Befehlszeile wird im Container ausgeführt. Dateien, die im Container außerhalb von AZ_BATCH_NODE_ROOT_DIR erstellt wurden, werden möglicherweise nicht auf den Hostdatenträger wiedergegeben, was bedeutet, dass Batchdatei-APIs nicht auf diese Dateien zugreifen können.
creationTime	Die Erstellungszeit des Vorgangs.
dependsOn	Die Vorgänge, von denen dieser Vorgang abhängt. Dieser Vorgang wird erst geplant, wenn alle Vorgänge, von denen er abhängt, erfolgreich abgeschlossen wurden. Wenn eine dieser Vorgänge fehlschlägt und die Wiederholungsanzahl ausschöpfen kann, wird dieser Vorgang nie geplant.
displayName	Ein Anzeigename für den Vorgang. Der Anzeigename muss nicht eindeutig sein und kann alle Unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten.
environmentSettings	Eine Liste der Umgebungsvariableneinstellungen für die Aufgabe.
eTag	Das ETag des Vorgangs. Dies ist eine undurchsichtige Zeichenfolge. Sie können es verwenden, um zu erkennen, ob sich die Aufgabe zwischen Anforderungen geändert hat. Insbesondere können Sie das ETag beim Aktualisieren einer Aufgabe übergeben, um anzugeben, dass Ihre Änderungen nur wirksam werden sollen, wenn in der Zwischenzeit keine andere Person die Aufgabe geändert hat.
executionInfo	Informationen zur Ausführung der Aufgabe.
exitConditions	Wie der Batchdienst reagieren soll, wenn die Aufgabe abgeschlossen ist.
id	Eine Zeichenfolge, die die Aufgabe innerhalb des Auftrags 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.
lastModified	Der Zeitpunkt der letzten Änderung des Vorgangs.
multiInstanceSettings	Ein Objekt, das angibt, dass die Aufgabe eine aufgabe mit mehreren Instanzen ist, und enthält Informationen zum Ausführen der Aufgabe mit mehreren Instanzen.
nodeInfo	Informationen zum Computeknoten, auf dem die Aufgabe ausgeführt wurde.
outputFiles	Eine Liste der Dateien, die der Batchdienst nach dem Ausführen der Befehlszeile vom Computeknoten hochladen wird. Bei Aufgaben mit mehreren Instanzen werden die Dateien nur aus dem Computeknoten hochgeladen, auf dem die primäre Aufgabe ausgeführt wird.
previousState	Der vorherige Status des Vorgangs. Diese Eigenschaft wird nicht festgelegt, wenn sich der Vorgang im anfangs aktiven Zustand befindet. Mögliche Werte: "active", "preparing", "running", "completed"
previousStateTransitionTime	Die Uhrzeit, zu der der Vorgang seinen vorherigen Zustand eingegeben hat. Diese Eigenschaft wird nicht festgelegt, wenn sich der Vorgang im anfangs aktiven Zustand befindet.
requiredSlots	Die Anzahl der Zeitplanungsplätze, die der Vorgang ausführen muss. Der Standardwert ist 1. Eine Aufgabe kann nur für die Ausführung auf einem Computeknoten geplant werden, wenn der Knoten über genügend freie Planungsplätze verfügt. Bei Aufgaben mit mehreren Instanzen muss dies 1 sein.
resourceFiles	Eine Liste der Dateien, die der Batchdienst vor dem Ausführen der Befehlszeile auf den Computeknoten herunterladen wird. Bei Vorgängen mit mehreren Instanzen werden die Ressourcendateien nur auf den Computeknoten heruntergeladen, auf dem der primäre Vorgang ausgeführt wird. Es gibt eine maximale Größe für die Liste der Ressourcendateien. Wenn die maximale Größe überschritten wird, schlägt die Anforderung fehl, und der Antwortfehlercode lautet "RequestEntityTooLarge". Wenn dies der Fall ist, muss die Sammlung von ResourceFiles in der Größe reduziert werden. Dies kann mithilfe von .zip Dateien, Anwendungspaketen oder Docker-Containern erreicht werden.
state	Der aktuelle Status des Vorgangs. Mögliche Werte: "active", "preparing", "running", "completed"
stateTransitionTime	Die Uhrzeit, zu der der Vorgang seinen aktuellen Zustand eingegeben hat.
stats	Ressourcennutzungsstatistiken für den Vorgang.
url	Die URL der Aufgabe.
userIdentity	Die Benutzeridentität, unter der die Aufgabe ausgeführt wird. Wenn dies nicht angegeben wird, wird die Aufgabe als nicht administrativer Benutzer ausgeführt, der für die Aufgabe eindeutig ist.

Details zur Eigenschaft

affinityInfo

Ein Gebietsschemahinweis, der vom Batchdienst verwendet werden kann, um einen Computeknoten auszuwählen, auf dem die neue Aufgabe gestartet werden soll.

affinityInfo?: BatchAffinityInfoOutput

Eigenschaftswert

BatchAffinityInfoOutput

applicationPackageReferences

Eine Liste der Pakete, die der Batchdienst vor dem Ausführen der Befehlszeile auf dem Computeknoten bereitstellen wird. Anwendungspakete werden heruntergeladen und in ein freigegebenes Verzeichnis bereitgestellt, nicht das Arbeitsverzeichnis "Aufgabe". Wenn sich daher ein referenziertes Paket bereits im Knoten befindet und auf dem neuesten Stand ist, wird es nicht erneut heruntergeladen. die vorhandene Kopie auf dem Computeknoten verwendet wird. Wenn ein referenziertes Paket nicht installiert werden kann, z. B. weil das Paket gelöscht wurde oder weil der Download fehlgeschlagen ist, schlägt die Aufgabe fehl.

applicationPackageReferences?: BatchApplicationPackageReferenceOutput[]

Eigenschaftswert

BatchApplicationPackageReferenceOutput[]

authenticationTokenSettings

Die Einstellungen für ein Authentifizierungstoken, das von der Aufgabe zum Ausführen von Batchdienstvorgängen verwendet werden kann. Wenn diese Eigenschaft festgelegt ist, stellt der Batchdienst die Aufgabe mit einem Authentifizierungstoken bereit, das zum Authentifizieren von Batchdienstvorgängen verwendet werden kann, ohne dass ein Kontozugriffsschlüssel erforderlich ist. Das Token wird über die AZ_BATCH_AUTHENTICATION_TOKEN Umgebungsvariable bereitgestellt. Die Vorgänge, die die Aufgabe mit dem Token ausführen kann, sind von den Einstellungen abhängig. Beispielsweise kann eine Aufgabe Auftragsberechtigungen anfordern, um dem Auftrag weitere Aufgaben hinzuzufügen, oder den Status des Auftrags oder anderer Aufgaben unter dem Auftrag zu überprüfen.

authenticationTokenSettings?: AuthenticationTokenSettingsOutput

Eigenschaftswert

AuthenticationTokenSettingsOutput

commandLine

Die Befehlszeile der Aufgabe. Bei Aufgaben mit mehreren Instanzen wird die Befehlszeile als primäre Aufgabe ausgeführt, nachdem die primäre Aufgabe und alle Teilvorgänge die Ausführung der Koordinations-Befehlszeile abgeschlossen haben. Die Befehlszeile wird nicht unter einer Shell ausgeführt und kann daher nicht von Shellfeatures wie der Erweiterung der Umgebungsvariablen profitieren. Wenn Sie diese Features nutzen möchten, sollten Sie die Shell in der Befehlszeile aufrufen, z. B. mit "cmd /c MyCommand" in Windows oder "/bin/sh -c MyCommand" in Linux. Wenn sich die Befehlszeile auf Dateipfade bezieht, sollte sie einen relativen Pfad (relativ zum Arbeitsverzeichnis "Aufgabe") verwenden oder die vom Batch bereitgestellte Umgebungsvariable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables) verwenden.

commandLine: string

Eigenschaftswert

string

constraints

Die Ausführungseinschränkungen, die für diesen Vorgang gelten.

constraints?: BatchTaskConstraintsOutput

Eigenschaftswert

BatchTaskConstraintsOutput

containerSettings

Die Einstellungen für den Container, unter dem die Aufgabe ausgeführt wird. Wenn der Pool, der diese Aufgabe ausführt, containerConfiguration festgelegt ist, muss dies ebenfalls festgelegt werden. Wenn der Pool, der diese Aufgabe ausführt, keinen containerConfiguration-Satz aufweist, darf dies nicht festgelegt werden. Wenn dies angegeben wird, werden alle Verzeichnisse rekursiv unterhalb der AZ_BATCH_NODE_ROOT_DIR (der Stamm von Azure Batchverzeichnissen auf dem Knoten) dem Container zugeordnet, alle Taskumgebungsvariablen werden dem Container zugeordnet, und die Task-Befehlszeile wird im Container ausgeführt. Dateien, die im Container außerhalb von AZ_BATCH_NODE_ROOT_DIR erstellt wurden, werden möglicherweise nicht auf den Hostdatenträger wiedergegeben, was bedeutet, dass Batchdatei-APIs nicht auf diese Dateien zugreifen können.

containerSettings?: BatchTaskContainerSettingsOutput

Eigenschaftswert

BatchTaskContainerSettingsOutput

creationTime

Die Erstellungszeit des Vorgangs.

creationTime: string

Eigenschaftswert

string

dependsOn

Die Vorgänge, von denen dieser Vorgang abhängt. Dieser Vorgang wird erst geplant, wenn alle Vorgänge, von denen er abhängt, erfolgreich abgeschlossen wurden. Wenn eine dieser Vorgänge fehlschlägt und die Wiederholungsanzahl ausschöpfen kann, wird dieser Vorgang nie geplant.

dependsOn?: BatchTaskDependenciesOutput

Eigenschaftswert

BatchTaskDependenciesOutput

displayName

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

displayName?: string

Eigenschaftswert

string

environmentSettings

Eine Liste der Umgebungsvariableneinstellungen für die Aufgabe.

environmentSettings?: EnvironmentSettingOutput[]

Eigenschaftswert

EnvironmentSettingOutput[]

eTag

Das ETag des Vorgangs. Dies ist eine undurchsichtige Zeichenfolge. Sie können es verwenden, um zu erkennen, ob sich die Aufgabe zwischen Anforderungen geändert hat. Insbesondere können Sie das ETag beim Aktualisieren einer Aufgabe übergeben, um anzugeben, dass Ihre Änderungen nur wirksam werden sollen, wenn in der Zwischenzeit keine andere Person die Aufgabe geändert hat.

eTag: string

Eigenschaftswert

string

executionInfo

Informationen zur Ausführung der Aufgabe.

executionInfo?: BatchTaskExecutionInfoOutput

Eigenschaftswert

BatchTaskExecutionInfoOutput

exitConditions

Wie der Batchdienst reagieren soll, wenn die Aufgabe abgeschlossen ist.

exitConditions?: ExitConditionsOutput

Eigenschaftswert

ExitConditionsOutput

id

Eine Zeichenfolge, die die Aufgabe innerhalb des Auftrags 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.

id: string

Eigenschaftswert

string

lastModified

Der Zeitpunkt der letzten Änderung des Vorgangs.

lastModified: string

Eigenschaftswert

string

multiInstanceSettings

Ein Objekt, das angibt, dass die Aufgabe eine aufgabe mit mehreren Instanzen ist, und enthält Informationen zum Ausführen der Aufgabe mit mehreren Instanzen.

multiInstanceSettings?: MultiInstanceSettingsOutput

Eigenschaftswert

MultiInstanceSettingsOutput

nodeInfo

Informationen zum Computeknoten, auf dem die Aufgabe ausgeführt wurde.

nodeInfo?: BatchNodeInfoOutput

Eigenschaftswert

BatchNodeInfoOutput

outputFiles

Eine Liste der Dateien, die der Batchdienst nach dem Ausführen der Befehlszeile vom Computeknoten hochladen wird. Bei Aufgaben mit mehreren Instanzen werden die Dateien nur aus dem Computeknoten hochgeladen, auf dem die primäre Aufgabe ausgeführt wird.

outputFiles?: OutputFileOutput[]

Eigenschaftswert

OutputFileOutput[]

previousState

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

Mögliche Werte: "active", "preparing", "running", "completed"

previousState?: string

Eigenschaftswert

string

previousStateTransitionTime

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

previousStateTransitionTime?: string

Eigenschaftswert

string

requiredSlots

Die Anzahl der Zeitplanungsplätze, die der Vorgang ausführen muss. Der Standardwert ist 1. Eine Aufgabe kann nur für die Ausführung auf einem Computeknoten geplant werden, wenn der Knoten über genügend freie Planungsplätze verfügt. Bei Aufgaben mit mehreren Instanzen muss dies 1 sein.

requiredSlots?: number

Eigenschaftswert

number

resourceFiles

Eine Liste der Dateien, die der Batchdienst vor dem Ausführen der Befehlszeile auf den Computeknoten herunterladen wird. Bei Vorgängen mit mehreren Instanzen werden die Ressourcendateien nur auf den Computeknoten heruntergeladen, auf dem der primäre Vorgang ausgeführt wird. Es gibt eine maximale Größe für die Liste der Ressourcendateien. Wenn die maximale Größe überschritten wird, schlägt die Anforderung fehl, und der Antwortfehlercode lautet "RequestEntityTooLarge". Wenn dies der Fall ist, muss die Sammlung von ResourceFiles in der Größe reduziert werden. Dies kann mithilfe von .zip Dateien, Anwendungspaketen oder Docker-Containern erreicht werden.

resourceFiles?: ResourceFileOutput[]

Eigenschaftswert

ResourceFileOutput[]

state

Der aktuelle Status des Vorgangs.

Mögliche Werte: "active", "preparing", "running", "completed"

state: string

Eigenschaftswert

string

stateTransitionTime

Die Uhrzeit, zu der der Vorgang seinen aktuellen Zustand eingegeben hat.

stateTransitionTime: string

Eigenschaftswert

string

stats

Ressourcennutzungsstatistiken für den Vorgang.

stats?: BatchTaskStatisticsOutput

Eigenschaftswert

BatchTaskStatisticsOutput

url

Die URL der Aufgabe.

url: string

Eigenschaftswert

string

userIdentity

Die Benutzeridentität, unter der die Aufgabe ausgeführt wird. Wenn dies nicht angegeben wird, wird die Aufgabe als nicht administrativer Benutzer ausgeführt, der für die Aufgabe eindeutig ist.

userIdentity?: UserIdentityOutput

Eigenschaftswert

UserIdentityOutput