Task - List

Dienst:

Batch Service

API-Version:

2024-07-01.20.0

Listet alle Vorgänge auf, die dem angegebenen Auftrag zugeordnet sind.
Informationen wie AffinityId, executionInfo und nodeInfo beziehen sich für Aufgaben mit mehreren Instanzen auf die primäre Aufgabe. Verwenden Sie die Listenteilvorgänge-API, um Informationen zu Teilvorgängen abzurufen.

GET {batchUrl}/jobs/{jobId}/tasks?api-version=2024-07-01.20.0

Mit optionalen Parametern:

GET {batchUrl}/jobs/{jobId}/tasks?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.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/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. Maximal 1000 Vorgänge können zurückgegeben werden.
timeout	query		integer int32	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Wenn der Wert größer als 30 ist, wird stattdessen der Standardwert verwendet.

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 Clientanforderungs-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. Header client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Der Fehler vom Batchdienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Authorization

Typ: apiKey
In: header

Beispiele

Task list

Beispielanforderung

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks?api-version=2024-07-01.20.0

Beispiel für eine Antwort

Statuscode:

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 Batchressourcen, auf die das Token Zugriff gewährt.
AffinityInformation	Ein Gebietsschemahinweis, der vom Batchdienst 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 von der Aufgabe zum Ausführen von Batchdienstvorgängen verwendet werden kann.
AutoUserScope	Der Bereich für den automatischen Benutzer
AutoUserSpecification	Gibt die Parameter für den automatischen Benutzer an, der eine Aufgabe im Batchdienst 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-Batchaufgabe.
CloudTaskListResult	Das Ergebnis der Auflistung der Aufgaben in einem Auftrag.
ComputeNodeIdentityReference	Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.
ComputeNodeInformation	Informationen zum Computeknoten, auf dem eine Aufgabe ausgeführt wurde.
ContainerHostBatchBindMountEntry	Der Eintrag des Pfad- und Bereitstellungsmodus, den Sie in Aufgabencontainer bereitstellen möchten.
ContainerHostDataPath	Die Pfade, die im Container der Containeraufgabe bereitgestellt werden.
ContainerRegistry	Eine private Containerregistrierung.
ContainerWorkingDirectory	Der Speicherort des Arbeitsverzeichnisses für containeraufgaben.
DependencyAction	Eine Aktion, die der Batchdienst für Aufgaben ausführt, die von dieser Aufgabe abhängig sind.
ElevationLevel	Die Höhe des Benutzers.
EnvironmentSetting	Eine Umgebungsvariable, die für einen Vorgangsprozess festgelegt werden soll.
ErrorCategory	Die Kategorie des Fehlers.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
ExitCodeMapping	Wie der Batchdienst reagieren soll, wenn eine Aufgabe mit einem bestimmten Beendigungscode beendet wird.
ExitCodeRangeMapping	Eine Reihe von Beendigungscodes und wie der Batchdienst auf Beendigungscodes innerhalb dieses Bereichs reagieren soll.
ExitConditions	Gibt an, wie der Batchdienst reagieren soll, wenn die Aufgabe abgeschlossen ist.
ExitOptions	Gibt an, wie der Batchdienst auf eine bestimmte Beendigungsbedingung reagiert.
HttpHeader	Ein HTTP-Headernamen-Wert-Paar
JobAction	Eine Aktion, die für den Auftrag ausgeführt werden soll, der die Aufgabe enthält, wenn die Aufgabe mit der angegebenen Beendigungsbedingung abgeschlossen wird und die OnTaskFailed-Eigenschaft "performExitOptionsJobAction" lautet.
MultiInstanceSettings	Einstellungen, die angeben, wie eine Aufgabe mit mehreren Instanzen ausgeführt werden soll.
NameValuePair	Stellt ein Name-Wert-Paar dar.
OutputFile	Eine Spezifikation zum Hochladen von Dateien von einem Azure Batch Compute Node an einen anderen Speicherort, nachdem der Batchdienst die Ausführung des Aufgabenvorgangs 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 Aufgabenausgabedatei oder eine Gruppe von Dateien hochgeladen werden soll.
OutputFileUploadOptions	Details zu einem Uploadvorgang einer Ausgabedatei, einschließlich der Bedingungen, unter denen der Upload ausgeführt werden soll.
ResourceFile	Eine einzelne Datei oder mehrere Dateien, die in einen Computeknoten heruntergeladen werden sollen.
TaskConstraints	Ausführungseinschränkungen, die auf einen Vorgang angewendet werden sollen.
TaskContainerExecutionInformation	Enthält Informationen zum Container, den eine Aufgabe ausführt.
TaskContainerSettings	Die Containereinstellungen für eine Aufgabe.
TaskDependencies	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.
TaskExecutionInformation	Informationen zur Ausführung einer Aufgabe.
TaskExecutionResult	Das Ergebnis der Aufgabenausführung.
TaskFailureInformation	Informationen zu einem Vorgangsfehler.
TaskIdRange	Ein Bereich von Vorgangs-IDs, von denen ein Vorgang abhängig sein kann. Alle Vorgänge mit IDs im Bereich müssen erfolgreich abgeschlossen werden, bevor der abhängige Vorgang geplant werden kann.
TaskState	Der Status des Vorgangs.
TaskStatistics	Ressourcennutzungsstatistiken für einen Vorgang.
UserIdentity	Die Definition der Benutzeridentität, unter der die Aufgabe ausgeführt wird.

