Task - List

Service:

Batch Service

API Version:

2023-11-01.18.0

Listet alle Aufgaben auf, die dem angegebenen Auftrag zugeordnet sind.
Informationen wie affinityId, executionInfo und nodeInfo beziehen sich bei Tasks mit mehreren instance auf den primären Task. Verwenden Sie die List-Subtasks-API, um Informationen zu Teilvorgängen abzurufen.

GET {batchUrl}/jobs/{jobId}/tasks?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/tasks?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
batchUrl	path	True	string	Die Basis-URL für alle Azure Batch-Dienstanforderungen.
jobId	path	True	string	Die ID des Auftrags.
api-version	query	True	string	Client-API-Version.
$expand	query		string	Eine OData-$expand-Klausel.
$filter	query		string	Eine OData-$filter-Klausel. Weitere Informationen zum Erstellen dieses Filters finden Sie unter https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks.
$select	query		string	Eine OData $select-Klausel.
maxresults	query		integer int32	Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Es können maximal 1.000 Aufgaben zurückgegeben werden.
timeout	query		integer int32	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden aufwenden kann. Der Standardwert ist 30 Sekunden.

Anforderungsheader

Media Types: "application/json; odata=minimalmetadata"

Name	Erforderlich	Typ	Beschreibung
client-request-id		string uuid	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 client-request-ID in der Antwort zurückgeben soll.
ocp-date		string date-time-rfc1123	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.

Antworten

Name	Typ	Beschreibung
200 OK	CloudTaskListResult	Eine Antwort, die die Liste der Aufgaben enthält. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Der Fehler vom Batch-Dienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodeflow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Authorization

Type: apiKey
In: header

Beispiele

Task list

Sample Request

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks?api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "task1",
      "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task1",
      "eTag": "0x8D4125FD1A825A4",
      "creationTime": "2016-11-21T22:43:31.4733476Z",
      "lastModified": "2016-11-21T22:43:31.4733476Z",
      "state": "active",
      "stateTransitionTime": "2016-11-21T22:43:31.4733476Z",
      "commandLine": "cmd /c echo task1",
      "userIdentity": {
        "autoUser": {
          "scope": "task",
          "elevationLevel": "nonadmin"
        }
      },
      "constraints": {
        "maxWallClockTime": "P10675199DT2H48M5.4775807S",
        "retentionTime": "P10675199DT2H48M5.4775807S",
        "maxTaskRetryCount": 0
      },
      "requiredSlots": 2,
      "executionInfo": {
        "retryCount": 0,
        "requeueCount": 0
      }
    },
    {
      "id": "task2",
      "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task2",
      "eTag": "0x8D4125FD2153345",
      "creationTime": "2016-11-21T22:43:31.6736345Z",
      "lastModified": "2016-11-21T22:43:32.1880389Z",
      "state": "active",
      "stateTransitionTime": "2016-11-21T22:43:31.6736345Z",
      "commandLine": "cmd /c echo task2",
      "userIdentity": {
        "autoUser": {
          "scope": "task",
          "elevationLevel": "nonadmin"
        }
      },
      "constraints": {
        "maxWallClockTime": "P10675199DT2H48M5.4775807S",
        "retentionTime": "P10675199DT2H48M5.4775807S",
        "maxTaskRetryCount": 3
      },
      "requiredSlots": 2,
      "executionInfo": {
        "retryCount": 0,
        "requeueCount": 0
      }
    }
  ]
}

Definitionen

Name	Beschreibung
AccessScope	Die Batch-Ressourcen, auf die das Token Zugriff gewährt.
AffinityInformation	Ein Lokalitätshinweis, der vom Batch-Dienst verwendet werden kann, um einen Computeknoten auszuwählen, auf dem eine Aufgabe gestartet werden soll.
ApplicationPackageReference	Ein Verweis auf ein Paket, das auf Computeknoten bereitgestellt werden soll.
AuthenticationTokenSettings	Die Einstellungen für ein Authentifizierungstoken, das der Task zum Ausführen von Batch-Dienstvorgängen verwenden kann.
AutoUserScope	Der Bereich für den automatischen Benutzer
AutoUserSpecification	Gibt die Parameter für den automatischen Benutzer an, der einen Task im Batch-Dienst ausführt.
BatchError	Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail	Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.
CloudTask	Eine Azure Batch Aufgabe.
CloudTaskListResult	Das Ergebnis der Auflistung der Aufgaben in einem Auftrag.
ComputeNodeIdentityReference	Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.
ComputeNodeInformation	Informationen zum Computeknoten, auf dem ein Task ausgeführt wurde.
ContainerRegistry	Eine private Containerregistrierung.
ContainerWorkingDirectory	Der Speicherort des Arbeitsverzeichnisses des Containertasks.
DependencyAction	Eine Aktion, die der Batch-Dienst für Aufgaben ausführt, die von diesem Task abhängen.
ElevationLevel	Die Höhenstufe des Benutzers.
EnvironmentSetting	Eine Umgebungsvariable, die für einen Vorgangsvorgang festgelegt werden soll.
ErrorCategory	Die Kategorie des Fehlers.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.
ExitCodeMapping	Wie der Batch-Dienst reagieren soll, wenn ein Task mit einem bestimmten Exitcode beendet wird.
ExitCodeRangeMapping	Eine Reihe von Exitcodes und wie der Batch-Dienst auf Exitcodes innerhalb dieses Bereichs reagieren soll.
ExitConditions	Gibt an, wie der Batch-Dienst reagieren soll, wenn die Aufgabe abgeschlossen ist.
ExitOptions	Gibt an, wie der Batch-Dienst auf eine bestimmte Beendigungsbedingung reagiert.
HttpHeader	Ein Name-Wert-Paar für HTTP-Header
JobAction	Eine Aktion, die für den Auftrag ausgeführt werden soll, der den Task enthält, wenn der Task mit der angegebenen Beendigungsbedingung abgeschlossen wird und die onTaskFailed-Eigenschaft des Auftrags "performExitOptionsJobAction" lautet.
MultiInstanceSettings	Einstellungen, die angeben, wie ein Task mit mehreren instance ausgeführt werden soll.
NameValuePair	Stellt ein Name-Wert-Paar dar.
OutputFile	Eine Spezifikation zum Hochladen von Dateien aus einem Azure Batch Computeknoten an einen anderen Speicherort, nachdem der Batch-Dienst die Ausführung des Vorgangs abgeschlossen hat.
OutputFileBlobContainerDestination	Gibt ein Dateiuploadziel in einem Azure Blob Storage-Container an.
OutputFileDestination	Das Ziel, in das eine Datei hochgeladen werden soll.
OutputFileUploadCondition	Die Bedingungen, unter denen eine Taskausgabedatei oder eine Gruppe von Dateien hochgeladen werden soll.
OutputFileUploadOptions	Details zu einem Ausgabedateiuploadvorgang, einschließlich der Bedingungen, unter welchen Bedingungen der Upload ausgeführt werden soll.
ResourceFile	Eine einzelne Datei oder mehrere Dateien, die auf einen Computeknoten heruntergeladen werden sollen.
TaskConstraints	Ausführungseinschränkungen, die auf einen Task angewendet werden sollen.
TaskContainerExecutionInformation	Enthält Informationen zum Container, den ein Task ausführt.
TaskContainerSettings	Die Containereinstellungen für einen Task.
TaskDependencies	Gibt alle Abhängigkeiten einer Aufgabe an. Jede Aufgabe, die explizit oder innerhalb eines Abhängigkeitsbereichs angegeben ist, muss abgeschlossen werden, bevor der abhängige Task geplant wird.
TaskExecutionInformation	Informationen zur Ausführung einer Aufgabe.
TaskExecutionResult	Das Ergebnis der Taskausführung.
TaskFailureInformation	Informationen zu einem Vorgangsfehler.
TaskIdRange	Ein Bereich von Aufgaben-IDs, von denen ein Task abhängig sein kann. Alle Tasks mit IDs im Bereich müssen erfolgreich abgeschlossen werden, bevor der abhängige Task geplant werden kann.
TaskState	Der Status des Tasks.
TaskStatistics	Ressourcennutzungsstatistiken für einen Vorgang.
UserIdentity	Die Definition der Benutzeridentität, unter der der Task ausgeführt wird.

