Task - List
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
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 |
---|---|---|---|---|
batch
|
path | True |
string |
Die Basis-URL für alle Azure Batch-Dienstanforderungen. |
job
|
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 |
Eine Antwort, die die Liste der Aufgaben enthält. Header
|
|
Other Status Codes |
Der Fehler vom Batch-Dienst. |
Sicherheit
azure_auth
Microsoft Entra OAuth 2.0-Authentifizierungscodeflow
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
GET account.region.batch.azure.com/jobs/jobId/tasks?api-version=2023-11-01.18.0
Beispiel für eine Antwort
{
"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 |
---|---|
Access |
Die Batch-Ressourcen, auf die das Token Zugriff gewährt. |
Affinity |
Ein Lokalitätshinweis, der vom Batch-Dienst verwendet werden kann, um einen Computeknoten auszuwählen, auf dem eine Aufgabe gestartet werden soll. |
Application |
Ein Verweis auf ein Paket, das auf Computeknoten bereitgestellt werden soll. |
Authentication |
Die Einstellungen für ein Authentifizierungstoken, das der Task zum Ausführen von Batch-Dienstvorgängen verwenden kann. |
Auto |
Der Bereich für den automatischen Benutzer |
Auto |
Gibt die Parameter für den automatischen Benutzer an, der einen Task im Batch-Dienst ausführt. |
Batch |
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort. |
Batch |
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind. |
Cloud |
Eine Azure Batch Aufgabe. |
Cloud |
Das Ergebnis der Auflistung der Aufgaben in einem Auftrag. |
Compute |
Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet. |
Compute |
Informationen zum Computeknoten, auf dem ein Task ausgeführt wurde. |
Container |
Eine private Containerregistrierung. |
Container |
Der Speicherort des Arbeitsverzeichnisses des Containertasks. |
Dependency |
Eine Aktion, die der Batch-Dienst für Aufgaben ausführt, die von diesem Task abhängen. |
Elevation |
Die Höhenstufe des Benutzers. |
Environment |
Eine Umgebungsvariable, die für einen Vorgangsvorgang festgelegt werden soll. |
Error |
Die Kategorie des Fehlers. |
Error |
Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird. |
Exit |
Wie der Batch-Dienst reagieren soll, wenn ein Task mit einem bestimmten Exitcode beendet wird. |
Exit |
Eine Reihe von Exitcodes und wie der Batch-Dienst auf Exitcodes innerhalb dieses Bereichs reagieren soll. |
Exit |
Gibt an, wie der Batch-Dienst reagieren soll, wenn die Aufgabe abgeschlossen ist. |
Exit |
Gibt an, wie der Batch-Dienst auf eine bestimmte Beendigungsbedingung reagiert. |
Http |
Ein Name-Wert-Paar für HTTP-Header |
Job |
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. |
Multi |
Einstellungen, die angeben, wie ein Task mit mehreren instance ausgeführt werden soll. |
Name |
Stellt ein Name-Wert-Paar dar. |
Output |
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. |
Output |
Gibt ein Dateiuploadziel in einem Azure Blob Storage-Container an. |
Output |
Das Ziel, in das eine Datei hochgeladen werden soll. |
Output |
Die Bedingungen, unter denen eine Taskausgabedatei oder eine Gruppe von Dateien hochgeladen werden soll. |
Output |
Details zu einem Ausgabedateiuploadvorgang, einschließlich der Bedingungen, unter welchen Bedingungen der Upload ausgeführt werden soll. |
Resource |
Eine einzelne Datei oder mehrere Dateien, die auf einen Computeknoten heruntergeladen werden sollen. |
Task |
Ausführungseinschränkungen, die auf einen Task angewendet werden sollen. |
Task |
Enthält Informationen zum Container, den ein Task ausführt. |
Task |
Die Containereinstellungen für einen Task. |
Task |
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. |
Task |
Informationen zur Ausführung einer Aufgabe. |
Task |
Das Ergebnis der Taskausführung. |
Task |
Informationen zu einem Vorgangsfehler. |
Task |
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. |
Task |
Der Status des Tasks. |
Task |
Ressourcennutzungsstatistiken für einen Vorgang. |
User |
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. |
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. |
version |
string |
Die Version der anwendung, die bereitgestellt werden soll. Wenn nicht angegeben, wird die Standardversion bereitgestellt. |
AuthenticationTokenSettings
Die Einstellungen für ein Authentifizierungstoken, das der Task zum Ausführen von Batch-Dienstvorgängen verwenden kann.
Name | Typ | Beschreibung |
---|---|---|
access |
Die Batch-Ressourcen, auf die das Token Zugriff gewährt. |
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 |
Die Höhenstufe des automatischen Benutzers. |
|
scope |
Der Bereich für den automatischen Benutzer |
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 |
Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
|
values |
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 |
Ein Lokalitätshinweis, der vom Batch-Dienst verwendet werden kann, um einen Computeknoten auszuwählen, auf dem der neue Task gestartet werden soll. |
|
applicationPackageReferences |
Eine Liste der Pakete, die der Batch-Dienst auf dem Computeknoten bereitstellt, bevor die Befehlszeile ausgeführt wird. |
|
authenticationTokenSettings |
Die Einstellungen für ein Authentifizierungstoken, das der Task zum Ausführen von Batch-Dienstvorgängen verwenden kann. |
|
commandLine |
string |
Die Befehlszeile der Aufgabe. |
constraints |
Die Ausführungseinschränkungen, die für diesen Task gelten. |
|
containerSettings |
Die Einstellungen für den Container, unter dem der Task ausgeführt wird. |
|
creationTime |
string |
Die Erstellungszeit der Aufgabe. |
dependsOn |
Die Aufgaben, von denen diese Aufgabe abhängt. |
|
displayName |
string |
Ein Anzeigename für den Task. |
eTag |
string |
Das ETag der Aufgabe. |
environmentSettings |
Eine Liste der Umgebungsvariableneinstellungen für den Task. |
|
executionInfo |
Informationen zur Ausführung der Aufgabe. |
|
exitConditions |
Gibt an, wie der Batch-Dienst reagieren soll, wenn die Aufgabe abgeschlossen ist. |
|
id |
string |
Eine Zeichenfolge, die die Aufgabe innerhalb des Auftrags eindeutig identifiziert. |
lastModified |
string |
Der Zeitpunkt der letzten Änderung des Vorgangs. |
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. |
|
nodeInfo |
Informationen zum Computeknoten, auf dem der Task ausgeführt wurde. |
|
outputFiles |
Eine Liste der Dateien, die der Batch-Dienst nach dem Ausführen der Befehlszeile aus dem Computeknoten hochlädt. |
|
previousState |
Der vorherige Status des Vorgangs. |
|
previousStateTransitionTime |
string |
Die Zeit, zu der der Vorgang in den vorherigen Zustand eingetreten ist. |
requiredSlots |
integer |
Die Anzahl der Planungsslots, die der Task zum Ausführen benötigt. |
resourceFiles |
Eine Liste der Dateien, die der Batch-Dienst vor dem Ausführen der Befehlszeile auf den Computeknoten lädt. |
|
state |
Der aktuelle Status der Aufgabe. |
|
stateTransitionTime |
string |
Der Zeitpunkt, zu dem der Vorgang in den aktuellen Zustand gelangt ist. |
stats |
Ressourcennutzungsstatistiken für den Task. |
|
url |
string |
Die URL der Aufgabe. |
userIdentity |
Die Benutzeridentität, unter der der Task ausgeführt wird. |
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 |
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 |
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. |
|
password |
string |
Das Kennwort für die Anmeldung beim Registrierungsserver. |
registryServer |
string |
Die Registrierungs-URL |
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 |
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 |
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 |
Wie der Batch-Dienst reagieren soll, wenn der Task mit einer Beendigungsbedingung fehlschlägt, die von keiner der anderen Eigenschaften abgedeckt ist. |
|
exitCodeRanges |
Eine Liste der Aufgabenausgangscodebereiche und wie der Batch-Dienst darauf reagieren soll. |
|
exitCodes |
Eine Liste der einzelnen Task-Exitcodes und wie der Batch-Dienst darauf reagieren soll. |
|
fileUploadError |
Wie der Batch-Dienst reagieren soll, wenn ein Dateiuploadfehler auftritt. |
|
preProcessingError |
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 |
Eine Aktion, die der Batch-Dienst für Aufgaben ausführt, die von dieser Aufgabe abhängen. |
|
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. |
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 |
Eine Liste der Dateien, die vom Batch-Dienst heruntergeladen werden, bevor die Koordinationsbefehlszeile ausgeführt wird. |
|
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. |
numberOfInstances |
integer |
Die Anzahl der für den Task erforderlichen Computeknoten. |
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 |
Das Ziel für die Ausgabedateien. |
|
filePattern |
string |
Ein Muster, das angibt, welche Dateien hochgeladen werden sollen. |
uploadOptions |
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. |
identityReference |
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. |
|
path |
string |
Das Zielblob oder virtuelle Verzeichnis im Azure Storage-Container. |
uploadHeaders |
Eine Liste von Name-Wert-Paaren für Header, die beim Hochladen von Ausgabedateien verwendet werden sollen |
OutputFileDestination
Das Ziel, in das eine Datei hochgeladen werden soll.
Name | Typ | Beschreibung |
---|---|---|
container |
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 |
Die Bedingungen, unter denen die Taskausgabedatei oder der Satz von Dateien hochgeladen werden soll. |
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. |
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. |
fileMode |
string |
Das Attribut des Dateiberechtigungsmodus im oktalen Format. |
filePath |
string |
Der Speicherort auf dem Computeknoten, in den die Datei(en) heruntergeladen werden sollen, relativ zum Arbeitsverzeichnis des Tasks. |
httpUrl |
string |
Die URL der herunterzuladenden Bilds. |
identityReference |
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. |
|
storageContainerUrl |
string |
Die URL des Blobcontainers in Azure Blob Storage. |
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. |
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. |
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. |
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. |
state |
string |
Der Status des Containers. |
TaskContainerSettings
Die Containereinstellungen für einen Task.
Name | Typ | Beschreibung |
---|---|---|
containerRunOptions |
string |
Zusätzliche Optionen für den Befehl container create. |
imageName |
string |
Das Image, das zum Erstellen des Containers verwendet werden soll, in dem der Task ausgeführt wird. |
registry |
Die private Registrierung, die das Containerimage enthält. |
|
workingDirectory |
Der Speicherort des Arbeitsverzeichnisses des Containertasks. |
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 |
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. |
TaskExecutionInformation
Informationen zur Ausführung einer Aufgabe.
Name | Typ | Beschreibung |
---|---|---|
containerInfo |
Informationen zum Container, unter dem der Task ausgeführt wird. |
|
endTime |
string |
Der Zeitpunkt, zu dem die Aufgabe abgeschlossen wurde. |
exitCode |
integer |
Der Exitcode des Programms, der in der Task-Befehlszeile angegeben ist. |
failureInfo |
Informationen, die den Vorgangsfehler beschreiben, falls vorhanden. |
|
lastRequeueTime |
string |
Der letzte Zeitpunkt, zu dem der Task durch den Batch-Dienst als Ergebnis einer Benutzeranforderung erneut in die Warteschlange gestellt wurde. |
lastRetryTime |
string |
Der letzte Zeitpunkt, zu dem eine Wiederholung des Tasks ausgeführt wurde. |
requeueCount |
integer |
Gibt an, wie oft der Task vom Batch-Dienst als Ergebnis einer Benutzeranforderung zurückgefragt wurde. |
result |
Das Ergebnis der Taskausführung. |
|
retryCount |
integer |
Die Anzahl der Wiederholungen des Vorgangs durch den Batch-Dienst. |
startTime |
string |
Der Zeitpunkt, zu dem der Task ausgeführt wurde. |
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 |
Die Kategorie des Vorgangsfehlers. |
|
code |
string |
Ein Bezeichner für den Taskfehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden. |
details |
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. |
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 |
Der automatische Benutzer, unter dem der Task ausgeführt wird. |
|
username |
string |
Der Name der Benutzeridentität, unter der der Task ausgeführt wird. |