BatchTaskCreateOptions interface
Parameter zum Erstellen einer Azure Batch Task.
Eigenschaften
| affinity |
Ein Lokalitätshinweis, den der Batch-Service nutzen kann, um einen Compute-Knoten auszuwählen, auf dem die neue Aufgabe gestartet wird. |
| application |
Eine Liste von Paketen, die der Batch-Service vor dem Ausführen der Kommandozeile an den Compute Node ausliefert. Anwendungspakete werden heruntergeladen und in einem gemeinsamen Verzeichnis bereitgestellt, nicht im Arbeitsverzeichnis Task. Daher wird ein referenziertes Paket, das bereits auf dem Node ist und aktuell ist, nicht erneut heruntergeladen; die vorhandene Kopie auf dem Compute-Node wird verwendet. Wenn ein referenziertes Paket nicht installiert werden kann, zum Beispiel weil das Paket gelöscht wurde oder der Download fehlgeschlagen ist, schlägt die Aufgabe fehl. |
| command |
Die Befehlszeile der Aufgabe. Bei Multi-Instanz-Aufgaben wird die Befehlszeile als primäre Aufgabe ausgeführt, nachdem die Hauptaufgabe und alle Unteraufgaben die Koordinationskommandozeile ausgeführt haben. Die Befehlszeile wird nicht unter einer Shell ausgeführt und kann daher nicht von Shellfeatures wie der Erweiterung der Umgebungsvariablen profitieren. Wenn du solche Funktionen nutzen möchtest, solltest du die Shell in der Befehlszeile aufrufen, zum Beispiel mit "cmd /c MyCommand" in Windows oder "/bin/sh -c MyCommand" unter 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ührungsbeschränkungen, die für diese Aufgabe gelten. Wenn Sie keine Einschränkungen spezifizieren, ist maxTaskRetryCount der maxTaskRetryCount für den Job, maxWallClockTime ist unendlich und die retentionTime beträgt 7 Tage. |
| container |
Die Einstellungen für den Container, unter dem die Aufgabe ausgeführt wird. Wenn der Pool, der diese Aufgabe ausführen wird, containerConfiguration gesetzt hat, muss dies ebenfalls gesetzt werden. Wenn der Pool, der diese Aufgabe ausführen soll, keine containerConfiguration gesetzt hat, darf dies nicht gesetzt werden. Wenn dies angegeben ist, werden alle Verzeichnisse rekursiv unterhalb der AZ_BATCH_NODE_ROOT_DIR (der Wurzel Azure Batch Verzeichnisse auf dem Knoten) in den Container abgebildet, alle Task-Umgebungsvariablen werden in den Container abgebildet und die Task-Befehlszeile wird im Container ausgeführt. Dateien, die außerhalb AZ_BATCH_NODE_ROOT_DIR im Container erzeugt werden, werden möglicherweise nicht auf die Host-Festplatte zurückgewiesen, was bedeutet, dass Batch-Datei-APIs nicht auf diese Dateien zugreifen können. |
| depends |
Die Aufgaben, von denen diese Aufgabe abhängt. Diese Aufgabe wird erst eingeplant, wenn alle Aufgaben, von denen sie abhängt, erfolgreich abgeschlossen sind. Wenn eine dieser Aufgaben scheitert und ihre Wiederholungszahlen erschöpft sind, wird diese Aufgabe niemals geplant. Wenn der Job usesTaskDependencies nicht auf true gesetzt hat und dieses Element vorhanden ist, schlägt die Anfrage mit dem Fehlercode TaskDependenciesNotSpecificifiedOnJob fehl. |
| display |
Ein Anzeigename für die Aufgabe. Der Anzeigename muss nicht eindeutig sein und kann alle Unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten. |
| environment |
Eine Liste der Umgebungsvariablen-Einstellungen für die Aufgabe. |
| exit |
Wie der Batch-Service reagieren sollte, wenn die Aufgabe abgeschlossen ist. |
| id | Eine Zeichenkette, 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. Die ID ist case-keeping und case-unsensitiv (das heißt, du hast nicht zwei IDs innerhalb eines Jobs, die sich nur je nach Fall unterscheiden). |
| multi |
Ein Objekt, das anzeigt, dass die Aufgabe eine Multi-Instanz-Aufgabe ist, und enthält Informationen darüber, wie die Multi-Instanz-Aufgabe ausgeführt werden soll. |
| output |
Eine Liste von Dateien, die der Batch-Service nach Ausführung der Kommandozeile vom Compute Node hochlädt. Bei Mehrinstanz-Aufgaben werden die Dateien nur vom Rechenknoten hochgeladen, auf dem die Hauptaufgabe ausgeführt wird. |
| required |
Die Anzahl der Planungsplätze, die die Aufgabe benötigte, um ausgeführt zu werden. Die Standardeinstellung ist 1. Eine Aufgabe kann nur dann auf einem Rechenknoten ausgeführt werden, wenn dieser genügend freie Planungsplätze zur Verfügung hat. Für Aufgaben mit mehreren Instanzen muss dies 1 sein. |
| resource |
Eine Liste der Dateien, die der Batchdienst vor dem Ausführen der Befehlszeile auf den Computeknoten herunterladen wird. Für Aufgaben mit mehreren Instanzen werden die Ressourcendateien nur auf den Rechenknoten heruntergeladen, auf dem die Hauptaufgabe 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. |
| user |
Die Benutzeridentität, unter der die Aufgabe ausgeführt wird. Wenn sie weggelassen wird, läuft die Aufgabe als nicht-administrativer Benutzer, der einzigartig für die Aufgabe ist. |
Details zur Eigenschaft
affinityInfo
Ein Lokalitätshinweis, den der Batch-Service nutzen kann, um einen Compute-Knoten auszuwählen, auf dem die neue Aufgabe gestartet wird.
affinityInfo?: BatchAffinityInfo
Eigenschaftswert
applicationPackageReferences
Eine Liste von Paketen, die der Batch-Service vor dem Ausführen der Kommandozeile an den Compute Node ausliefert. Anwendungspakete werden heruntergeladen und in einem gemeinsamen Verzeichnis bereitgestellt, nicht im Arbeitsverzeichnis Task. Daher wird ein referenziertes Paket, das bereits auf dem Node ist und aktuell ist, nicht erneut heruntergeladen; die vorhandene Kopie auf dem Compute-Node wird verwendet. Wenn ein referenziertes Paket nicht installiert werden kann, zum Beispiel weil das Paket gelöscht wurde oder der Download fehlgeschlagen ist, schlägt die Aufgabe fehl.
applicationPackageReferences?: BatchApplicationPackageReference[]
Eigenschaftswert
commandLine
Die Befehlszeile der Aufgabe. Bei Multi-Instanz-Aufgaben wird die Befehlszeile als primäre Aufgabe ausgeführt, nachdem die Hauptaufgabe und alle Unteraufgaben die Koordinationskommandozeile ausgeführt haben. Die Befehlszeile wird nicht unter einer Shell ausgeführt und kann daher nicht von Shellfeatures wie der Erweiterung der Umgebungsvariablen profitieren. Wenn du solche Funktionen nutzen möchtest, solltest du die Shell in der Befehlszeile aufrufen, zum Beispiel mit "cmd /c MyCommand" in Windows oder "/bin/sh -c MyCommand" unter 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ührungsbeschränkungen, die für diese Aufgabe gelten. Wenn Sie keine Einschränkungen spezifizieren, ist maxTaskRetryCount der maxTaskRetryCount für den Job, maxWallClockTime ist unendlich und die retentionTime beträgt 7 Tage.
constraints?: BatchTaskConstraints
Eigenschaftswert
containerSettings
Die Einstellungen für den Container, unter dem die Aufgabe ausgeführt wird. Wenn der Pool, der diese Aufgabe ausführen wird, containerConfiguration gesetzt hat, muss dies ebenfalls gesetzt werden. Wenn der Pool, der diese Aufgabe ausführen soll, keine containerConfiguration gesetzt hat, darf dies nicht gesetzt werden. Wenn dies angegeben ist, werden alle Verzeichnisse rekursiv unterhalb der AZ_BATCH_NODE_ROOT_DIR (der Wurzel Azure Batch Verzeichnisse auf dem Knoten) in den Container abgebildet, alle Task-Umgebungsvariablen werden in den Container abgebildet und die Task-Befehlszeile wird im Container ausgeführt. Dateien, die außerhalb AZ_BATCH_NODE_ROOT_DIR im Container erzeugt werden, werden möglicherweise nicht auf die Host-Festplatte zurückgewiesen, was bedeutet, dass Batch-Datei-APIs nicht auf diese Dateien zugreifen können.
containerSettings?: BatchTaskContainerSettings
Eigenschaftswert
dependsOn
Die Aufgaben, von denen diese Aufgabe abhängt. Diese Aufgabe wird erst eingeplant, wenn alle Aufgaben, von denen sie abhängt, erfolgreich abgeschlossen sind. Wenn eine dieser Aufgaben scheitert und ihre Wiederholungszahlen erschöpft sind, wird diese Aufgabe niemals geplant. Wenn der Job usesTaskDependencies nicht auf true gesetzt hat und dieses Element vorhanden ist, schlägt die Anfrage mit dem Fehlercode TaskDependenciesNotSpecificifiedOnJob fehl.
dependsOn?: BatchTaskDependencies
Eigenschaftswert
displayName
Ein Anzeigename für die Aufgabe. 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 Umgebungsvariablen-Einstellungen für die Aufgabe.
environmentSettings?: EnvironmentSetting[]
Eigenschaftswert
exitConditions
Wie der Batch-Service reagieren sollte, wenn die Aufgabe abgeschlossen ist.
exitConditions?: ExitConditions
Eigenschaftswert
id
Eine Zeichenkette, 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. Die ID ist case-keeping und case-unsensitiv (das heißt, du hast nicht zwei IDs innerhalb eines Jobs, die sich nur je nach Fall unterscheiden).
id: string
Eigenschaftswert
string
multiInstanceSettings
Ein Objekt, das anzeigt, dass die Aufgabe eine Multi-Instanz-Aufgabe ist, und enthält Informationen darüber, wie die Multi-Instanz-Aufgabe ausgeführt werden soll.
multiInstanceSettings?: MultiInstanceSettings
Eigenschaftswert
outputFiles
Eine Liste von Dateien, die der Batch-Service nach Ausführung der Kommandozeile vom Compute Node hochlädt. Bei Mehrinstanz-Aufgaben werden die Dateien nur vom Rechenknoten hochgeladen, auf dem die Hauptaufgabe ausgeführt wird.
outputFiles?: OutputFile[]
Eigenschaftswert
requiredSlots
Die Anzahl der Planungsplätze, die die Aufgabe benötigte, um ausgeführt zu werden. Die Standardeinstellung ist 1. Eine Aufgabe kann nur dann auf einem Rechenknoten ausgeführt werden, wenn dieser genügend freie Planungsplätze zur Verfügung hat. Für 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. Für Aufgaben mit mehreren Instanzen werden die Ressourcendateien nur auf den Rechenknoten heruntergeladen, auf dem die Hauptaufgabe 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?: ResourceFile[]
Eigenschaftswert
userIdentity
Die Benutzeridentität, unter der die Aufgabe ausgeführt wird. Wenn sie weggelassen wird, läuft die Aufgabe als nicht-administrativer Benutzer, der einzigartig für die Aufgabe ist.
userIdentity?: UserIdentity