AccessScope

Die Batch-Ressourcen, auf die das Token Zugriff gewährt.

Name	Typ	Beschreibung
job	string	Gewährt Zugriff, um alle Vorgänge für den Auftrag auszuführen, der den Task enthält.

AffinityInformation

Ein Lokalitätshinweis, der vom Batch-Dienst verwendet werden kann, um einen Computeknoten auszuwählen, auf dem eine Aufgabe gestartet werden soll.

Name	Typ	Beschreibung
affinityId	string	Eine undurchsichtige Zeichenfolge, die den Speicherort eines Computeknotens oder einer Aufgabe darstellt, die zuvor ausgeführt wurde. Sie können die affinityId eines Knotens übergeben, um anzugeben, dass dieser Task auf diesem Computeknoten ausgeführt werden muss. Beachten Sie, dass dies nur eine weiche Affinität ist. Wenn der Compute-Zielknoten ausgelastet ist oder nicht verfügbar ist, wenn der Task geplant ist, wird der Task an anderer Stelle geplant.

ApplicationPackageReference

Ein Verweis auf ein Paket, das auf Computeknoten bereitgestellt werden soll.

Name	Typ	Beschreibung
applicationId	string	Die ID der anwendung, die bereitgestellt werden soll. Beim Erstellen eines Pools muss die Anwendungs-ID des Pakets voll qualifiziert sein (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Die Version der anwendung, die bereitgestellt werden soll. Wenn nicht angegeben, wird die Standardversion bereitgestellt. Wenn dies in einem Pool ausgelassen wird und keine Standardversion für diese Anwendung angegeben ist, schlägt die Anforderung mit dem Fehlercode InvalidApplicationPackageReferences und HTTP status Code 409 fehl. Wenn dies für einen Task ausgelassen wird und keine Standardversion für diese Anwendung angegeben ist, schlägt der Task mit einem Vorverarbeitungsfehler fehl.

AuthenticationTokenSettings

Die Einstellungen für ein Authentifizierungstoken, das der Task zum Ausführen von Batch-Dienstvorgängen verwenden kann.

Name	Typ	Beschreibung
access	AccessScope[]	Die Batch-Ressourcen, auf die das Token Zugriff gewährt. Das Authentifizierungstoken gewährt Zugriff auf eine begrenzte Gruppe von Batch-Dienstvorgängen. Derzeit ist der einzige unterstützte Wert für die Zugriffseigenschaft "job", der Zugriff auf alle Vorgänge im Zusammenhang mit dem Auftrag gewährt, der den Task enthält.

AutoUserScope

Der Bereich für den automatischen Benutzer

Name	Typ	Beschreibung
pool	string	Gibt an, dass der Task als allgemeines automatisches Benutzerkonto ausgeführt wird, das auf jedem Computeknoten in einem Pool erstellt wird.
task	string	Gibt an, dass der Dienst einen neuen Benutzer für den Task erstellen soll.

AutoUserSpecification

Gibt die Parameter für den automatischen Benutzer an, der einen Task im Batch-Dienst ausführt.

Name	Typ	Beschreibung
elevationLevel	ElevationLevel	Die Höhenstufe des automatischen Benutzers. Der Standardwert ist nonAdmin.
scope	AutoUserScope	Der Bereich für den automatischen Benutzer Der Standardwert ist pool. Wenn im Pool Windows ausgeführt wird, sollte der Wert Task angegeben werden, wenn eine strengere Isolation zwischen Tasks erforderlich ist. Beispielsweise, wenn die Aufgabe die Registrierung auf eine Weise mutiert, die sich auf andere Aufgaben auswirken kann, oder wenn Zertifikate für den Pool angegeben wurden, auf die normale Aufgaben nicht zugreifen können, sondern von StartTasks zugänglich sein sollten.

BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
message	ErrorMessage	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
values	BatchErrorDetail[]	Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthält.

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.

CloudTask

Eine Azure Batch Aufgabe.

Name	Typ	Beschreibung
affinityInfo	AffinityInformation	Ein Lokalitätshinweis, der vom Batch-Dienst verwendet werden kann, um einen Computeknoten auszuwählen, auf dem der neue Task gestartet werden soll.
applicationPackageReferences	ApplicationPackageReference[]	Eine Liste der Pakete, die der Batch-Dienst auf dem Computeknoten bereitstellt, bevor die Befehlszeile ausgeführt wird. Anwendungspakete werden heruntergeladen und in einem freigegebenen Verzeichnis bereitgestellt, nicht in das Arbeitsverzeichnis Task. Wenn sich ein Paket, auf das verwiesen wird, bereits auf dem Knoten befindet und auf dem neuesten Stand ist, wird es daher nicht erneut heruntergeladen. Die vorhandene Kopie auf dem Computeknoten wird verwendet. Wenn ein Paket, auf das verwiesen wird, nicht installiert werden kann, z. B. weil das Paket gelöscht wurde oder der Download fehlgeschlagen ist, schlägt der Task fehl.
authenticationTokenSettings	AuthenticationTokenSettings	Die Einstellungen für ein Authentifizierungstoken, das der Task zum Ausführen von Batch-Dienstvorgängen verwenden kann. Wenn diese Eigenschaft festgelegt ist, stellt der Batch-Dienst der Aufgabe ein Authentifizierungstoken bereit, das zum Authentifizieren von Batch-Dienstvorgä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 der Task mit dem Token ausführen kann, hängen von den Einstellungen ab. Beispielsweise kann ein Task Auftragsberechtigungen anfordern, um dem Auftrag weitere Aufgaben hinzuzufügen, oder die status des Auftrags oder anderer Aufgaben unter dem Auftrag überprüfen.
commandLine	string	Die Befehlszeile der Aufgabe. Bei Aufgaben mit mehreren instance wird die Befehlszeile als primäre Aufgabe ausgeführt, nachdem die primäre Aufgabe und alle Untertasks die Koordinationsbefehlszeile abgeschlossen haben. Die Befehlszeile wird nicht unter einer Shell ausgeführt und kann daher keine Shellfeatures wie die Erweiterung von Umgebungsvariablen nutzen. Wenn Sie solche Features nutzen möchten, sollten Sie die Shell in der Befehlszeile aufrufen, z. B. mit "cmd /c MyCommand" in Windows oder mit "/bin/sh -c MyCommand" unter Linux. Wenn die Befehlszeile auf Dateipfade verweist, sollte sie einen relativen Pfad (relativ zum Arbeitsverzeichnis Task) verwenden oder die von Batch bereitgestellte Umgebungsvariable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) verwenden.
constraints	TaskConstraints	Die Ausführungseinschränkungen, die für diesen Task gelten.
containerSettings	TaskContainerSettings	Die Einstellungen für den Container, unter dem der Task ausgeführt wird. Wenn für den Pool, der diesen Task ausführen soll, containerConfiguration festgelegt ist, muss auch dies festgelegt werden. Wenn für den Pool, der diesen Task ausführen soll, containerConfiguration nicht festgelegt ist, darf dies nicht festgelegt werden. Wenn dies angegeben ist, werden alle Verzeichnisse, die sich rekursiv unterhalb des AZ_BATCH_NODE_ROOT_DIR befinden (der Stamm der Azure Batch Verzeichnisse auf dem Knoten) dem Container zugeordnet, alle Umgebungsvariablen der Aufgabe 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 werden, werden möglicherweise nicht auf dem Hostdatenträger angezeigt, was bedeutet, dass Batch-Datei-APIs nicht auf diese Dateien zugreifen können.
creationTime	string	Die Erstellungszeit der Aufgabe.
dependsOn	TaskDependencies	Die Aufgaben, von denen diese Aufgabe abhängt. Diese Aufgabe wird erst geplant, wenn alle Aufgaben, von denen sie abhängt, erfolgreich abgeschlossen wurden. Wenn eine dieser Aufgaben fehlschlägt und die Wiederholungsanzahl erschöpft ist, wird diese Aufgabe nie geplant.
displayName	string	Ein Anzeigename für den Task. Der Anzeigename muss nicht eindeutig sein und kann Unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten.
eTag	string	Das ETag der Aufgabe. 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 übergeben, wenn Sie einen Task aktualisieren, um anzugeben, dass Ihre Änderungen nur wirksam werden sollen, wenn die Aufgabe in der Zwischenzeit von niemand anderem geändert wurde.
environmentSettings	EnvironmentSetting[]	Eine Liste der Umgebungsvariableneinstellungen für den Task.
executionInfo	TaskExecutionInformation	Informationen zur Ausführung der Aufgabe.
exitConditions	ExitConditions	Gibt an, wie der Batch-Dienst reagieren soll, wenn die Aufgabe abgeschlossen ist. Wie der Batch-Dienst reagieren soll, wenn die Aufgabe abgeschlossen ist.
id	string	Eine Zeichenfolge, die die Aufgabe innerhalb des Auftrags eindeutig identifiziert. Die ID kann eine beliebige Kombination alphanumerischer Zeichen enthalten, einschließlich Bindestrichen und Unterstrichen, und darf nicht mehr als 64 Zeichen enthalten.
lastModified	string	Der Zeitpunkt der letzten Änderung des Vorgangs.
multiInstanceSettings	MultiInstanceSettings	Ein -Objekt, das angibt, dass es sich bei dem Task um einen Task mit mehreren instance handelt und Informationen zum Ausführen des Task mit mehreren instance enthält. Aufgaben mit mehreren instance werden häufig zur Unterstützung von MPI-Aufgaben verwendet. Wenn im MPI-Fall einer der Teiltasks fehlschlägt (z. B. aufgrund des Beendens mit einem Nicht-Null-Exitcode), schlägt der gesamte Task mit mehreren instance fehl. Der Task mit mehreren instance wird dann beendet und bis zu seinem Wiederholungslimit wiederholt.
nodeInfo	ComputeNodeInformation	Informationen zum Computeknoten, auf dem der Task ausgeführt wurde.
outputFiles	OutputFile[]	Eine Liste der Dateien, die der Batch-Dienst nach dem Ausführen der Befehlszeile aus dem Computeknoten hochlädt. Bei Aufgaben mit mehreren instance werden die Dateien nur aus dem Computeknoten hochgeladen, auf dem der primäre Task ausgeführt wird.
previousState	TaskState	Der vorherige Status des Vorgangs. Diese Eigenschaft wird nicht festgelegt, wenn sich der Task im Anfangszustand Aktiv befindet.
previousStateTransitionTime	string	Die Zeit, zu der der Vorgang in den vorherigen Zustand eingetreten ist. Diese Eigenschaft wird nicht festgelegt, wenn sich der Task im Anfangszustand Aktiv befindet.
requiredSlots	integer	Die Anzahl der Planungsslots, die der Task zum Ausführen benötigt. 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 Planungsslots verfügt. Bei Aufgaben mit mehreren instance muss dies 1 sein.
resourceFiles	ResourceFile[]	Eine Liste der Dateien, die der Batch-Dienst vor dem Ausführen der Befehlszeile auf den Computeknoten lädt. Bei Aufgaben mit mehreren instance werden die Ressourcendateien nur auf den Computeknoten heruntergeladen, auf dem der primäre Task 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. In diesem Fall muss die Auflistung von ResourceFiles verkleinert werden. Dies kann mit .zip-Dateien, Anwendungspaketen oder Docker-Containern erreicht werden.
state	TaskState	Der aktuelle Status der Aufgabe.
stateTransitionTime	string	Der Zeitpunkt, zu dem der Vorgang in den aktuellen Zustand gelangt ist.
stats	TaskStatistics	Ressourcennutzungsstatistiken für den Task.
url	string	Die URL der Aufgabe.
userIdentity	UserIdentity	Die Benutzeridentität, unter der der Task ausgeführt wird. Wenn er nicht angegeben wird, wird der Task als nicht administrativer Benutzer ausgeführt, der für den Task eindeutig ist.