AccessScope

Die Batchressourcen, auf die das Token Zugriff gewährt.

Name	Typ	Beschreibung
job	string	Gewährt Zugriff auf alle Vorgänge für den Auftrag, der die Aufgabe enthält.

AffinityInformation

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 Zeichenfolge, die die Position eines Computeknotens oder einer Zuvor ausgeführten Aufgabe darstellt. Sie können die Affinitäts-ID eines Knotens übergeben, um anzugeben, dass diese Aufgabe auf diesem Computeknoten 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.

ApplicationPackageReference

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

Name	Typ	Beschreibung
applicationId	string	Die ID der bereitzustellenden 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 für einen Pool nicht angegeben wird und für diese Anwendung keine Standardversion angegeben wird, schlägt die Anforderung mit dem Fehlercode InvalidApplicationPackageReferences und DEM HTTP-Statuscode 409 fehl. Wenn dies für eine Aufgabe nicht angegeben wird und für diese Anwendung keine Standardversion angegeben wird, schlägt die Aufgabe mit einem Vorverarbeitungsfehler fehl.

AuthenticationTokenSettings

Die Einstellungen für ein Authentifizierungstoken, das von der Aufgabe zum Ausführen von Batchdienstvorgängen verwendet werden kann.

Name	Typ	Beschreibung
access	AccessScope[]	Die Batchressourcen, auf die das Token Zugriff gewährt. Das Authentifizierungstoken gewährt Zugriff auf einen begrenzten Satz von Batchdienstvorgängen. Derzeit ist der einzige unterstützte Wert für die Access-Eigenschaft "auftrag", der Zugriff auf alle Vorgänge im Zusammenhang mit dem Auftrag gewährt, der die Aufgabe enthält.

AutoUserScope

Der Bereich für den automatischen Benutzer

Name	Typ	Beschreibung
pool	string	Gibt an, dass die Aufgabe 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 die Aufgabe erstellen soll.

AutoUserSpecification

Gibt die Parameter für den automatischen Benutzer an, der eine Aufgabe im Batchdienst 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 der Pool Windows ausführt, sollte ein Wert der Aufgabe angegeben werden, wenn eine strengere Isolierung zwischen Vorgängen erforderlich ist. Wenn die Aufgabe beispielsweise die Registrierung auf eine Weise stummschaltet, die sich auf andere Aufgaben auswirken könnte, oder wenn Zertifikate auf dem Pool angegeben wurden, auf die nicht durch normale Aufgaben zugegriffen werden sollte, aber von StartTasks zugänglich sein sollte.

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	ErrorMessage	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
values	BatchErrorDetail[]	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.

CloudTask

Eine Azure-Batchaufgabe.

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

CloudTaskListResult

Das Ergebnis der Auflistung der Aufgaben in einem Auftrag.

Name	Typ	Beschreibung
odata.nextLink	string	Die URL, um den nächsten Satz von Ergebnissen abzurufen.
value	CloudTask[]	Die Liste der Aufgaben.

ComputeNodeIdentityReference

Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.

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

ComputeNodeInformation

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

