Tasks - Get Task
Erhält Informationen über die angegebene Aufgabe.
Für Multi-Instanz-Aufgaben beziehen sich Informationen wie affinityId, executionInfo und nodeInfo auf die primäre Aufgabe. Verwenden Sie die Liste der Unteraufgaben-API, um Informationen über Unteraufgaben abzurufen.
GET {endpoint}/jobs/{jobId}/tasks/{taskId}?api-version=2025-06-01
GET {endpoint}/jobs/{jobId}/tasks/{taskId}?api-version=2025-06-01&timeOut={timeOut}&$select={$select}&$expand={$expand}
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Batchkontoendpunkt (z. B. https://batchaccount.eastus2.batch.azure.com). |
|
job
|
path | True |
string |
Die ID des Jobs, der die Aufgabe enthält. |
|
task
|
path | True |
string |
Die ID der Aufgabe, um Informationen zu erhalten. |
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
|
$expand
|
query |
string[] |
Eine OData-$expand-Klausel. |
|
|
$select
|
query |
string[] |
Eine OData-$select-Klausel. |
|
|
time
|
query |
integer (int32) |
Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Ist der Wert größer als 30, wird stattdessen der Standard verwendet." |
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| client-request-id |
string |
Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
| return-client-request-id |
boolean |
Gibt an, ob der Server die Clientanforderungs-ID in der Antwort zurückgeben soll. |
|
| ocp-date |
string (date-time-rfc7231) |
Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen. |
|
| If-Modified-Since |
string (date-time-rfc7231) |
Ein Zeitstempel, der die uhrzeit der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource für den Dienst seit dem angegebenen Zeitpunkt geändert wurde. |
|
| If-Unmodified-Since |
string (date-time-rfc7231) |
Ein Zeitstempel, der die uhrzeit der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource für den Dienst seit dem angegebenen Zeitpunkt nicht geändert wurde. |
|
| If-Match |
string |
Ein ETag-Wert, der der Version der Ressource zugeordnet ist, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn das aktuelle ETag der Ressource für den Dienst exakt mit dem vom Client angegebenen Wert übereinstimmt. |
|
| If-None-Match |
string |
Ein ETag-Wert, der der Version der Ressource zugeordnet ist, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn das aktuelle ETag der Ressource für den Dienst nicht mit dem vom Client angegebenen Wert übereinstimmt. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Die Anforderung ist erfolgreich. Header
|
|
| Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
OAuth2Auth
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| https://batch.core.windows.net//.default |
Beispiele
Task get
Beispielanforderung
GET {endpoint}/jobs/jobId/tasks/taskId?api-version=2025-06-01
Beispiel für eine Antwort
{
"id": "testTask",
"url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId",
"eTag": "0x8D3D62350711C55",
"creationTime": "2025-09-06T06:59:15.1161429Z",
"lastModified": "2025-09-06T06:59:15.1161429Z",
"state": "active",
"stateTransitionTime": "2025-09-06T06:59:15.1161429Z",
"commandLine": "cmd /c hostname",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"multiInstanceSettings": {
"numberOfInstances": 3,
"coordinationCommandLine": "cmd /c echo coordinating"
},
"constraints": {
"maxWallClockTime": "P10675199DT2H48M5.4775807S",
"retentionTime": "P10675199DT2H48M5.4775807S",
"maxTaskRetryCount": 0
},
"requiredSlots": 2,
"executionInfo": {
"retryCount": 0,
"requeueCount": 0
}
}
Definitionen
| Name | Beschreibung |
|---|---|
|
Authentication |
Die Einstellungen für ein Authentifizierungstoken, das von der Aufgabe zum Ausführen von Batchdienstvorgängen verwendet werden kann. |
|
Auto |
AutoUserScope-Enums |
|
Auto |
Gibt die Optionen für den automatischen Benutzer an, der eine Azure-Batchaufgabe ausführt. |
|
Batch |
BatchAccessScope-Enume |
|
Batch |
Ein Gebietsschemahinweis, der vom Batchdienst verwendet werden kann, um einen Computeknoten auszuwählen, auf dem eine Aufgabe gestartet werden soll. |
|
Batch |
Ein Verweis auf ein Paket, das auf Computeknoten bereitgestellt werden soll. |
|
Batch |
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort. |
|
Batch |
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind. |
|
Batch |
Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde. |
|
Batch |
BatchErrorSourceCategory-Enume |
|
Batch |
BatchJobAction-Enums |
|
Batch |
Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet. |
|
Batch |
Informationen zum Computeknoten, auf dem eine Aufgabe ausgeführt wurde. |
|
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. |
|
Batch |
Ausführungseinschränkungen, die auf einen Vorgang angewendet werden sollen. |
|
Batch |
Enthält Informationen zum Container, den eine Aufgabe ausführt. |
|
Batch |
Die Containereinstellungen für eine Aufgabe. |
|
Batch |
Gibt alle Abhängigkeiten eines Vorgangs an. Alle Vorgänge, die explizit oder innerhalb eines Abhängigkeitsbereichs angegeben sind, müssen abgeschlossen werden, bevor der abhängige Vorgang geplant wird. |
|
Batch |
Informationen zur Ausführung einer Aufgabe. |
|
Batch |
BatchTaskExecutionResult-Enume |
|
Batch |
Informationen zu einem Vorgangsfehler. |
|
Batch |
Der Anfang und das Ende des Bereichs sind inklusive. Wenn z. B. ein Bereich den Anfang 9 und das Ende 12 hat, stellt er Vorgänge "9", "10", "11" und "12" dar. |
|
Batch |
BatchTaskState-Enums |
|
Batch |
Ressourcennutzungsstatistiken für einen Vorgang. |
|
Container |
Der Eintrag des Pfad- und Bereitstellungsmodus, den Sie in Aufgabencontainer bereitstellen möchten. |
|
Container |
Die Pfade, die im Container der Containeraufgabe bereitgestellt werden. |
|
Container |
Eine private Containerregistrierung. |
|
Container |
ContainerWorkingDirectory-Enums |
|
Dependency |
DependencyAction-Enums |
|
Elevation |
ElevationLevel-Enums |
|
Environment |
Eine Umgebungsvariable, die für einen Vorgangsprozess festgelegt werden soll. |
|
Exit |
Wie der Batchdienst reagieren soll, wenn eine Aufgabe mit einem bestimmten Beendigungscode beendet wird. |
|
Exit |
Eine Reihe von Beendigungscodes und wie der Batchdienst auf Beendigungscodes innerhalb dieses Bereichs reagieren soll. |
|
Exit |
Gibt an, wie der Batchdienst reagieren soll, wenn die Aufgabe abgeschlossen ist. |
|
Exit |
Gibt an, wie der Batchdienst auf eine bestimmte Beendigungsbedingung reagiert. |
|
Multi |
Aufgaben mit mehreren Instanzen werden häufig zur Unterstützung von MPI-Aufgaben verwendet. Wenn eines der Teilvorgänge fehlschlägt (z. B. aufgrund des Beendens mit einem Nicht-Null-Ausgangscode), schlägt im MPI-Fall der gesamte Vorgang mit mehreren Instanzen fehl. Der Vorgang mit mehreren Instanzen wird dann bis zum Wiederholungsgrenzwert beendet und erneut versucht. |
|
Name |
Stellt ein Name-Wert-Paar dar. |
|
Output |
Bei allen Dateiuploads schreibt der Batchdienst zwei Protokolldateien in den Computeknoten "fileuploadout.txt" und "fileuploaderr.txt". Diese Protokolldateien werden verwendet, um mehr über einen bestimmten Fehler zu erfahren. |
|
Output |
Gibt ein Dateiuploadziel in einem Azure Blob Storage-Container an. |
|
Output |
Das Ziel, in das eine Datei hochgeladen werden soll. |
|
Output |
OutputFileUploadCondition-Enume |
|
Output |
Optionen für einen Uploadvorgang einer Ausgabedatei, einschließlich der Bedingungen, unter denen der Upload ausgeführt werden soll. |
|
Output |
Ein HTTP-Headernamen-Wert-Paar |
|
Resource |
Eine einzelne Datei oder mehrere Dateien, die in einen Computeknoten heruntergeladen werden sollen. |
|
User |
Die Definition der Benutzeridentität, unter der die Aufgabe ausgeführt wird. Geben Sie entweder die Eigenschaft "userName" oder "autoUser" an, aber nicht beide. |
AuthenticationTokenSettings
Die Einstellungen für ein Authentifizierungstoken, das von der Aufgabe zum Ausführen von Batchdienstvorgängen verwendet werden kann.
| Name | Typ | Beschreibung |
|---|---|---|
| access |
Die Batch-Ressourcen, auf die der Token Zugriff gewährt. Der Authentifizierungstoken gewährt Zugriff auf eine begrenzte Anzahl von Batch-Service-Operationen. Derzeit ist der einzige unterstützte Wert für die Zugriffseigenschaft 'Job', der Zugriff auf alle Operationen gewährt, die mit dem Job zusammenhängen, der die Aufgabe enthält. |
AutoUserScope
AutoUserScope-Enums
| Wert | Beschreibung |
|---|---|
| task |
Spezifiziert, dass der Dienst einen neuen Benutzer für die Aufgabe anlegen soll. |
| pool |
Spezifiziert, dass die Aufgabe als gemeinsames automatisches Benutzerkonto ausgeführt wird, das auf jedem Rechenknoten in einem Pool erstellt wird. |
AutoUserSpecification
Gibt die Optionen für den automatischen Benutzer an, der eine Azure-Batchaufgabe ausführt.
| Name | Typ | Beschreibung |
|---|---|---|
| elevationLevel |
Die Höhenstufe des automatischen Benutzers. Der Standardwert ist "nonAdmin". |
|
| scope |
Der Bereich für den automatischen Benutzer. Der Standardwert ist Pool. Wenn der Pool Windows ausführt, sollte ein Wert der Aufgabe angegeben werden, wenn eine strengere Isolierung zwischen Vorgängen erforderlich ist. Dies ist beispielsweise der Fall, wenn die Aufgabe die Registrierung in einer Weise ändert, die sich auf andere Aufgaben auswirken kann. |
BatchAccessScope
BatchAccessScope-Enume
| Wert | Beschreibung |
|---|---|
| job |
Gewährt Zugriff auf alle Operationen auf der Aufgabe, die die Aufgabe enthält. |
BatchAffinityInfo
Ein Gebietsschemahinweis, der vom Batchdienst verwendet werden kann, um einen Computeknoten auszuwählen, auf dem eine Aufgabe gestartet werden soll.
| Name | Typ | Beschreibung |
|---|---|---|
| affinityId |
string |
Eine undurchsichtige Zeichenkette, die den Standort eines Rechenknotens oder einer Aufgabe darstellt, die zuvor ausgeführt wurde. Man kann die affinityId eines Knotens weitergeben, um anzuzeigen, dass diese Aufgabe auf diesem Rechenknoten ausgeführt werden muss. Beachten Sie, dass dies nur eine weiche Affinität ist. Wenn der Ziel-Computeknoten zum Zeitpunkt der Planung des Vorgangs ausgelastet oder nicht verfügbar ist, wird der Vorgang an anderer Stelle geplant. |
BatchApplicationPackageReference
Ein Verweis auf ein Paket, das auf Computeknoten bereitgestellt werden soll.
| Name | Typ | Beschreibung |
|---|---|---|
| applicationId |
string |
Die ID der zu implementierenden Anwendung. Beim Erstellen eines Pools muss die Anwendungs-ID des Pakets vollqualifizierte sein (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). |
| version |
string |
Die Version der bereitzustellenden Anwendung. Wenn sie weggelassen wird, wird die Standardversion bereitgestellt. Wenn dies in einem Pool weggelassen wird und für diese Anwendung keine Standardversion angegeben ist, schlägt die Anfrage mit dem Fehlercode InvalidApplicationPackageReferences und dem HTTP-Statuscode 409 fehl. Wenn dies bei einer Aufgabe weggelassen wird und für diese Anwendung keine Standardversion angegeben ist, scheitert die Aufgabe mit einem Vorverarbeitungsfehler. |
BatchError
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
| Name | Typ | Beschreibung |
|---|---|---|
| code |
string |
Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden. |
| message |
Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist. |
|
| values |
Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten. |
BatchErrorDetail
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.
| Name | Typ | Beschreibung |
|---|---|---|
| key |
string |
Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt. |
| value |
string |
Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind. |
BatchErrorMessage
Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| lang |
string |
Der Sprachcode der Fehlermeldung. |
| value |
string |
Der Text der Nachricht. |
BatchErrorSourceCategory
BatchErrorSourceCategory-Enume
| Wert | Beschreibung |
|---|---|
| usererror |
Der Fehler liegt an einem Benutzerproblem, wie etwa einer Fehlkonfiguration. |
| servererror |
Der Fehler liegt an einem internen Serverproblem. |
BatchJobActionKind
BatchJobAction-Enums
| Wert | Beschreibung |
|---|---|
| none |
Ergreifen Sie keine Aktion. |
| disable |
Deaktiviere den Job. Dies entspricht dem Aufruf der disable Job API mit dem DisableTasks-Wert requeue. |
| terminate |
Beenden Sie den Auftrag. Der TerminationReason in der Job-Ausführungsinfo ist auf "TaskFailed" gesetzt. |
BatchNodeIdentityReference
Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.
| Name | Typ | Beschreibung |
|---|---|---|
| resourceId |
string (arm-id) |
Die ARM-Ressourcen-ID der vom Benutzer zugewiesenen Identität. |
BatchNodeInfo
Informationen zum Computeknoten, auf dem eine Aufgabe ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| affinityId |
string |
Eine Identifikatorin für den Knoten, auf dem die Aufgabe lief, die beim Hinzufügen einer Aufgabe weitergegeben werden kann, um zu verlangen, dass die Aufgabe auf diesem Rechenknoten geplant wird. |
| nodeId |
string |
Die ID des Rechenknotens, auf dem die Aufgabe lief. |
| nodeUrl |
string (uri) |
Die URL des Compute-Knotens, auf dem die Aufgabe lief. |
| poolId |
string |
Die ID des Pools, auf dem die Aufgabe lief. |
| taskRootDirectory |
string |
Das Wurzelverzeichnis der Aufgabe auf dem Compute-Knoten. |
| taskRootDirectoryUrl |
string (uri) |
Die URL zum Root-Verzeichnis der Task auf dem Compute Node. |
BatchTask
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.
| Name | Typ | Beschreibung |
|---|---|---|
| affinityInfo |
Ein Lokalitätshinweis, den der Batch-Service nutzen kann, um einen Compute-Knoten auszuwählen, auf dem die neue Aufgabe gestartet wird. |
|
| 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. |
|
| authenticationTokenSettings |
Die Einstellungen für ein Authentifizierungstoken, das von der Aufgabe zum Ausführen von Batchdienstvorgängen verwendet werden kann. Wenn diese Eigenschaft gesetzt ist, stellt der Batch-Service der Aufgabe ein Authentifizierungstoken zur Verfügung, das zur Authentifizierung von Batch-Service-Operationen ohne Konto-Zugriffsschlüssel verwendet werden kann. Das Token wird über die AZ_BATCH_AUTHENTICATION_TOKEN Umgebungsvariable bereitgestellt. Die Operationen, die die Aufgabe mit dem Token ausführen kann, hängen von den Einstellungen ab. Zum Beispiel kann eine Aufgabe Job-Berechtigungen anfordern, um weitere Aufgaben zum Job hinzuzufügen oder den Status des Jobs oder anderer Aufgaben unter dem Job überprüfen. |
|
| commandLine |
string |
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 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://v4.hkg1.meaqua.org/azure/batch/batch-compute-node-environment-variables) verwenden. |
| constraints |
Die Ausführungsbeschränkungen, die für diese Aufgabe gelten. |
|
| 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 der 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. |
|
| creationTime |
string (date-time) |
Die Entstehungszeit der Aufgabe. |
| 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. |
|
| displayName |
string |
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. |
| eTag |
string |
Der ETag der Aufgabe. Dies ist eine undurchsichtige Zeichenfolge. Sie können damit erkennen, ob sich die Aufgabe zwischen den Anfragen geändert hat. Insbesondere kann man beim Aktualisieren einer Aufgabe das ETag übergeben, um festzulegen, dass die Änderungen nur dann in Kraft treten sollen, wenn in der Zwischenzeit niemand sonst die Aufgabe geändert hat. |
| environmentSettings |
Eine Liste der Umgebungsvariablen-Einstellungen für die Aufgabe. |
|
| executionInfo |
Informationen über die Ausführung der Aufgabe. |
|
| exitConditions |
Wie der Batch-Service reagieren sollte, wenn die Aufgabe abgeschlossen ist. |
|
| id |
string |
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. |
| lastModified |
string (date-time) |
Die letzte modifizierte Zeit der Aufgabe. |
| 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. |
|
| nodeInfo |
Informationen über den Rechenknoten, auf dem die Aufgabe lief. |
|
| 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. |
|
| previousState |
Der vorherige Zustand der Aufgabe. Diese Eigenschaft ist nicht gesetzt, wenn sich die Aufgabe im Anfangszustand der Aktivität befindet. |
|
| previousStateTransitionTime |
string (date-time) |
Der Zeitpunkt, zu dem die Aufgabe in ihren vorherigen Zustand eintrat. Diese Eigenschaft ist nicht gesetzt, wenn sich die Aufgabe im Anfangszustand der Aktivität befindet. |
| requiredSlots |
integer (int32) |
Die Anzahl der Planungsplätze, die die Aufgabe benötigt, um ausgeführt zu werden. Der Standardwert 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. |
| 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. |
|
| state |
Der aktuelle Stand der Aufgabe. |
|
| stateTransitionTime |
string (date-time) |
Der Zeitpunkt, zu dem die Aufgabe in ihren heutigen Zustand eintrat. |
| stats |
Ressourcenverbrauchsstatistiken für die Aufgabe. |
|
| url |
string (uri) |
Die URL der Aufgabe. |
| 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. |
BatchTaskConstraints
Ausführungseinschränkungen, die auf einen Vorgang angewendet werden sollen.
| Name | Typ | Beschreibung |
|---|---|---|
| maxTaskRetryCount |
integer (int32) |
Die maximale Anzahl der Wiederholungsversuche des Vorgangs. Der Batchdienst ruft eine Aufgabe erneut auf, wenn der Beendigungscode nicht null ist. Beachten Sie, dass dieser Wert speziell die Anzahl der Versuche für die ausführbare Task-Datei aufgrund eines von null verschiedenen Exit-Codes steuert. Der Batchdienst versucht die Aufgabe einmal, und kann dann bis zu diesem Grenzwert erneut versuchen. Wenn die maximale Wiederholungsanzahl beispielsweise 3 ist, versucht Batch die Aufgabe bis zu 4 Mal (ein erster Versuch und 3 Wiederholungsversuche). Wenn die maximale Anzahl der Wiederholungen 0 beträgt, versucht der Batch-Service die Aufgabe nach dem ersten Versuch nicht erneut. Wenn die maximale Wiederholungsanzahl -1 ist, wiederholt der Batchdienst den Vorgang ohne Beschränkung, dies wird jedoch nicht für einen Startvorgang oder einen Vorgang empfohlen. Der Standardwert ist 0 (keine Wiederholungen). |
| maxWallClockTime |
string (duration) |
Die maximal vergangene Zeit, die die Aufgabe laufen kann, gemessen ab dem Zeitpunkt des Beginns der Aufgabe. Wenn die Aufgabe nicht innerhalb des Zeitlimits abgeschlossen wird, beendet der Batch-Service sie. Wenn dies nicht angegeben ist, gibt es keine Zeitbegrenzung, wie lange die Aufgabe laufen darf. |
| retentionTime |
string (duration) |
Die Mindestzeit, um das Task-Verzeichnis auf dem Compute Node, in dem es lief, zu behalten, ab dem Zeitpunkt, an dem die Ausführung abgeschlossen ist. Nach dieser Zeit kann der Batch-Service das Task-Verzeichnis und alle Inhalte löschen. Standardmäßig sind 7 Tage, d. h. das Aufgabenverzeichnis wird 7 Tage lang aufbewahrt, es sei denn, der Compute-Knoten wird entfernt oder der Job gelöscht. |
BatchTaskContainerExecutionInfo
Enthält Informationen zum Container, den eine Aufgabe ausführt.
| Name | Typ | Beschreibung |
|---|---|---|
| containerId |
string |
ID des Containers. |
| error |
string |
Detaillierte Fehlerinformationen zum Container. Dies ist die detaillierte Fehlerfolge des Docker-Dienstes, falls verfügbar. Es entspricht dem Fehlerfeld, das von "docker inspect" zurückgegeben wird. |
| state |
string |
Der Zustand des Behälters. Dies ist der Zustand des Containers laut dem Docker-Service. Es entspricht dem Statusfeld, das von "docker inspect" zurückgegeben wird. |
BatchTaskContainerSettings
Die Containereinstellungen für eine Aufgabe.
| Name | Typ | Beschreibung |
|---|---|---|
| containerHostBatchBindMounts |
Die Pfade, die Sie an containeraufgaben bereitstellen möchten. Wenn dieses Array null ist oder nicht vorhanden ist, stellt die Containeraufgabe das gesamte temporäre Laufwerk in Windows (oder AZ_BATCH_NODE_ROOT_DIR in Linux) ein. Es werden keine Datenpfade in Container bereitgestellt, wenn dieses Array als leer festgelegt ist. |
|
| containerRunOptions |
string |
Zusätzliche Optionen für den Befehl "Container erstellen". Diese zusätzlichen Optionen werden zusätzlich zu den vom Batchdienst gesteuerten Befehlen als Argumente für den Befehl "docker create" bereitgestellt. |
| imageName |
string |
Das Image, das verwendet wird, um den Container zu erstellen, in dem die Aufgabe ausgeführt wird. Dies ist die vollständige Image-Referenz, wie sie bei "docker pull" angegeben wäre. Wenn kein Tag im Bildnamen angegeben ist, wird standardmäßig das Tag ":latest" verwendet. |
| registry |
Das private Register, das das Container-Image enthält. Diese Einstellung kann weggelassen werden, wenn sie bereits bei der Poolerstellung bereitgestellt wurde. |
|
| workingDirectory |
Der Standort des Arbeitsverzeichnisses Container Task. Der Standardwert ist "taskWorkingDirectory". |
BatchTaskDependencies
Gibt alle Abhängigkeiten eines Vorgangs an. Alle Vorgänge, die explizit oder innerhalb eines Abhängigkeitsbereichs angegeben sind, müssen abgeschlossen werden, bevor der abhängige Vorgang geplant wird.
| Name | Typ | Beschreibung |
|---|---|---|
| taskIdRanges |
Die Liste der Aufgaben-ID-Bereiche, auf denen diese Aufgabe basiert. Alle Aufgaben in allen Bereichen müssen erfolgreich abgeschlossen werden, bevor die abhängige Aufgabe geplant werden kann. |
|
| taskIds |
string[] |
Die Liste der Task-IDs, von denen diese Aufgabe abhängt. Alle Aufgaben in dieser Liste müssen erfolgreich abgeschlossen werden, bevor die abhängige Aufgabe geplant werden kann. Die taskIds-Sammlung ist auf insgesamt 64.000 Zeichen begrenzt (d. h. die kombinierte Länge aller Task-IDs). Wenn die TaskIds-Sammlung die maximale Länge überschreitet, scheitert die Aufgabe hinzufügen-Anfrage mit dem Fehlercode TaskDependencyListTooLong. In diesem Fall sollten Sie stattdessen Task-ID-Bereiche verwenden. |
BatchTaskExecutionInfo
Informationen zur Ausführung einer Aufgabe.
| Name | Typ | Beschreibung |
|---|---|---|
| containerInfo |
Informationen über den Container, unter dem die Aufgabe ausgeführt wird. Diese Eigenschaft wird nur gesetzt, wenn die Aufgabe in einem Containerkontext ausgeführt wird. |
|
| endTime |
string (date-time) |
Der Zeitpunkt, zu dem die Aufgabe abgeschlossen wurde. Diese Eigenschaft wird nur gesetzt, wenn sich die Aufgabe im Zustand "abgeschlossen" befindet. |
| exitCode |
integer (int32) |
Der Exit-Code des Programms ist in der Task-Befehlszeile angegeben. Diese Eigenschaft wird nur gesetzt, wenn sich die Aufgabe im abgeschlossenen Zustand befindet. Im Allgemeinen spiegelt der Ausgangscode eines Prozesses die spezifische Konvention wider, die vom Anwendungsentwickler für diesen Prozess implementiert wurde. Wenn Sie den Exit-Code-Wert verwenden, um Entscheidungen in Ihrem Code zu treffen, stellen Sie sicher, dass Sie die Exit-Code-Konvention kennen, die vom Anwendungsprozess verwendet wird. Wenn der Batch-Service jedoch die Aufgabe beendet (aufgrund von Timeout oder Benutzerbeendigung über die API), könnten Sie einen vom Betriebssystem definierten Exit-Code sehen. |
| failureInfo |
Informationen, die das Misserfolg der Aufgabe beschreiben, falls vorhanden. Diese Eigenschaft wird nur gesetzt, wenn sich die Aufgabe im abgeschlossenen Zustand befindet und auf einen Fehler stößt. |
|
| lastRequeueTime |
string (date-time) |
Der letzte Zeitpunkt, zu dem die Aufgabe vom Batch-Service infolge einer Benutzeranforderung wieder in die Warteschlange gestellt wurde. Diese Eigenschaft wird nur gesetzt, wenn die requeueCount nicht null ist. |
| lastRetryTime |
string (date-time) |
Das letzte Mal, als ein erneuter Versuch der Aufgabe begann. Dieses Element ist nur vorhanden, wenn die Aufgabe erneut versucht wurde (d. h. retryCount ist nicht null). Wenn vorhanden, ist dies typischerweise dasselbe wie startTime, kann aber anders sein, wenn die Aufgabe aus anderen Gründen als dem erneuten Versuch neu gestartet wurde; zum Beispiel, wenn der Compute-Knoten während eines erneuten Versuchs neu gestartet wurde, wird startTime aktualisiert, aber der lastRetryTime nicht. |
| requeueCount |
integer (int32) |
Die Anzahl der Male, in denen die Aufgabe vom Batch-Service infolge einer Benutzeranforderung erneut in die Warteschlange gestellt wurde. Wenn der Benutzer Compute-Knoten aus einem Pool entfernt (indem er den Pool verkleinert/verkleinert) oder wenn der Job deaktiviert wird, kann er festlegen, dass ausführende Aufgaben auf den Compute-Knoten zur Ausführung erneut in die Warteschlange gestellt werden. Diese Zählung zeigt, wie oft die Aufgabe aus diesen Gründen neu in die Warteschlange gestellt wurde. |
| result |
Das Ergebnis der Ausführung der Aufgabe. Wenn der Wert 'fehlgeschlagen' ist, können die Details des Scheiterns in der Eigenschaft failureInfo gefunden werden. |
|
| retryCount |
integer (int32) |
Die Anzahl der Male, in denen die Aufgabe vom Batch-Service erneut versucht wurde. Task-Anwendungsfehler (nicht-null-Exit-Code) werden erneut versucht, Vorverarbeitungsfehler (die Aufgabe konnte nicht ausgeführt werden) und Datei-Upload-Fehler werden nicht erneut versucht. Der Batch-Service versucht die Aufgabe bis zum durch die Einschränkungen festgelegten Limit erneut. |
| startTime |
string (date-time) |
Die Zeit, zu der die Aufgabe zu laufen begann. 'Laufend' entspricht dem laufenden Zustand, sodass wenn die Aufgabe Ressourcendateien oder Pakete angibt, die Startzeit den Zeitpunkt widerspiegelt, zu dem die Aufgabe mit dem Herunterladen oder Bereitstellen begonnen hat. Wenn die Aufgabe neu gestartet oder erneut versucht wurde, ist dies der letzte Zeitpunkt, in dem die Aufgabe ausgeführt wurde. Diese Eigenschaft ist nur für Aufgaben vorhanden, die sich im laufenden oder abgeschlossenen Zustand befinden. |
BatchTaskExecutionResult
BatchTaskExecutionResult-Enume
| Wert | Beschreibung |
|---|---|
| success |
Die Aufgabe wurde erfolgreich durchgeführt. |
| failure |
Es gab einen Fehler während der Bearbeitung der Aufgabe. Der Ausfall kann vor dem Start des Task-Prozesses, während der Task-Prozess ausgeführt wurde oder nachdem der Task-Prozess beendet war, aufgetreten sein. |
BatchTaskFailureInfo
Informationen zu einem Vorgangsfehler.
| Name | Typ | Beschreibung |
|---|---|---|
| category |
Die Kategorie des Aufgabenfehlers. |
|
| code |
string |
Ein Kennzeichen für den Task-Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden. |
| details |
Eine Liste zusätzlicher Details zu dem Fehler. |
|
| message |
string |
Eine Meldung, die den Aufgabenfehler beschreibt und für die Darstellung in einer Benutzeroberfläche geeignet sein soll. |
BatchTaskIdRange
Der Anfang und das Ende des Bereichs sind inklusive. Wenn z. B. ein Bereich den Anfang 9 und das Ende 12 hat, stellt er Vorgänge "9", "10", "11" und "12" dar.
| Name | Typ | Beschreibung |
|---|---|---|
| end |
integer (int32) |
Die letzte Task ID im Bereich. |
| start |
integer (int32) |
Die erste Task-ID im Bereich. |
BatchTaskState
BatchTaskState-Enums
| Wert | Beschreibung |
|---|---|
| active |
Die Aufgabe ist in der Warteschlange und kann ausgeführt werden, ist aber derzeit nicht einem Rechenknoten zugewiesen. Eine Aufgabe tritt in diesen Zustand ein, wenn sie erstellt wird, wenn sie nach der Deaktivierung aktiviert wird oder wenn sie nach einem fehlgeschlagenen Durchlauf auf einen erneuten Versuch wartet. |
| preparing |
Die Aufgabe wurde einem Rechenknoten zugewiesen, wartet jedoch auf die Abschluss einer erforderlichen Jobvorbereitungsaufgabe auf dem Rechenknoten. Wenn die Aufgabe zur Jobvorbereitung erfolgreich ist, wird die Aufgabe zum Laufen übergegangen. Wenn die Aufgabe zur Jobvorbereitung fehlschlägt, wird sie wieder aktiv und kann einem anderen Rechenknoten zugewiesen werden. |
| running |
Die Aufgabe läuft auf einem Compute-Knoten. Dazu gehört auch die Vorbereitung auf Aufgabenebene, wie das Herunterladen von Ressourcendateien oder das Bereitstellen von auf der Aufgabe angegebenen Paketen – das bedeutet nicht zwangsläufig, dass die Task-Befehlszeile bereits ausgeführt wurde. |
| completed |
Die Aufgabe ist nicht mehr ausführbar, meist weil die Aufgabe erfolgreich abgeschlossen wurde oder die Aufgabe erfolglos abgeschlossen wurde und ihr Wiederholungslimit aufgebraucht ist. Eine Aufgabe wird ebenfalls als abgeschlossen markiert, wenn beim Starten der Aufgabe ein Fehler aufgetreten ist oder wenn die Aufgabe beendet wurde. |
BatchTaskStatistics
Ressourcennutzungsstatistiken für einen Vorgang.
| Name | Typ | Beschreibung |
|---|---|---|
| kernelCPUTime |
string (duration) |
Die gesamte CPU-Zeit im Kernel-Modus (summiert über alle Kerne und alle Rechenknoten), die von der Aufgabe verbraucht wird. |
| lastUpdateTime |
string (date-time) |
Die Zeit, zu der die Statistiken zuletzt aktualisiert wurden. Alle Statistiken sind auf den Bereich zwischen startTime und lastUpdateTime beschränkt. |
| readIOGiB |
number (float) |
Die Gesamtzahl der Gibibytes, die von der Task von der Festplatte gelesen wird. |
| readIOps |
string (int64) |
Die Gesamtzahl der von der Aufgabe durchgeführten Festplattenleseoperationen. |
| startTime |
string (date-time) |
Die Startzeit des in den Statistiken abgedeckten Zeitspannes. |
| url |
string (uri) |
Die URL der Statistiken. |
| userCPUTime |
string (duration) |
Die gesamte CPU-Zeit im Benutzermodus (summiert über alle Kerne und alle Rechenknoten), die von der Aufgabe verbraucht wird. |
| waitTime |
string (duration) |
Die gesamte Wartezeit der Aufgabe. Die Wartezeit für eine Aufgabe ist definiert als die vergangene Zeit zwischen der Erstellung der Aufgabe und dem Beginn der Aufgabenausführung. (Wenn die Aufgabe aufgrund von Fehlern erneut versucht wird, ist die Wartezeit die Zeit bis zur letzten Ausführung der Aufgabe.) |
| wallClockTime |
string (duration) |
Die gesamte Wanduhrzeit der Aufgabe. Die Wanduhrzeit ist die vergangene Zeit von dem Zeitpunkt, an dem die Aufgabe auf einem Rechenknoten ausgeführt wurde, bis zu ihrem Ende (oder bis zum letzten Mal die Statistiken aktualisiert wurden, falls die Aufgabe bis dahin nicht abgeschlossen war). Wenn die Aufgabe erneut ausprobiert wurde, beinhaltet das die Wanduhrzeit aller Aufgaben-Wiederholungen. |
| writeIOGiB |
number (float) |
Die Gesamtzahl der Gibibytes, die von der Aufgabe auf die Festplatte geschrieben werden. |
| writeIOps |
string (int64) |
Die Gesamtzahl der von der Aufgabe durchgeführten Diskettenschreiboperationen. |
ContainerHostBatchBindMountEntry
Der Eintrag des Pfad- und Bereitstellungsmodus, den Sie in Aufgabencontainer bereitstellen möchten.
| Name | Typ | Beschreibung |
|---|---|---|
| isReadOnly |
boolean |
Stellen Sie diesen Quellpfad als schreibgeschützten Modus ein oder nicht. Der Standardwert ist false (Lese-/Schreibmodus). Wenn Sie diesen Pfad für Linux als Lese-/Schreibmodus bereitstellen, bedeutet dies nicht, dass alle Benutzer im Container über den Lese-/Schreibzugriff für den Pfad verfügen, hängt sie vom Zugriff auf die Host-VM ab. Wenn dieser Pfad schreibgeschützt bereitgestellt wird, können alle Benutzer im Container den Pfad nicht ändern. |
| source |
Der Pfad, der für containerkunden bereitgestellt werden kann. |
ContainerHostDataPath
Die Pfade, die im Container der Containeraufgabe bereitgestellt werden.
| Wert | Beschreibung |
|---|---|
| Shared |
Der Pfad für die Aufgabe mit mehreren Instanzen, um ihre Dateien freigegeben zu haben. |
| Startup |
Der Pfad für die Startaufgabe. |
| VfsMounts |
Der Pfad enthält alle virtuellen Dateisysteme, die auf diesem Knoten bereitgestellt werden. |
| Task |
Der Vorgangspfad. |
| JobPrep |
Der Auftragsvorstellungsvorgangspfad. |
| Applications |
Der Anwendungspfad. |
ContainerRegistryReference
Eine private Containerregistrierung.
| Name | Typ | Beschreibung |
|---|---|---|
| identityReference |
Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf eine Azure-Containerregistrierung anstelle von Benutzername und Kennwort verwendet werden soll. |
|
| password |
string (password) |
Das Kennwort für die Anmeldung beim Registrierungsserver. |
| registryServer |
string (uri) |
Die Registrierungs-URL Wenn nicht angegeben, lautet der Standardwert "docker.io". |
| username |
string |
Der Benutzername, der sich beim Registrierungsserver anmeldet. |
ContainerWorkingDirectory
ContainerWorkingDirectory-Enums
| Wert | Beschreibung |
|---|---|
| taskWorkingDirectory |
Verwenden Sie das Standard-Batch-Service-Arbeitsverzeichnis Task, das die Task Resource Dateien enthält, die von Batch gefüllt werden. |
| containerImageDefault |
Verwenden Sie das Arbeitsverzeichnis, das im Container-Image definiert ist. Beachten Sie, dass dieses Verzeichnis die durch Batch heruntergeladenen Ressourcendateien nicht enthält. |
DependencyAction
DependencyAction-Enums
| Wert | Beschreibung |
|---|---|
| satisfy |
Erfüllen Sie Aufgaben, die auf diese Aufgabe warten; Sobald alle Abhängigkeiten erfüllt sind, wird die Aufgabe zum Ausführen geplant. |
| block |
Blockiert Aufgaben, die auf diese Aufgabe warten, und verhindert, dass sie geplant werden. |
ElevationLevel
ElevationLevel-Enums
| Wert | Beschreibung |
|---|---|
| nonadmin |
Der Benutzer ist ein Standardbenutzer ohne erhöhten Zugriff. |
| admin |
Der Benutzer ist ein Benutzer mit erhöhtem Zugriff und arbeitet mit vollständigen Administratorberechtigungen. |
EnvironmentSetting
Eine Umgebungsvariable, die für einen Vorgangsprozess festgelegt werden soll.
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
Der Name der Umgebungsvariable. |
| value |
string |
Der Wert der Umgebungsvariable. |
ExitCodeMapping
Wie der Batchdienst reagieren soll, wenn eine Aufgabe mit einem bestimmten Beendigungscode beendet wird.
| Name | Typ | Beschreibung |
|---|---|---|
| code |
integer (int32) |
Ein Prozess-Exit-Code. |
| exitOptions |
Wie der Batch-Service reagieren sollte, wenn die Aufgabe mit diesem Exit-Code endet. |
ExitCodeRangeMapping
Eine Reihe von Beendigungscodes und wie der Batchdienst auf Beendigungscodes innerhalb dieses Bereichs reagieren soll.
| Name | Typ | Beschreibung |
|---|---|---|
| end |
integer (int32) |
Der letzte Ausgangscode im Bereich. |
| exitOptions |
Wie der Batch-Service reagieren sollte, wenn die Aufgabe mit einem Ausgangscode im Bereich von Anfang bis Ende (inklusiv) ausgeht. |
|
| start |
integer (int32) |
Der erste Ausgangscode im Bereich. |
ExitConditions
Gibt an, wie der Batchdienst reagieren soll, wenn die Aufgabe abgeschlossen ist.
| Name | Typ | Beschreibung |
|---|---|---|
| default |
Wie der Batch-Service reagieren sollte, wenn die Aufgabe mit einer Exit-Bedingung fehlschlägt, die von keiner der anderen Eigenschaften abgedeckt wird. Dieser Wert wird verwendet, wenn die Aufgabe mit einem von null verschiedenen Ausgangscode ausgeht, der nicht in der exitCode- oder exitCodeRanges-Sammlung aufgeführt ist, mit einem Vorverarbeitungsfehler, wenn die preProcessingError-Eigenschaft nicht vorhanden ist, oder mit einem Datei-Upload-Fehler, wenn die fileUploadError-Eigenschaft nicht vorhanden ist. Wenn du ein nicht-standardmäßiges Verhalten am Exitcode 0 möchtest, musst du es explizit mit der Collection exitCodes oder exitCodeRanges angeben. |
|
| exitCodeRanges |
Eine Liste der Task-Exitcode-Bereiche und wie der Batch-Service darauf reagieren sollte. |
|
| exitCodes |
Eine Liste der einzelnen Task-Exit-Codes und wie der Batch-Service darauf reagieren sollte. |
|
| fileUploadError |
Wie der Batch-Dienst reagieren sollte, wenn ein Datei-Upload-Fehler auftritt. Wenn die Aufgabe mit einem über exitCodes oder exitCodeRanges angegebenen Exit-Code beendet wurde und dann auf einen Datei-Upload-Fehler stößt, hat die vom Exit-Code angegebene Aktion Vorrang. |
|
| preProcessingError |
Wie der Batch-Service reagieren sollte, wenn die Aufgabe aufgrund eines Fehlers nicht startet. |
ExitOptions
Gibt an, wie der Batchdienst auf eine bestimmte Beendigungsbedingung reagiert.
| Name | Typ | Beschreibung |
|---|---|---|
| dependencyAction |
Eine Aktion, die der Batch-Service auf Aufgaben ausführt, die von dieser Aufgabe abhängen. Mögliche Werte sind 'satisfy' (ermöglicht den Fortschreiten abhängiger Aufgaben) und 'block' (abhängige Aufgaben warten weiter). Batch unterstützt noch nicht die Stornierung abhängiger Aufgaben. |
|
| jobAction |
Eine Aktion für den Job, der die Aufgabe enthält, wenn die Aufgabe mit der angegebenen Exit-Bedingung abgeschlossen wird und die Eigenschaft des Jobs onTaskFailed ausgeführt wird, ist 'performExitOptionsJobAction'. Standardmäßig ist none für den Ausgangscode 0 und das Beenden für alle anderen Ausgangsbedingungen. Wenn die onTaskFailed-Eigenschaft des Jobs keine Aktion ist, gibt die Angabe dieser Eigenschaft einen Fehler zurück und die Hinzufügungs-Aufgabe-Anfrage schlägt mit einem ungültigen Eigenschaftsfehler fehl; wenn du die REST-API direkt aufrufst, ist der HTTP-Statuscode 400 (Bad Request). |
MultiInstanceSettings
Aufgaben mit mehreren Instanzen werden häufig zur Unterstützung von MPI-Aufgaben verwendet. Wenn eines der Teilvorgänge fehlschlägt (z. B. aufgrund des Beendens mit einem Nicht-Null-Ausgangscode), schlägt im MPI-Fall der gesamte Vorgang mit mehreren Instanzen fehl. Der Vorgang mit mehreren Instanzen wird dann bis zum Wiederholungsgrenzwert beendet und erneut versucht.
| Name | Typ | Beschreibung |
|---|---|---|
| commonResourceFiles |
Eine Liste von Dateien, die der Batch-Service vor dem Ausführen der Koordinationskommandozeile herunterlädt. Der Unterschied zwischen gemeinsamen Ressourcendateien und Aufgabenressourcendateien besteht darin, dass gemeinsame Ressourcendateien für alle Unteraufgaben, einschließlich der primären, heruntergeladen werden, während Aufgabenressourcendateien nur für die primäre heruntergeladen werden. Beachten Sie auch, dass diese Ressourcendateien nicht in das Arbeitsverzeichnis Task heruntergeladen werden, sondern stattdessen in das Task-Root-Verzeichnis (ein Verzeichnis über dem Arbeitsverzeichnis). 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. |
|
| coordinationCommandLine |
string |
Die Kommandozeile soll auf allen Compute-Knoten ausgeführt werden, damit sie sich koordinieren können, wenn der Primary den Haupt-Task-Befehl ausführt. Eine typische Koordinationskommandozeile startet einen Hintergrunddienst und überprüft, ob der Dienst bereit ist, Inter-Knoten-Nachrichten zu verarbeiten. |
| numberOfInstances |
integer (int32) |
Die Anzahl der Compute-Knoten, die von der Aufgabe benötigt werden. Wenn es weggelassen wird, lautet standardmäßig 1. |
NameValuePair
Stellt ein Name-Wert-Paar dar.
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
Der Name im Namen-Wert-Paar. |
| value |
string |
Der Wert im Namen-Wert-Paar. |
OutputFile
Bei allen Dateiuploads schreibt der Batchdienst zwei Protokolldateien in den Computeknoten "fileuploadout.txt" und "fileuploaderr.txt". Diese Protokolldateien werden verwendet, um mehr über einen bestimmten Fehler zu erfahren.
| Name | Typ | Beschreibung |
|---|---|---|
| destination |
Das Ziel für die Ausgabedatei(n). |
|
| filePattern |
string |
Ein Muster, das anzeigt, welche Datei(en) hochgeladen werden sollen. Sowohl relative als auch absolute Wege werden unterstützt. Relative Pfade sind relativ zum Arbeitsverzeichnis Task. Folgende Wildcards werden unterstützt: * entspricht 0 oder mehr Zeichen (zum Beispiel würde Pattern abc* abc oder abcdef übereinstimmen), ** entspricht jedem Verzeichnis, ? entspricht jedem einzelnen Zeichen, [ABC] einem Zeichen in den Klammern, und [A-C] einem Zeichen im Bereich. Klammern können eine Negation enthalten, um jedem nicht spezifizierten Zeichen zu entsprechen (zum Beispiel [!abc] entspricht jedem Zeichen außer a, b oder c). Wenn ein Dateiname mit "." beginnt, wird er standardmäßig ignoriert, kann aber durch explizite Angabe abgestimmt werden (zum Beispiel wird.gif nicht mit .a.gifübereinstimmen, aber ..gif schon). Ein einfaches Beispiel: ***.txt entspricht jeder Datei, die nicht mit '.' beginnt, und endet mit .txt im Arbeitsverzeichnis Task oder in einem beliebigen Unterverzeichnis. Wenn der Dateiname ein Jokerzeichen enthält, kann er durch Klammern escaped werden (zum Beispiel abc[] würde mit einer Datei namens abc übereinstimmen). Beachte, dass sowohl \ als auch / unter Windows als Verzeichnistrenner behandelt werden, aber nur / unter Linux. Umgebungsvariablen (%var% unter Windows oder $var unter Linux) werden vor der Anwendung des Musters erweitert. |
| uploadOptions |
Zusätzliche Optionen für die Upload-Operation, einschließlich unter welchen Bedingungen der Upload durchgeführt werden soll. |
OutputFileBlobContainerDestination
Gibt ein Dateiuploadziel in einem Azure Blob Storage-Container an.
| Name | Typ | Beschreibung |
|---|---|---|
| containerUrl |
string (uri) |
Die URL des Containers innerhalb von Azure Blob Storage, in die die Datei(en) hochgeladen werden können. Wenn keine verwaltete Identität verwendet wird, muss die URL eine Shared Access Signature (SAS) enthalten, die dem Container Schreibrechte gewährt. |
| identityReference |
Der Verweis auf die vom Benutzer zugewiesene Identität, die zum Zugriff auf Azure Blob Storage verwendet werden soll, spezifiziert durch containerUrl. Die Identität muss Schreibzugriff auf den Azure Blob Storage Container haben. |
|
| path |
string |
Der Ziel-Blob oder das virtuelle Verzeichnis innerhalb des Azure Storage-Containers. Wenn filePattern sich auf eine bestimmte Datei bezieht (d. h. keine Wildcards enthält), dann ist path der Name des Blobs, auf den diese Datei hochgeladen werden soll. Wenn filePattern eine oder mehrere Wildcards enthält (und daher mehrere Dateien übereinstimmen kann), dann ist path der Name des virtuellen Blob-Verzeichnisses (das jedem Blob-Namen vorangestellt ist), in das die Datei(en) hochgeladen werden kann. Wenn sie weggelassen werden, werden Datei(en) mit einem Blob-Namen, der mit ihrem Dateinamen übereinstimmt, in die Wurzel des Containers hochgeladen. |
| uploadHeaders |
Eine Liste von Name-Wert-Paaren für Header, die beim Hochladen von Ausgabedateien verwendet werden sollen. Diese Header werden beim Hochladen von Dateien in Azure Storage angegeben. Offizielles Dokument zu erlaubten Headern beim Hochladen von Blobs: https://v4.hkg1.meaqua.org/rest/api/storageservices/put-blob#request-headers-all-blob-types. |
OutputFileDestination
Das Ziel, in das eine Datei hochgeladen werden soll.
| Name | Typ | Beschreibung |
|---|---|---|
| container |
Ein Ort im Azure-Blob-Speicher, an den Dateien hochgeladen werden. |
OutputFileUploadCondition
OutputFileUploadCondition-Enume
| Wert | Beschreibung |
|---|---|
| tasksuccess |
Laden Sie die Datei(en) erst hoch, nachdem der Task-Prozess mit dem Abschlusscode 0 abgeschlossen ist. |
| taskfailure |
Laden Sie die Datei(en) erst hoch, nachdem der Task-Prozess mit einem von null verschiedenen Abschlusscode beendet ist. |
| taskcompletion |
Lade die Datei(en) nach Abschluss des Task-Prozesses hoch, egal wie der Exit-Code war. |
OutputFileUploadConfig
Optionen für einen Uploadvorgang einer Ausgabedatei, einschließlich der Bedingungen, unter denen der Upload ausgeführt werden soll.
| Name | Typ | Beschreibung |
|---|---|---|
| uploadCondition |
Die Bedingungen, unter denen die Task-Ausgabedatei oder die Dateisammlung hochgeladen werden sollte. Die Standardeinstellung ist Task-Completion (Aufgabenabschluss). |
OutputFileUploadHeader
Ein HTTP-Headernamen-Wert-Paar
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
Der groß- und kleinschreibungsunsensitive Name des Headers, der beim Hochladen von Ausgabedateien verwendet werden soll. |
| value |
string |
Der Wert des Headers, der beim Hochladen von Ausgabedateien verwendet werden soll. |
ResourceFile
Eine einzelne Datei oder mehrere Dateien, die in einen Computeknoten heruntergeladen werden sollen.
| Name | Typ | Beschreibung |
|---|---|---|
| autoStorageContainerName |
string |
Der Name des Speichercontainers im automatischen Speicherkonto. Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden. |
| blobPrefix |
string |
Das Blobpräfix, das beim Herunterladen von Blobs aus einem Azure Storage-Container verwendet werden soll. Nur die Blobs, deren Namen mit dem angegebenen Präfix beginnen, werden heruntergeladen. Die Eigenschaft ist nur gültig, wenn autoStorageContainerName oder storageContainerUrl verwendet wird. Dieses Präfix kann ein teilweiser Dateiname oder ein Unterverzeichnis sein. Wenn kein Präfix angegeben ist, werden alle Dateien im Container heruntergeladen. |
| fileMode |
string |
Das Attribut für den Dateiberechtigungsmodus im oktalen Format. Diese Eigenschaft gilt nur für Dateien, die auf Linux Compute Nodes heruntergeladen werden. Sie wird ignoriert, wenn sie für eine ResourceFile angegeben ist, die auf einen Windows-Compute-Node heruntergeladen wird. Wenn diese Eigenschaft für einen Linux Compute Node nicht angegeben ist, wird der Standardwert 0770 auf die Datei angewendet. |
| filePath |
string |
Der Ort auf dem Compute-Knoten, zu dem die Datei(en) heruntergeladen werden sollen, relativ zum Arbeitsverzeichnis der Task. Wenn die httpUrl-Eigenschaft angegeben ist, ist der FilePath erforderlich und beschreibt den Pfad, in den die Datei heruntergeladen wird, einschließlich des Dateinamens. Andernfalls ist filePath optional, wenn die autoStorageContainerName- oder storageContainerUrl-Eigenschaft angegeben ist, und das Verzeichnis, in das die Dateien heruntergeladen werden sollen. Wenn FilePath als Verzeichnis verwendet wird, werden alle bereits den Eingabedaten zugeordneten Verzeichnisstruktur vollständig aufbewahrt und an das angegebene FilePath-Verzeichnis angefügt. Der angegebene relative Pfad kann nicht aus dem Arbeitsverzeichnis der Aufgabe herausbrechen (zum Beispiel durch die Verwendung von '..'). |
| httpUrl |
string (uri) |
Die URL der herunterzuladenden Datei. Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden. Wenn die URL auf Azure Blob Storage verweist, muss sie von Computeknoten gelesen werden. Es gibt drei Möglichkeiten, eine solche URL für ein Blob im Azure-Speicher abzurufen: Fügen Sie eine SAS (Shared Access Signature) hinzu, die Leseberechtigungen für das Blob gewährt, eine verwaltete Identität mit Leseberechtigung verwenden oder die ACL für das Blob oder dessen Container so festlegen, dass der öffentliche Zugriff zulässig ist. |
| identityReference |
Die Referenz auf die vom Benutzer zugewiesene Identität, die zum Zugriff auf Azure Blob Storage verwendet wird, spezifiziert durch storageContainerUrl oder httpUrl. |
|
| storageContainerUrl |
string (uri) |
Die URL des Blobcontainers in Azure Blob Storage. Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden. Diese URL muss von Computeknoten lesbar und auflistenbar sein. Es gibt drei Möglichkeiten, eine solche URL für einen Container in Azure Storage abzurufen: Fügen Sie eine SAS (Shared Access Signature) hinzu, die Lese- und Listenberechtigungen für den Container gewährt, eine verwaltete Identität mit Lese- und Listenberechtigungen verwenden oder die ACL für den Container so festlegen, dass der öffentliche Zugriff zugelassen wird. |
UserIdentity
Die Definition der Benutzeridentität, unter der die Aufgabe ausgeführt wird. Geben Sie entweder die Eigenschaft "userName" oder "autoUser" an, aber nicht beide.
| Name | Typ | Beschreibung |
|---|---|---|
| autoUser |
Der automatische Benutzer, unter dem die Aufgabe ausgeführt wird. Die Eigenschaften "userName" und "autoUser" schließen sich gegenseitig aus; Sie müssen einen, aber nicht beide angeben. |
|
| username |
string |
Der Name der Benutzeridentität, unter der die Aufgabe ausgeführt wird. Die Eigenschaften "userName" und "autoUser" schließen sich gegenseitig aus; Sie müssen einen, aber nicht beide angeben. |