CloudTaskListResult

Das Ergebnis der Auflistung der Aufgaben in einem Auftrag.

Name	Typ	Beschreibung
odata.nextLink	string	Die URL zum Abrufen der nächsten Gruppe von Ergebnissen.
value	CloudTask[]	Die Liste der Aufgaben.

ComputeNodeIdentityReference

Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.

Name	Typ	Beschreibung
resourceId	string	Die ARM-Ressourcen-ID der benutzerseitig zugewiesenen Identität.

ComputeNodeInformation

Informationen zum Computeknoten, auf dem ein Task ausgeführt wurde.

Name	Typ	Beschreibung
affinityId	string	Ein Bezeichner für den Knoten, auf dem der Task ausgeführt wurde, der übergeben werden kann, wenn ein Task hinzugefügt wird, um anzufordern, dass der Task auf diesem Computeknoten geplant wird.
nodeId	string	Die ID des Computeknotens, auf dem der Task ausgeführt wurde.
nodeUrl	string	Die URL des Computeknotens, auf dem der Task ausgeführt wurde.
poolId	string	Die ID des Pools, in dem der Task ausgeführt wurde.
taskRootDirectory	string	Das Stammverzeichnis des Tasks auf dem Computeknoten.
taskRootDirectoryUrl	string	Die URL zum Stammverzeichnis des Tasks auf dem Computeknoten.