Name	Typ	Beschreibung
affinityId	string	Ein Bezeichner für den Knoten, auf dem die Aufgabe ausgeführt wurde, die beim Hinzufügen einer Aufgabe übergeben werden kann, um anzufordern, dass die Aufgabe auf diesem Computeknoten geplant wird.
nodeId	string	Die ID des Computeknotens, auf dem die Aufgabe ausgeführt wurde.
nodeUrl	string	Die URL des Computeknotens, auf dem die Aufgabe ausgeführt wurde.
poolId	string	Die ID des Pools, auf dem die Aufgabe ausgeführt wurde.
taskRootDirectory	string	Das Stammverzeichnis der Aufgabe auf dem Computeknoten.
taskRootDirectoryUrl	string	Die URL zum Stammverzeichnis der Aufgabe auf dem Computeknoten.

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	ContainerHostDataPath	Der Pfad, der für containerkunden bereitgestellt werden kann.

ContainerHostDataPath

Die Pfade, die im Container der Containeraufgabe bereitgestellt werden.

Name	Typ	Beschreibung
Applications	string	Der Anwendungspfad.
JobPrep	string	Der Auftragsvorstellungsvorgangspfad.
Shared	string	Der Pfad für die Aufgabe mit mehreren Instanzen, um ihre Dateien freigegeben zu haben.
Startup	string	Der Pfad für die Startaufgabe.
Task	string	Der Vorgangspfad.
VfsMounts	string	Der Pfad enthält alle virtuellen Dateisysteme, die auf diesem Knoten bereitgestellt werden.

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-Containerregistrierung anstelle von Benutzername und Kennwort verwendet werden soll. Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool 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, der sich beim Registrierungsserver anmeldet.

ContainerWorkingDirectory

Der Speicherort des Arbeitsverzeichnisses für containeraufgaben.

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 "Batchdienstaufgaben", das die Vorgangsressourcendateien enthält, die von Batch aufgefüllt werden.

DependencyAction

Eine Aktion, die der Batchdienst für Aufgaben ausführt, die von dieser Aufgabe abhängig sind.

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

ElevationLevel

Die Höhe 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 Vorgangsprozess festgelegt werden soll.

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

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 wurde.

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

ExitCodeMapping

Wie der Batchdienst reagieren soll, wenn eine Aufgabe mit einem bestimmten Beendigungscode beendet wird.

Name	Typ	Beschreibung
code	integer	Ein Prozessausgangscode.
exitOptions	ExitOptions	Wie der Batchdienst reagieren soll, wenn der Vorgang mit diesem Beendigungscode beendet wird.

ExitCodeRangeMapping

Eine Reihe von Beendigungscodes und wie der Batchdienst auf Beendigungscodes innerhalb dieses Bereichs reagieren soll.

Name	Typ	Beschreibung
end	integer	Der letzte Ausgangscode im Bereich.
exitOptions	ExitOptions	Wie der Batchdienst reagieren soll, wenn der Vorgang mit einem Ausgangscode im Bereich endet (einschließlich).
start	integer	Der erste Ausgangscode im Bereich.

ExitConditions

Gibt an, wie der Batchdienst reagieren soll, wenn die Aufgabe abgeschlossen ist.

Name	Typ	Beschreibung
default	ExitOptions	Wie der Batchdienst reagieren soll, wenn der Vorgang mit einer Beendigungsbedingung fehlschlägt, die von keiner der anderen Eigenschaften abgedeckt wird. Dieser Wert wird verwendet, wenn der Task mit einem nichtzero-Beendigungscode 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 beim Beenden von Code 0 wünschen, müssen Sie es explizit mithilfe der exitCodes- oder exitCodeRanges-Auflistung auflisten.
exitCodeRanges	ExitCodeRangeMapping[]	Eine Liste der Aufgabenausgangscodebereiche und wie der Batchdienst darauf reagieren soll.
exitCodes	ExitCodeMapping[]	Eine Liste der einzelnen Aufgabenendecodes und derEn Reaktion des Batchdiensts.
fileUploadError	ExitOptions	Wie der Batchdienst reagieren soll, wenn ein Dateiuploadfehler auftritt. Wenn die Aufgabe mit einem Exitcode beendet wurde, der über exitCodes oder exitCodeRanges angegeben wurde und dann einen Dateiuploadfehler aufgetreten ist, hat die durch den Beendigungscode angegebene Aktion Vorrang.
preProcessingError	ExitOptions	Wie der Batchdienst reagieren soll, wenn die Aufgabe aufgrund eines Fehlers nicht gestartet werden kann.