ContainerRegistry

Eine private Containerregistrierung.

Name	Typ	Beschreibung
identityReference	ComputeNodeIdentityReference	Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf eine Azure Container Registry anstelle von Benutzername und Kennwort verwendet werden soll. Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.
password	string	Das Kennwort für die Anmeldung beim Registrierungsserver.
registryServer	string	Die Registrierungs-URL Wenn nicht angegeben, lautet der Standardwert "docker.io".
username	string	Der Benutzername für die Anmeldung beim Registrierungsserver.

ContainerWorkingDirectory

Der Speicherort des Arbeitsverzeichnisses des Containertasks.

Name	Typ	Beschreibung
containerImageDefault	string	Verwenden Sie das im Containerimage definierte Arbeitsverzeichnis. Achten Sie darauf, dass dieses Verzeichnis die von Batch heruntergeladenen Ressourcendateien nicht enthält.
taskWorkingDirectory	string	Verwenden Sie das Standardmäßige Arbeitsverzeichnis Batch-Diensttask, das die Aufgabenressourcendateien enthält, die von Batch aufgefüllt werden.

DependencyAction

Eine Aktion, die der Batch-Dienst für Aufgaben ausführt, die von diesem Task abhängen.

Name	Typ	Beschreibung
block	string	Blockiert Aufgaben, die auf diesen Task warten, und verhindert, dass sie geplant werden.
satisfy	string	Erfüllen von Aufgaben, die auf diese Aufgabe warten; Sobald alle Abhängigkeiten erfüllt sind, wird die Ausführung der Aufgabe geplant.

ElevationLevel

Die Höhenstufe des Benutzers.

Name	Typ	Beschreibung
admin	string	Der Benutzer ist ein Benutzer mit erhöhtem Zugriff und arbeitet mit vollständigen Administratorberechtigungen.
nonadmin	string	Der Benutzer ist ein Standardbenutzer ohne erhöhten Zugriff.

EnvironmentSetting

Eine Umgebungsvariable, die für einen Vorgangsvorgang festgelegt werden soll.

Name	Typ	Beschreibung
name	string	Der Name der Umgebungsvariablen.
value	string	Der Wert der Umgebungsvariablen.

ErrorCategory

Die Kategorie des Fehlers.

Name	Typ	Beschreibung
servererror	string	Der Fehler ist auf ein internes Serverproblem zurückzuführen.
usererror	string	Der Fehler ist auf ein Benutzerproblem zurückzuführen, z. B. eine Fehlkonfiguration.

ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.

Name	Typ	Beschreibung
lang	string	Der Sprachcode der Fehlermeldung
value	string	Der Text der Meldung.

ExitCodeMapping

Wie der Batch-Dienst reagieren soll, wenn ein Task mit einem bestimmten Exitcode beendet wird.

Name	Typ	Beschreibung
code	integer	Ein Prozessausgangscode.
exitOptions	ExitOptions	Wie der Batch-Dienst reagieren soll, wenn der Task mit diesem Exitcode beendet wird.

ExitCodeRangeMapping

Eine Reihe von Exitcodes und wie der Batch-Dienst auf Exitcodes innerhalb dieses Bereichs reagieren soll.

Name	Typ	Beschreibung
end	integer	Der letzte Exitcode im Bereich.
exitOptions	ExitOptions	Wie der Batch-Dienst reagieren soll, wenn der Task mit einem Exitcode im Bereich "Start bis Ende" (einschließlich) beendet wird.
start	integer	Der erste Exitcode im Bereich.

ExitConditions

Gibt an, wie der Batch-Dienst reagieren soll, wenn die Aufgabe abgeschlossen ist.

Name	Typ	Beschreibung
default	ExitOptions	Wie der Batch-Dienst reagieren soll, wenn der Task mit einer Beendigungsbedingung fehlschlägt, die von keiner der anderen Eigenschaften abgedeckt ist. Dieser Wert wird verwendet, wenn der Task mit einem Nichtzero-Exitcode beendet wird, der nicht in der exitCodes- oder exitCodeRanges-Auflistung aufgeführt ist, mit einem Vorverarbeitungsfehler, wenn die preProcessingError-Eigenschaft nicht vorhanden ist, oder mit einem Dateiuploadfehler, wenn die fileUploadError-Eigenschaft nicht vorhanden ist. Wenn Sie ein nicht standardmäßiges Verhalten für Exitcode 0 wünschen, müssen Sie ihn explizit mit der exitCodes- oder exitCodeRanges-Auflistung auflisten.
exitCodeRanges	ExitCodeRangeMapping[]	Eine Liste der Aufgabenausgangscodebereiche und wie der Batch-Dienst darauf reagieren soll.
exitCodes	ExitCodeMapping[]	Eine Liste der einzelnen Task-Exitcodes und wie der Batch-Dienst darauf reagieren soll.
fileUploadError	ExitOptions	Wie der Batch-Dienst reagieren soll, wenn ein Dateiuploadfehler auftritt. Wenn der Task mit einem Exitcode beendet wurde, der über exitCodes oder exitCodeRanges angegeben wurde, und dann ein Dateiuploadfehler aufgetreten ist, hat die vom Exitcode angegebene Aktion Vorrang.
preProcessingError	ExitOptions	Wie der Batch-Dienst reagieren soll, wenn der Task aufgrund eines Fehlers nicht gestartet werden kann.

ExitOptions

Gibt an, wie der Batch-Dienst auf eine bestimmte Beendigungsbedingung reagiert.

Name	Typ	Beschreibung
dependencyAction	DependencyAction	Eine Aktion, die der Batch-Dienst für Aufgaben ausführt, die von dieser Aufgabe abhängen. Mögliche Werte sind "zufrieden" (sodass abhängige Aufgaben weiter ausgeführt werden können) und "blockieren" (abhängige Aufgaben warten weiterhin). Batch unterstützt das Abbrechen abhängiger Aufgaben noch nicht.
jobAction	JobAction	Eine Aktion, die für den Auftrag ausgeführt werden soll, der den Task enthält, wenn der Task mit der angegebenen Beendigungsbedingung abgeschlossen wird und die onTaskFailed-Eigenschaft des Auftrags "performExitOptionsJobAction" lautet. Der Standardwert ist keine für Exitcode 0 und endet für alle anderen Exitbedingungen. Wenn die onTaskFailed-Eigenschaft des Auftrags noaction ist, gibt die Angabe dieser Eigenschaft einen Fehler zurück, und die Anforderung zum Hinzufügen von Task schlägt mit einem ungültigen Eigenschaftswertfehler fehl. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-status Code 400 (Ungültige Anforderung).

HttpHeader

Ein Name-Wert-Paar für HTTP-Header

Name	Typ	Beschreibung
name	string	Der Name des Headers, der beim Hochladen von Ausgabedateien verwendet werden soll, ohne Berücksichtigung der Groß-/Kleinschreibung
value	string	Der Wert des Headers, der beim Hochladen von Ausgabedateien verwendet werden soll.

JobAction

Eine Aktion, die für den Auftrag ausgeführt werden soll, der den Task enthält, wenn der Task mit der angegebenen Beendigungsbedingung abgeschlossen wird und die onTaskFailed-Eigenschaft des Auftrags "performExitOptionsJobAction" lautet.

Name	Typ	Beschreibung
disable	string	Deaktivieren Sie den Auftrag. Dies entspricht dem Aufruf der api zum Deaktivieren von Aufträgen mit dem Wert disableTasks requeue.
none	string	Ergreifen Sie keine Aktion.
terminate	string	Beenden Sie den Auftrag. TerminateReason in der executionInfo des Auftrags ist auf "TaskFailed" festgelegt.

MultiInstanceSettings

Einstellungen, die angeben, wie ein Task mit mehreren instance ausgeführt werden soll.

Name	Typ	Beschreibung
commonResourceFiles	ResourceFile[]	Eine Liste der Dateien, die vom Batch-Dienst heruntergeladen werden, bevor die Koordinationsbefehlszeile ausgeführt wird. Der Unterschied zwischen allgemeinen Ressourcendateien und Taskressourcendateien besteht darin, dass allgemeine Ressourcendateien für alle Teilvorgänge einschließlich des primären heruntergeladen werden, während Aufgabenressourcendateien nur für die primäre datei heruntergeladen werden. Beachten Sie außerdem, dass diese Ressourcendateien nicht in das Arbeitsverzeichnis Task heruntergeladen werden, sondern stattdessen in das Taskstammverzeichnis (ein Verzeichnis oberhalb des Arbeitsverzeichnisses) heruntergeladen werden. 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. In diesem Fall muss die Auflistung von ResourceFiles verkleinert werden. Dies kann mit .zip-Dateien, Anwendungspaketen oder Docker-Containern erreicht werden.
coordinationCommandLine	string	Die Befehlszeile, die auf allen Computeknoten ausgeführt werden soll, damit sie koordiniert werden können, wenn der primäre Befehl den befehl Standard Task ausführt. Eine typische Koordinationsbefehlszeile startet einen Hintergrunddienst und überprüft, ob der Dienst bereit ist, Nachrichten zwischen Knoten zu verarbeiten.
numberOfInstances	integer	Die Anzahl der für den Task erforderlichen Computeknoten. Wenn nicht angegeben, ist der Standardwert 1.

NameValuePair

Stellt ein Name-Wert-Paar dar.

Name	Typ	Beschreibung
name	string	Der Name im Name-Wert-Paar.
value	string	Der Wert im Name-Wert-Paar.

OutputFile

Eine Spezifikation zum Hochladen von Dateien aus einem Azure Batch Computeknoten an einen anderen Speicherort, nachdem der Batch-Dienst die Ausführung des Vorgangs abgeschlossen hat.

Name	Typ	Beschreibung
destination	OutputFileDestination	Das Ziel für die Ausgabedateien.
filePattern	string	Ein Muster, das angibt, welche Dateien hochgeladen werden sollen. Sowohl relative als auch absolute Pfade werden unterstützt. Relative Pfade sind relativ zum Arbeitsverzeichnis Task. Die folgenden Platzhalter werden unterstützt: * entspricht 0 oder mehr Zeichen (z. B. Muster abc* entspricht abc oder abcdef), ** mit jedem Verzeichnis, ? entspricht einem einzelnen Zeichen, [abc] einem Zeichen in den Klammern und [a-c] einem Zeichen im Bereich. Klammern können eine Negation enthalten, um einem nicht angegebenen Zeichen zu entsprechen (z. B. [!abc] entspricht einem beliebigen Zeichen außer a, b oder c). Wenn ein Dateiname mit "." beginnt, wird er standardmäßig ignoriert, kann aber durch explizite Angabe abgeglichen werden (z. B. .gif nicht mit .a.gif übereinstimmt, sondern ..gif). Ein einfaches Beispiel: ***.txt entspricht jeder Datei, die nicht in "." beginnt und mit .txt im Arbeitsverzeichnis "Aufgabe" oder einem beliebigen Unterverzeichnis endet. Wenn der Dateiname ein Feldhalterzeichen enthält, kann er mithilfe von Klammern (z. B. abc[] mit einer Datei namens abc übereinstimmen). Beachten Sie, dass sowohl \ als auch / unter Windows als Verzeichnistrennzeichen behandelt werden, aber nur / unter Linux. Umgebungsvariablen (%var% unter Windows oder $var unter Linux) werden vor dem Anwenden des Musters erweitert.
uploadOptions	OutputFileUploadOptions	Zusätzliche Optionen für den Uploadvorgang, einschließlich der Bedingungen, unter welchen Bedingungen der Upload ausgeführt werden soll.

OutputFileBlobContainerDestination

Gibt ein Dateiuploadziel in einem Azure Blob Storage-Container an.