ExitOptions

Gibt an, wie der Batchdienst auf eine bestimmte Beendigungsbedingung reagiert.

Name	Typ	Beschreibung
dependencyAction	DependencyAction	Eine Aktion, die der Batchdienst für Aufgaben ausführt, die von dieser Aufgabe abhängig sind. Mögliche Werte sind "erfüllen" (sodass abhängige Vorgänge ausgeführt werden können) und "Blockieren" (abhängige Vorgänge warten weiterhin). Batch unterstützt den Abbruch abhängiger Vorgänge noch nicht.
jobAction	JobAction	Eine Aktion, die für den Auftrag ausgeführt werden soll, der die Aufgabe enthält, wenn die Aufgabe mit der angegebenen Beendigungsbedingung abgeschlossen wird und die OnTaskFailed-Eigenschaft "performExitOptionsJobAction" lautet. Der Standardwert ist keine für Exitcode 0 und wird für alle anderen Beendigungsbedingungen beendet. Wenn die "onTaskFailed"-Eigenschaft des Auftrags keine Aktion ist, gibt die Angabe dieser Eigenschaft einen Fehler zurück, und die Add-Task-Anforderung schlägt mit einem ungültigen Eigenschaftswertfehler fehl. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).

HttpHeader

Ein HTTP-Headernamen-Wert-Paar

Name	Typ	Beschreibung
name	string	Der Name der Kopfzeile, die beim Hochladen von Ausgabedateien verwendet werden soll, wobei die Groß-/Kleinschreibung nicht beachtet wird.
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 die Aufgabe enthält, wenn die Aufgabe mit der angegebenen Beendigungsbedingung abgeschlossen wird und die OnTaskFailed-Eigenschaft "performExitOptionsJobAction" lautet.

Name	Typ	Beschreibung
disable	string	Deaktivieren Sie den Auftrag. Dies entspricht dem Aufrufen der Deaktivierungsauftrags-API mit einem disableTasks-Wert von "requeue".
none	string	Ergreifen Sie keine Aktion.
terminate	string	Beenden Sie den Auftrag. Der terminateReason in der Ausführungsinfo des Auftrags wird auf "TaskFailed" festgelegt.

MultiInstanceSettings

Einstellungen, die angeben, wie eine Aufgabe mit mehreren Instanzen ausgeführt werden soll.

Name	Typ	Beschreibung
commonResourceFiles	ResourceFile[]	Eine Liste der Dateien, die der Batchdienst herunterladen wird, bevor die Koordinationsbefehlszeile ausgeführt wird. Der Unterschied zwischen allgemeinen Ressourcendateien und Vorgangsressourcendateien besteht darin, dass allgemeine Ressourcendateien für alle Teilvorgänge einschließlich der primären Vorgänge heruntergeladen werden, während Vorgangsressourcendateien nur für die primäre Datei heruntergeladen werden. Beachten Sie außerdem, dass diese Ressourcendateien nicht in das Arbeitsverzeichnis "Vorgang" heruntergeladen werden, sondern stattdessen in das Stammverzeichnis "Task" (ein Verzeichnis über dem Arbeitsverzeichnis) 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". 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 Befehlszeile, die auf allen Computeknoten ausgeführt werden soll, damit sie koordiniert werden können, wenn die primäre Aufgabe ausgeführt wird. Eine typische Koordinations-Befehlszeile startet einen Hintergrunddienst und überprüft, ob der Dienst bereit ist, Knotenübergreifende Nachrichten zu verarbeiten.
numberOfInstances	integer	Die Anzahl der Computeknoten, die für den Vorgang erforderlich sind. 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 von einem Azure Batch Compute Node an einen anderen Speicherort, nachdem der Batchdienst die Ausführung des Aufgabenvorgangs abgeschlossen hat.