Name	Typ	Beschreibung
containerUrl	string	Die URL des Containers in Azure Blob Storage, in den die Dateien hochgeladen werden sollen. Wenn Sie keine verwaltete Identität verwenden, muss die URL eine Shared Access Signature (SAS) enthalten, die Schreibberechtigungen für den Container erteilt.
identityReference	ComputeNodeIdentityReference	Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf Azure Blob Storage verwendet werden soll, der durch containerUrl angegeben wird. Die Identität muss über Schreibzugriff auf den Azure Blob Storage Container verfügen.
path	string	Das Zielblob oder virtuelle Verzeichnis im Azure Storage-Container. Wenn filePattern auf eine bestimmte Datei verweist (d. h. keine Wildcards enthält), ist path der Name des Blobs, in das diese Datei hochgeladen werden soll. Wenn filePattern einen oder mehrere Wildcards enthält (und daher mit mehreren Dateien übereinstimmen kann), ist path der Name des virtuellen Blobverzeichnisses (das jedem Blobnamen vorangestellt ist), in das die Dateien hochgeladen werden sollen. Wenn nicht angegeben, werden Die Dateien in den Stamm des Containers mit einem Blobnamen hochgeladen, der ihrem Dateinamen entspricht.
uploadHeaders	HttpHeader[]	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 zulässigen Headern beim Hochladen von Blobs: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

Das Ziel, in das eine Datei hochgeladen werden soll.

Name	Typ	Beschreibung
container	OutputFileBlobContainerDestination	Ein Speicherort in Azure Blob Storage, an den Dateien hochgeladen werden.

OutputFileUploadCondition

Die Bedingungen, unter denen eine Taskausgabedatei oder eine Gruppe von Dateien hochgeladen werden soll.

Name	Typ	Beschreibung
taskcompletion	string	Laden Sie die Dateien hoch, nachdem der Vorgangsprozess beendet wurde, unabhängig davon, was der Exitcode war.
taskfailure	string	Laden Sie die Dateien erst hoch, nachdem der Vorgangsprozess mit einem Exitcode ungleich null beendet wurde.
tasksuccess	string	Laden Sie die Datei(en) erst hoch, nachdem der Vorgangsprozess mit dem Exitcode 0 beendet wurde.

OutputFileUploadOptions

Details zu einem Ausgabedateiuploadvorgang, einschließlich der Bedingungen, unter welchen Bedingungen der Upload ausgeführt werden soll.

Name	Typ	Beschreibung
uploadCondition	OutputFileUploadCondition	Die Bedingungen, unter denen die Taskausgabedatei oder der Satz von Dateien hochgeladen werden soll. Der Standardwert ist taskcompletion.

ResourceFile

Eine einzelne Datei oder mehrere Dateien, die auf einen Computeknoten heruntergeladen werden sollen.

Name	Typ	Beschreibung
autoStorageContainerName	string	Der Name des Speichercontainers im Konto des automatischen Speichers. 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 partieller Dateiname oder ein Unterverzeichnis sein. Wenn kein Präfix angegeben wird, werden alle Dateien im Container heruntergeladen.
fileMode	string	Das Attribut des Dateiberechtigungsmodus im oktalen Format. Diese Eigenschaft gilt nur für Dateien, die auf Linux-Computeknoten heruntergeladen werden. Sie wird ignoriert, wenn sie für eine resourceFile-Datei angegeben wird, die auf einen Windows-Computeknoten heruntergeladen wird. Wenn diese Eigenschaft nicht für einen Linux-Computeknoten angegeben ist, wird der Standardwert 0770 auf die Datei angewendet.
filePath	string	Der Speicherort auf dem Computeknoten, in den die Datei(en) heruntergeladen werden sollen, relativ zum Arbeitsverzeichnis des Tasks. 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 und das Verzeichnis, in das die Dateien heruntergeladen werden sollen, wenn die Eigenschaft autoStorageContainerName oder storageContainerUrl angegeben wird. Für den Fall, dass filePath als Verzeichnis verwendet wird, wird jede Verzeichnisstruktur, die den Eingabedaten bereits zugeordnet ist, vollständig beibehalten und an das angegebene FilePath-Verzeichnis angefügt. Der angegebene relative Pfad kann nicht aus dem Arbeitsverzeichnis der Aufgabe herausbrechen (z. B. mithilfe von "..").
httpUrl	string	Die URL der herunterzuladenden Bilds. Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden. Wenn die URL auf Azure Blob Storage zeigt, muss sie von Computeknoten gelesen werden. Es gibt drei Möglichkeiten, eine solche URL für ein Blob in Azure Storage abzurufen: Beispielsweise eine SAS (Shared Access Signature), die Leseberechtigungen für das Blob gewährt, eine verwaltete Identität mit Leseberechtigung verwenden oder die ACL für das Blob oder seinen Container festlegen, um den öffentlichen Zugriff zuzulassen.
identityReference	ComputeNodeIdentityReference	Der Verweis auf die benutzerseitig zugewiesene Identität, die für den Zugriff auf Azure Blob Storage verwendet werden soll, der durch storageContainerUrl oder httpUrl angegeben wird. Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.
storageContainerUrl	string	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: Beispielsweise eine SAS (Shared Access Signature), 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 festlegen, um den öffentlichen Zugriff zuzulassen.

TaskConstraints

Ausführungseinschränkungen, die auf einen Task angewendet werden sollen.

Name	Typ	Beschreibung
maxTaskRetryCount	integer	Die maximale Anzahl von Wiederholungsversuchen für den Vorgang. Der Batch-Dienst versucht einen Vorgang erneut, wenn sein Exitcode nicht zero ist. Beachten Sie, dass dieser Wert speziell die Anzahl von Wiederholungen für die ausführbare Task-Datei steuert, die auf einen nonzero-Exitcode zurückzuführen ist. Der Batch-Dienst versucht den Task einmal und kann dann bis zu diesem Grenzwert wiederholen. Wenn die maximale Wiederholungsanzahl beispielsweise 3 beträgt, versucht Batch den Vorgang bis zu vier Mal (ein erster Versuch und 3 Wiederholungen). Wenn die maximale Wiederholungsanzahl 0 ist, versucht der Batch-Dienst den Vorgang nach dem ersten Versuch nicht mehr. Wenn die maximale Wiederholungsanzahl -1 beträgt, wiederholt der Batch-Dienst den Vorgang ohne Einschränkung. Dies wird jedoch nicht für einen Startvorgang oder eine beliebige Aufgabe empfohlen. Der Standardwert ist 0 (keine Wiederholungsversuche).
maxWallClockTime	string	Die maximal verstrichene Zeit, die der Task ausführen kann, gemessen an dem Zeitpunkt, zu dem der Task gestartet wird. Wenn der Task nicht innerhalb des Zeitlimits abgeschlossen wird, wird er vom Batch-Dienst beendet. Wenn dies nicht angegeben ist, gibt es kein Zeitlimit für die Ausführungsdauer des Tasks.
retentionTime	string	Die mindeste Zeit zum Beibehalten des Aufgabenverzeichnisses auf dem Computeknoten, auf dem es ausgeführt wurde, ab dem Zeitpunkt, zu dem die Ausführung abgeschlossen ist. Nach diesem Zeitpunkt kann der Batch-Dienst das Aufgabenverzeichnis und seinen gesamten Inhalt löschen. Der Standardwert ist 7 Tage, d. h. das Aufgabenverzeichnis wird 7 Tage lang aufbewahrt, es sei denn, der Computeknoten wird entfernt oder der Auftrag gelöscht.

TaskContainerExecutionInformation

Enthält Informationen zum Container, den ein Task ausführt.

Name	Typ	Beschreibung
containerId	string	ID des Containers.
error	string	Ausführliche Fehlerinformationen zum Container. Dies ist die detaillierte Fehlerzeichenfolge des Docker-Diensts, sofern verfügbar. Es entspricht dem von "docker inspect" zurückgegebenen Fehlerfeld.
state	string	Der Status des Containers. Dies ist der Status des Containers gemäß dem Docker-Dienst. Es entspricht dem status Feld, das von "docker inspect" zurückgegeben wird.

TaskContainerSettings

Die Containereinstellungen für einen Task.

Name	Typ	Beschreibung
containerRunOptions	string	Zusätzliche Optionen für den Befehl container create. Diese zusätzlichen Optionen werden zusätzlich zu den vom Batch-Dienst gesteuerten Optionen als Argumente für den Befehl "docker create" bereitgestellt.
imageName	string	Das Image, das zum Erstellen des Containers verwendet werden soll, in dem der Task ausgeführt wird. Dies ist der vollständige Imageverweis, wie für "Docker Pull" angegeben wird. Wenn kein Tag als Teil des Imagenamens angegeben wird, wird das Tag ":latest" als Standard verwendet.
registry	ContainerRegistry	Die private Registrierung, die das Containerimage enthält. Diese Einstellung kann weggelassen werden, wenn bereits bei der Poolerstellung angegeben wurde.
workingDirectory	ContainerWorkingDirectory	Der Speicherort des Arbeitsverzeichnisses des Containertasks. Der Standardwert ist "taskWorkingDirectory".

TaskDependencies

Gibt alle Abhängigkeiten einer Aufgabe an. Jede Aufgabe, die explizit oder innerhalb eines Abhängigkeitsbereichs angegeben ist, muss abgeschlossen werden, bevor der abhängige Task geplant wird.

Name	Typ	Beschreibung
taskIdRanges	TaskIdRange[]	Die Liste der Aufgaben-ID-Bereiche, von denen diese Aufgabe abhängt. Alle Aufgaben in allen Bereichen müssen erfolgreich abgeschlossen werden, bevor der abhängige Task geplant werden kann.
taskIds	string[]	Die Liste der Aufgaben-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-Auflistung ist auf insgesamt 64.000 Zeichen begrenzt (d. h. die kombinierte Länge aller Aufgaben-IDs). Wenn die taskIds-Auflistung die maximale Länge überschreitet, schlägt die Anforderung Task hinzufügen mit dem Fehlercode TaskDependencyListTooLong fehl. In diesem Fall sollten Sie stattdessen Aufgaben-ID-Bereiche verwenden.

TaskExecutionInformation

Informationen zur Ausführung einer Aufgabe.

Name	Typ	Beschreibung
containerInfo	TaskContainerExecutionInformation	Informationen zum Container, unter dem der Task ausgeführt wird. Diese Eigenschaft wird nur festgelegt, wenn der Task in einem Containerkontext ausgeführt wird.
endTime	string	Der Zeitpunkt, zu dem die Aufgabe abgeschlossen wurde. Diese Eigenschaft wird nur festgelegt, wenn sich die Aufgabe im Status Abgeschlossen befindet.
exitCode	integer	Der Exitcode des Programms, der in der Task-Befehlszeile angegeben ist. Diese Eigenschaft wird nur festgelegt, wenn sich die Aufgabe im Zustand abgeschlossen befindet. Im Allgemeinen spiegelt der Exitcode für einen Prozess die spezifische Konvention wider, die vom Anwendungsentwickler für diesen Prozess implementiert wurde. Wenn Sie den Exitcodewert verwenden, um Entscheidungen in Ihrem Code zu treffen, stellen Sie sicher, dass Sie die vom Anwendungsprozess verwendete Exitcodekonvention kennen. Wenn der Batch-Dienst den Task jedoch beendet (aufgrund eines Timeouts oder einer Benutzerbeendigung über die API), wird möglicherweise ein vom Betriebssystem definierter Exitcode angezeigt.
failureInfo	TaskFailureInformation	Informationen, die den Vorgangsfehler beschreiben, falls vorhanden. Diese Eigenschaft wird nur festgelegt, wenn sich der Task im Zustand abgeschlossen befindet und ein Fehler aufgetreten ist.
lastRequeueTime	string	Der letzte Zeitpunkt, zu dem der Task durch den Batch-Dienst als Ergebnis einer Benutzeranforderung erneut in die Warteschlange gestellt wurde. Diese Eigenschaft wird nur festgelegt, wenn die RequeueCount nonzero ist.
lastRetryTime	string	Der letzte Zeitpunkt, zu dem eine Wiederholung des Tasks ausgeführt wurde. Dieses Element ist nur vorhanden, wenn der Task erneut ausgeführt wurde (d. h. retryCount ist nonzero). Falls vorhanden, ist dies in der Regel identisch mit startTime, kann sich jedoch unterscheiden, wenn der Task aus anderen Gründen als wiederholungsbedingt neu gestartet wurde. Wenn beispielsweise der Computeknoten während eines Wiederholungsversuchs neu gestartet wurde, wird startTime aktualisiert, lastRetryTime jedoch nicht.
requeueCount	integer	Gibt an, wie oft der Task vom Batch-Dienst als Ergebnis einer Benutzeranforderung zurückgefragt wurde. Wenn der Benutzer Computeknoten aus einem Pool entfernt (durch Ändern der Größe/Verkleinerung des Pools) oder wenn der Auftrag deaktiviert wird, kann der Benutzer angeben, dass ausgeführte Tasks auf den Computeknoten für die Ausführung erneut zurückgefragt werden. Mit dieser Anzahl wird nachverfolgt, wie oft die Aufgabe aus diesen Gründen erneut zurückgefragt wurde.
result	TaskExecutionResult	Das Ergebnis der Taskausführung. Wenn der Wert "failed" ist, finden Sie die Details des Fehlers in der failureInfo-Eigenschaft.
retryCount	integer	Die Anzahl der Wiederholungen des Vorgangs durch den Batch-Dienst. Aufgabenanwendungsfehler (Nicht-Null-Exitcode) werden wiederholt, Fehler bei der Vorverarbeitung (der Task konnte nicht ausgeführt werden) und Dateiuploadfehler werden nicht wiederholt. Der Batch-Dienst versucht den Vorgang bis zu dem durch die Einschränkungen angegebenen Grenzwert erneut.
startTime	string	Der Zeitpunkt, zu dem der Task ausgeführt wurde. "Ausführen" entspricht dem Ausführungszustand. Wenn der Task also Ressourcendateien oder Pakete angibt, gibt die Startzeit den Zeitpunkt an, zu dem der Task mit dem Herunterladen oder Bereitstellen dieser Dateien begonnen hat. Wenn der Task neu gestartet oder erneut ausgeführt wurde, ist dies der letzte Zeitpunkt, zu dem die Ausführung des Tasks gestartet wurde. Diese Eigenschaft ist nur für Aufgaben vorhanden, die sich im Status "Ausgeführt" oder "Abgeschlossen" befinden.