Name	Typ	Beschreibung
destination	OutputFileDestination	Das Ziel für die Ausgabedatei(n).
filePattern	string	Ein Muster, das angibt, welche Datei(en) hochgeladen werden soll. Sowohl relative als auch absolute Pfade werden unterstützt. Relative Pfade sind relativ zum Arbeitsverzeichnis "Aufgabe". Die folgenden Wildcards werden unterstützt: * entspricht 0 oder mehr Zeichen (z. B. Muster abc* würde abc oder abcdef entsprechen), ** entspricht einem verzeichnis, ? entspricht einem einzelnen Zeichen, [abc] entspricht einem Zeichen in den Klammern, und [a-c] entspricht einem Zeichen im Bereich. Klammern können eine Negation enthalten, um einem zeichen nicht angegebenen Zeichen zu entsprechen (z. B. [!abc] entspricht einem beliebigen Zeichen, aber a, b oder c). Wenn ein Dateiname mit "." beginnt, wird er standardmäßig ignoriert, kann aber durch explizite Angabe übereinstimmen (z. B. .gif stimmt nicht mit .a.gifüberein, 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 Wildcardzeichen enthält, kann es mithilfe von Klammern escapet werden (z. B. abc[] entspricht einer Datei namens abc). Beachten Sie, dass sowohl \ als auch / werden als Verzeichnistrennzeichen unter Windows behandelt, aber nur / ist unter Linux. Umgebungsvariablen (%var% unter Windows oder $var unter Linux) werden vor der Anwendung des Musters erweitert.
uploadOptions	OutputFileUploadOptions	Zusätzliche Optionen für den Uploadvorgang, einschließlich der Bedingungen, unter denen 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 Datei(en) hochgeladen werden soll. Wenn keine verwaltete Identität verwendet wird, muss die URL eine SAS (Shared Access Signature) enthalten, die Schreibberechtigungen für den Container gewährt.
identityReference	ComputeNodeIdentityReference	Der Verweis auf die vom Benutzer zugewiesene Identität für den Zugriff auf Azure Blob Storage, der durch containerUrl angegeben wird Die Identität muss Schreibzugriff auf den Azure Blob Storage-Container haben.
path	string	Das Ziel-BLOB oder virtuelle Verzeichnis im Azure Storage-Container. Wenn filePattern auf eine bestimmte Datei verweist (d. h. keine Wildcards enthält), ist der Pfad 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 der Pfad der Name des virtuellen Blob-Verzeichnisses (das jedem Blobnamen vorangestellt ist), in den die Datei(n) hochgeladen werden soll. Wenn sie weggelassen werden, werden Die Dateien in das Stammverzeichnis des Containers hochgeladen, wobei ein BLOB-Name mit ihrem Dateinamen übereinstimmen soll.
uploadHeaders	HttpHeader[]	Eine Liste von Namen-Wert-Paaren für Kopfzeilen, die beim Hochladen von Ausgabedateien verwendet werden sollen Diese Header werden beim Hochladen von Dateien in Azure Storage angegeben. Offizielles Dokument für zulässige Kopfzeilen beim Hochladen von Blobs: https://docs.microsoft.com/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 im Azure Blob Storage, in den Dateien hochgeladen werden.

OutputFileUploadCondition

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

Name	Typ	Beschreibung
taskcompletion	string	Laden Sie die Dateien nach dem Beenden des Aufgabenvorgangs hoch, unabhängig davon, was der Ausgangscode war.
taskfailure	string	Laden Sie die Datei(n) erst hoch, nachdem der Vorgangsvorgang mit einem Nichtzero-Ausgangscode beendet wurde.
tasksuccess	string	Laden Sie die Datei(n) erst hoch, nachdem der Vorgangsvorgang mit einem Exitcode von 0 beendet wurde.

OutputFileUploadOptions

Details zu einem Uploadvorgang einer Ausgabedatei, einschließlich der Bedingungen, unter denen der Upload ausgeführt werden soll.

Name	Typ	Beschreibung
uploadCondition	OutputFileUploadCondition	Die Bedingungen, unter denen die Task-Ausgabedatei oder -gruppe von Dateien hochgeladen werden soll. Der Standardwert ist "taskcompletion".

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-Computeknoten heruntergeladen werden. Sie wird ignoriert, wenn sie für eine resourceFile angegeben wird, die in einen Windows Compute Node heruntergeladen wird. Wenn diese Eigenschaft für einen Linux-Computeknoten nicht angegeben ist, wird auf die Datei ein Standardwert von 0770 angewendet.
filePath	string	Der Speicherort auf dem Computeknoten, in den die Datei(n) heruntergeladen werden soll, relativ zum Arbeitsverzeichnis der Aufgabe. 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 des Vorgangs (z. B. mithilfe von '.') herausbrechen.
httpUrl	string	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	ComputeNodeIdentityReference	Der Verweis auf die vom Benutzer zugewiesene Identität für den Zugriff auf Azure Blob Storage, der durch "storageContainerUrl" oder "httpUrl" angegeben wird Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool 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: 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.

TaskConstraints

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

Name	Typ	Beschreibung
maxTaskRetryCount	integer	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 die Anzahl der Wiederholungen für die ausführbare Aufgabe aufgrund eines Nichtzero-Beendigungscodes 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 Wiederholungsanzahl 0 ist, versucht der Batchdienst den Vorgang 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	Die maximale verstrichene Zeit, die der Vorgang ausführen kann, gemessen von dem Zeitpunkt, zu dem der Vorgang gestartet wird. Wenn der Vorgang nicht innerhalb des Zeitlimits abgeschlossen wird, beendet der Batchdienst ihn. Wenn dies nicht angegeben ist, gibt es kein Zeitlimit für die Dauer der Ausführung des Vorgangs.
retentionTime	string	Die minimale Zeit, um das Aufgabenverzeichnis auf dem Computeknoten beizubehalten, in dem er ausgeführt wurde, ab dem Zeitpunkt, zu dem die Ausführung abgeschlossen ist. Nach diesem Zeitpunkt kann der Batchdienst das Aufgabenverzeichnis und alle zugehörigen Inhalte 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 eine Aufgabe ausführt.

Name	Typ	Beschreibung
containerId	string	Die ID des Containers.
error	string	Detaillierte Fehlerinformationen zum Container. Dies ist die detaillierte Fehlerzeichenfolge des Docker-Diensts, falls verfügbar. Es entspricht dem fehlerfeld, das von "docker inspect" zurückgegeben wird.
state	string	Der Status des Containers. Dies ist der Status des Containers gemäß dem Docker-Dienst. Es entspricht dem Statusfeld, das von "docker inspect" zurückgegeben wird.

TaskContainerSettings

Die Containereinstellungen für eine Aufgabe.

Name	Typ	Beschreibung
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	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 zum Erstellen des Containers verwendet werden soll, in dem die Aufgabe ausgeführt wird. Dies ist der vollständige Imageverweis, wie für "Docker Pull" angegeben. Wenn kein Tag als Teil des Bildnamens 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 sie bereits bei der Poolerstellung bereitgestellt wurde.
workingDirectory	ContainerWorkingDirectory	Der Speicherort des Arbeitsverzeichnisses für containeraufgaben. Der Standardwert ist "taskWorkingDirectory".

TaskDependencies

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	TaskIdRange[]	Die Liste der Aufgaben-ID-Bereiche, von denen dieser Vorgang abhängt. Alle Vorgänge in allen Bereichen müssen erfolgreich abgeschlossen werden, bevor der abhängige Vorgang geplant werden kann.
taskIds	string[]	Die Liste der Aufgaben-IDs, von denen diese Aufgabe abhängt. Alle Vorgänge in dieser Liste müssen erfolgreich abgeschlossen werden, bevor der abhängige Vorgang geplant werden kann. Die TaskIds-Auflistung ist auf 64000 Zeichen beschränkt (d. h. die kombinierte Länge aller Vorgangs-IDs). Wenn die taskIds-Auflistung die maximale Länge überschreitet, schlägt die Add-Task-Anforderung 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 die Aufgabe ausgeführt wird. Diese Eigenschaft wird nur festgelegt, wenn die Aufgabe in einem Containerkontext ausgeführt wird.
endTime	string	Der Zeitpunkt, zu dem die Aufgabe abgeschlossen wurde. Diese Eigenschaft wird nur festgelegt, wenn sich der Vorgang im Status "Abgeschlossen" befindet.
exitCode	integer	Der Exitcode des Programms, das in der Befehlszeile "Aufgabe" angegeben ist. Diese Eigenschaft wird nur festgelegt, wenn sich der Vorgang im abgeschlossenen Zustand befindet. Im Allgemeinen spiegelt der Exitcode für einen Prozess die spezifische Konvention wider, die vom Anwendungsentwickler für diesen Prozess implementiert wird. Wenn Sie den Exit-Codewert verwenden, um Entscheidungen in Ihrem Code zu treffen, stellen Sie sicher, dass Sie die vom Anwendungsprozess verwendete Exit-Codekonvention kennen. Wenn der Batchdienst die Aufgabe (aufgrund eines Timeouts oder einer Benutzerendung über die API) beendet, wird möglicherweise ein vom Betriebssystem definierter Beendigungscode angezeigt.
failureInfo	TaskFailureInformation	Informationen zur Beschreibung des Vorgangsfehlers, falls vorhanden. Diese Eigenschaft wird nur festgelegt, wenn sich der Vorgang im Abgeschlossenen Zustand befindet und ein Fehler aufgetreten ist.
lastRequeueTime	string	Die letzte Zeit, zu der die Aufgabe vom Batchdienst als Ergebnis einer Benutzeranforderung erneut abgefragt wurde. Diese Eigenschaft wird nur festgelegt, wenn "requeueCount" nicht "nonzero" ist.
lastRetryTime	string	Die letzte Zeit, zu der ein Wiederholungsversuche der Aufgabe gestartet wurde. Dieses Element ist nur vorhanden, wenn der Vorgang erneut überprüft wurde (d. h. "retryCount" ist "nonzero"). Wenn vorhanden, ist dies in der Regel identisch mit startTime, kann jedoch anders sein, wenn die Aufgabe aus anderen Gründen als der Wiederholung neu gestartet wurde. Wenn beispielsweise der Computeknoten während eines Wiederholungsversuchs neu gestartet wurde, wird die startTime aktualisiert, aber die letzteRetryTime nicht.
requeueCount	integer	Die Häufigkeit, mit der die Aufgabe vom Batchdienst als Ergebnis einer Benutzeranforderung erneut abgefragt 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 die Ausführung von Aufgaben auf den Computeknoten zur Ausführung erneut abgefragt wird. Diese Anzahl verfolgt, wie oft der Vorgang aus diesen Gründen erneut abgefragt wurde.
result	TaskExecutionResult	Das Ergebnis der Aufgabenausführung. Wenn der Wert "failed" ist, werden die Details des Fehlers in der failureInfo-Eigenschaft gefunden.
retryCount	integer	Die Anzahl der Wiederholungen des Vorgangs durch den Batchdienst. Vorgangsanwendungsfehler (Nicht-Null-Beendigungscode) werden wiederholt, Vorverarbeitungsfehler (die Aufgabe konnte nicht ausgeführt werden) und Dateiuploadfehler werden nicht wiederholt. Der Batchdienst versucht den Vorgang bis zum durch die Einschränkungen angegebenen Grenzwert erneut.
startTime	string	Der Zeitpunkt, zu dem die Aufgabe gestartet wurde. "Ausführen" entspricht dem Ausführungszustand. Wenn der Vorgang also Ressourcendateien oder Pakete angibt, gibt die Startzeit den Zeitpunkt an, zu dem der Vorgang gestartet hat, diese herunterzuladen oder bereitzustellen. Wenn die Aufgabe neu gestartet oder erneut ausgeführt wurde, ist dies der letzte Zeitpunkt, zu dem die Aufgabe gestartet wurde. Diese Eigenschaft ist nur für Aufgaben vorhanden, die sich im Zustand "Ausführen" oder "Abgeschlossen" befinden.

TaskExecutionResult

Das Ergebnis der Aufgabenausführung.

Name	Typ	Beschreibung
failure	string	Fehler bei der Verarbeitung des Vorgangs. Möglicherweise ist der Fehler aufgetreten, bevor der Vorgangsprozess gestartet wurde, während der Aufgabenprozess ausgeführt wurde oder nachdem der Aufgabenvorgang beendet wurde.
success	string	Die Aufgabe 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 Vorgangsfehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	NameValuePair[]	Eine Liste mit zusätzlichen Details im Zusammenhang mit dem Fehler.
message	string	Eine Meldung zur Beschreibung des Vorgangsfehlers, die für die Anzeige in einer Benutzeroberfläche geeignet ist.

TaskIdRange

Ein Bereich von Vorgangs-IDs, von denen ein Vorgang abhängig sein kann. Alle Vorgänge mit IDs im Bereich müssen erfolgreich abgeschlossen werden, bevor der abhängige Vorgang geplant werden kann.

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

TaskState

Der Status des Vorgangs.

Name	Typ	Beschreibung
active	string	Die Aufgabe ist in die Warteschlange eingereiht und kann ausgeführt werden, ist jedoch derzeit keinem Computeknoten zugewiesen. Eine Aufgabe gibt diesen Zustand ein, wenn sie erstellt wird, wenn sie aktiviert ist, nachdem sie deaktiviert wurde, oder wenn sie auf einen Wiederholungsvorgang nach einer fehlgeschlagenen Ausführung wartet.
completed	string	Der Vorgang kann nicht mehr ausgeführt werden, in der Regel weil der Vorgang erfolgreich abgeschlossen wurde oder der Vorgang nicht erfolgreich abgeschlossen wurde und den Wiederholungsgrenzwert erschöpft hat. Eine Aufgabe wird auch als abgeschlossen markiert, wenn beim Starten der Aufgabe ein Fehler aufgetreten ist oder wenn die Aufgabe beendet wurde.
preparing	string	Die Aufgabe wurde einem Computeknoten zugewiesen, wartet jedoch auf eine erforderliche Auftragsvorbereitungsaufgabe auf den Computeknoten. Wenn der Auftragsvorbereitungsvorgang erfolgreich ist, wird der Vorgang in die Ausführung verschoben. Wenn der Auftragsvorbereitungsvorgang fehlschlägt, kehrt der Vorgang wieder zu "Aktiv" zurück und kann einem anderen Computeknoten zugewiesen werden.
running	string	Die Aufgabe wird auf einem Computeknoten ausgeführt. Dies umfasst die Vorbereitung auf Vorgangsebene, z. B. das Herunterladen von Ressourcendateien oder die Bereitstellung von Paketen, die für den Vorgang angegeben sind. Dies bedeutet nicht unbedingt, dass die Befehlszeile "Aufgabe" mit der Ausführung begonnen hat.

TaskStatistics

Ressourcennutzungsstatistiken für einen Vorgang.

Name	Typ	Beschreibung
kernelCPUTime	string	Die cpu-Gesamtzeit des Kernelmodus (summiert über alle Kerne und alle Computeknoten), die von der Aufgabe verbraucht werden.
lastUpdateTime	string	Die Uhrzeit, zu der die Statistiken zuletzt aktualisiert wurden. Alle Statistiken sind auf den Bereich zwischen startTime und lastUpdateTime beschränkt.
readIOGiB	number	Die gesamt gibibytes, die vom Datenträger des Vorgangs gelesen werden.
readIOps	integer	Die Gesamtzahl der Vom Vorgang vorgenommenen Datenträgerlesevorgänge.
startTime	string	Die Startzeit des zeitraums, der von den Statistiken abgedeckt wird.
url	string	Die URL der Statistik.
userCPUTime	string	Die cpu-Gesamtzeit des Benutzermodus (summiert über alle Kerne und alle Computeknoten), die von der Aufgabe verbraucht werden.
waitTime	string	Die Gesamtwartezeit des Vorgangs. Die Wartezeit für einen Vorgang wird als verstrichene Zeit zwischen der Erstellung der Aufgabe und dem Beginn der Aufgabenausführung definiert. (Wenn die Aufgabe aufgrund von Fehlern erneut versucht wird, ist die Wartezeit die Zeit für die letzte Ausführung der Aufgabe.)
wallClockTime	string	Die Gesamtwanduhrzeit des Vorgangs. Die Zeit der Wanduhr ist die verstrichene Zeit, ab der die Aufgabe auf einem Computeknoten ausgeführt wurde, bis zu dem sie abgeschlossen wurde (oder bis zum letzten Mal, wenn die Statistik aktualisiert wurde, wenn die Aufgabe dann nicht beendet wurde). Wenn der Vorgang erneut ausgeführt wurde, umfasst dies die Wanduhrzeit aller Vorgangsversuche.
writeIOGiB	number	Die gesamt gibibytes, die vom Vorgang auf den Datenträger geschrieben wurden.
writeIOps	integer	Die Gesamtzahl der Vom Vorgang vorgenommenen Datenträgerschreibvorgänge.

UserIdentity

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

Name	Typ	Beschreibung
autoUser	AutoUserSpecification	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.