TaskExecutionResult

Das Ergebnis der Taskausführung.

Name	Typ	Beschreibung
failure	string	Während der Verarbeitung des Vorgangs ist ein Fehler aufgetreten. Der Fehler ist möglicherweise aufgetreten, bevor der Vorgangsprozess gestartet wurde, während der Vorgangsprozess ausgeführt wurde oder nachdem der Vorgangsprozess beendet wurde.
success	string	Der Task wurde erfolgreich ausgeführt.

TaskFailureInformation

Informationen zu einem Vorgangsfehler.

Name	Typ	Beschreibung
category	ErrorCategory	Die Kategorie des Vorgangsfehlers.
code	string	Ein Bezeichner für den Taskfehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
details	NameValuePair[]	Eine Liste mit zusätzlichen Details im Zusammenhang mit dem Fehler.
message	string	Eine Meldung, die den Vorgangsfehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

TaskIdRange

Ein Bereich von Aufgaben-IDs, von denen ein Task abhängig sein kann. Alle Tasks mit IDs im Bereich müssen erfolgreich abgeschlossen werden, bevor der abhängige Task geplant werden kann.

Name	Typ	Beschreibung
end	integer	Die letzte Aufgaben-ID im Bereich.
start	integer	Die erste Aufgaben-ID im Bereich.

TaskState

Der Status des Tasks.

Name	Typ	Beschreibung
active	string	Der Task befindet sich in einer Warteschlange und kann ausgeführt werden, ist aber derzeit keinem Computeknoten zugewiesen. Ein Task wechselt in diesen Zustand, wenn er erstellt wird, wenn er aktiviert ist, nachdem er deaktiviert wurde, oder wenn er nach einer fehlgeschlagenen Ausführung auf einen Wiederholungsversuch wartet.
completed	string	Der Task kann nicht mehr ausgeführt werden, in der Regel, weil der Vorgang erfolgreich abgeschlossen wurde oder der Task nicht erfolgreich abgeschlossen wurde und sein Wiederholungslimit erschöpft ist. Ein Task wird auch als abgeschlossen markiert, wenn ein Fehler beim Starten des Tasks aufgetreten ist oder wenn der Task beendet wurde.
preparing	string	Der Task wurde einem Computeknoten zugewiesen, wartet jedoch auf den Abschluss eines erforderlichen Auftragsvorbereitungstasks auf dem Computeknoten. Wenn der Auftragsvorbereitungstask erfolgreich ist, wird der Task zur Ausführung verschoben. Wenn der Auftragsvorbereitungstask fehlschlägt, wird der Task wieder aktiv und kann einem anderen Computeknoten zugewiesen werden.
running	string	Der Task wird auf einem Computeknoten ausgeführt. Dies schließt die Vorbereitung auf Aufgabenebene ein, z. B. das Herunterladen von Ressourcendateien oder das Bereitstellen von Paketen, die für den Task angegeben sind. Dies bedeutet nicht unbedingt, dass die Task-Befehlszeile mit der Ausführung begonnen hat.

TaskStatistics

Ressourcennutzungsstatistiken für einen Vorgang.

Name	Typ	Beschreibung
kernelCPUTime	string	Die gesamte CPU-Zeit im Kernelmodus (zusammengefasst über alle Kerne und alle Computeknoten), die vom Task verbraucht wird.
lastUpdateTime	string	Der Zeitpunkt, zu dem die Statistiken zuletzt aktualisiert wurden. Alle Statistiken sind auf den Bereich zwischen startTime und lastUpdateTime beschränkt.
readIOGiB	number	Die Gesamtanzahl von Gibibytes, die von der Aufgabe vom Datenträger gelesen werden.
readIOps	integer	Die Gesamtanzahl von Datenträgerlesevorgängen, die vom Task ausgeführt werden.
startTime	string	Die Startzeit des von der Statistik erfassten Zeitbereichs.
url	string	Die URL der Statistiken.
userCPUTime	string	Die gesamte CPU-Zeit des Benutzermodus (zusammengefasst über alle Kerne und alle Computeknoten), die vom Task verbraucht wird.
waitTime	string	Die Gesamtwartezeit der Aufgabe. Die Wartezeit für einen Task wird als die verstrichene Zeit zwischen der Erstellung des Vorgangs und dem Beginn der Taskausführung definiert. (Wenn der Vorgang aufgrund von Fehlern wiederholt wird, ist die Wartezeit die Zeit bis zur letzten Taskausführung.)
wallClockTime	string	Die gesamte Wanduhrzeit der Aufgabe. Die Wanduhrzeit ist die verstrichene Zeit von der Ausführung des Tasks auf einem Computeknoten bis zum Abschluss (oder bis zum letzten Zeitpunkt der Statistikaktualisierung, wenn die Aufgabe bis dahin noch nicht abgeschlossen war). Wenn der Vorgang erneut ausgeführt wurde, schließt dies die Wanduhrzeit aller Vorgangsversuche ein.
writeIOGiB	number	Die Gesamtanzahl von Gibibytes, die vom Task auf den Datenträger geschrieben wurden.
writeIOps	integer	Die Gesamtanzahl von Datenträgerschreibvorgängen, die vom Task ausgeführt werden.

UserIdentity

Die Definition der Benutzeridentität, unter der der Task ausgeführt wird.

Name	Typ	Beschreibung
autoUser	AutoUserSpecification	Der automatische Benutzer, unter dem der Task ausgeführt wird. Die Eigenschaften userName und autoUser schließen sich gegenseitig aus. Sie müssen eine angeben, aber nicht beide.
username	string	Der Name der Benutzeridentität, unter der der Task ausgeführt wird. Die Eigenschaften userName und autoUser schließen sich gegenseitig aus. Sie müssen eine angeben, aber nicht beide.