Task - Get
Ruft Informationen zum angegebenen Task ab.
Informationen wie affinityId, executionInfo und nodeInfo finden Sie bei Aufgaben mit mehreren instance auf den primären Task. Verwenden Sie die Listenuntertasks-API, um Informationen zu Teilvorgängen abzurufen.
GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2023-11-01.18.0
GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?$select={$select}&$expand={$expand}&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, der den Task enthält. |
task
|
path | True |
string |
Die ID der Aufgabe, zu der Informationen abgerufen werden sollen. |
api-version
|
query | True |
string |
Client-API-Version. |
$expand
|
query |
string |
Eine OData $expand-Klausel. |
|
$select
|
query |
string |
Eine OData $select-Klausel. |
|
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 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. explizit festlegen, wenn Sie die REST-API direkt aufrufen. |
|
If-Match |
string |
Ein ETag-Wert, der der Version der Ressource zugeordnet ist, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn das aktuelle ETag der Ressource für den Dienst genau dem vom Client angegebenen Wert entspricht. |
|
If-None-Match |
string |
Ein ETag-Wert, der der Version der Ressource zugeordnet ist, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn das aktuelle ETag der Ressource für den Dienst nicht mit dem vom Client angegebenen Wert übereinstimmt. |
|
If-Modified-Since |
string date-time-rfc1123 |
Ein Zeitstempel, der den Zeitpunkt der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource im Dienst seit der angegebenen Zeit geändert wurde. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
Ein Zeitstempel, der den Zeitpunkt der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource im Dienst seit der angegebenen Zeit nicht mehr geändert wurde. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Eine Antwort, die den Task 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 get
Beispielanforderung
GET account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2023-11-01.18.0
Beispiel für eine Antwort
{
"id": "testTask",
"url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId",
"eTag": "0x8D3D62350711C55",
"creationTime": "2016-09-06T06:59:15.1161429Z",
"lastModified": "2016-09-06T06:59:15.1161429Z",
"state": "active",
"stateTransitionTime": "2016-09-06T06:59:15.1161429Z",
"commandLine": "cmd /c hostname",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"multiInstanceSettings": {
"numberOfInstances": 3,
"coordinationCommandLine": "cmd /c echo coordinating"
},
"constraints": {
"maxWallClockTime": "P10675199DT2H48M5.4775807S",
"retentionTime": "P10675199DT2H48M5.4775807S",
"maxTaskRetryCount": 0
},
"requiredSlots": 2,
"executionInfo": {
"retryCount": 0,
"requeueCount": 0
}
}
Definitionen
Name | Beschreibung |
---|---|
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 |
Ein Azure Batch Task. |
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 Aufgabenarbeitsverzeichnisses des Containers. |
Dependency |
Eine Aktion, die der Batch-Dienst für Aufgaben ausführt, die von dieser Aufgabe abhängen. |
Elevation |
Die Höhenebene 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 wurde. |
Exit |
Wie der Batch-Dienst reagieren soll, wenn eine Aufgabe 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 der Task abgeschlossen ist. |
Exit |
Gibt an, wie der Batch-Dienst auf eine bestimmte Beendigungsbedingung reagiert. |
Http |
Ein HTTP-Header-Name-Wert-Paar |
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 Vorgang zum Hochladen einer Ausgabedatei, 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. Jeder Task, der explizit angegeben ist oder innerhalb eines Abhängigkeitsbereichs liegt, muss abgeschlossen werden, bevor der abhängige Task geplant wird. |
Task |
Informationen zur Ausführung einer Aufgabe. |
Task |
Das Ergebnis der Aufgabenausführung. |
Task |
Informationen zu einem Vorgangsfehler. |
Task |
Eine Reihe von Aufgaben-IDs, von denen eine Aufgabe abhängig sein kann. Alle Aufgaben 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 Task. |
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 auf alle Vorgänge für den Auftrag, 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 bereitzustellenden Anwendung. |
version |
string |
Die Version der bereitzustellenden Anwendung. Wenn sie nicht angegeben wird, 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, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
|
values |
Eine Auflistung von Schlüssel-Wert-Paaren mit zusätzlichen Details zum Fehler. |
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
Ein Azure Batch Task.
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 vom Batch-Dienst auf dem Computeknoten bereitgestellt werden, 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 des Tasks. |
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 des Vorgangs. |
dependsOn |
Die Aufgaben, von denen dieser Task 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 des Tasks. |
|
exitConditions |
Gibt an, wie der Batch-Dienst reagieren soll, wenn der Task abgeschlossen ist. |
|
id |
string |
Eine Zeichenfolge, die den Task innerhalb des Auftrags eindeutig identifiziert. |
lastModified |
string |
Der Zeitpunkt der letzten Änderung des Vorgangs. |
multiInstanceSettings |
Ein -Objekt, das angibt, dass es sich bei der Aufgabe um einen Task mit mehreren instance handelt, und das Informationen zum Ausführen des Multi-instance-Tasks 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 vom Computeknoten hochlädt. |
|
previousState |
Der vorherige Status des Vorgangs. |
|
previousStateTransitionTime |
string |
Der Zeitpunkt, zu dem der Vorgang in den vorherigen Zustand versetzt wurde. |
requiredSlots |
integer |
Die Anzahl der Zeitplanungsslots, die für die Ausführung des Tasks erforderlich sind. |
resourceFiles |
Eine Liste der Dateien, die vom Batch-Dienst auf den Computeknoten heruntergeladen werden, bevor die Befehlszeile ausgeführt wird. |
|
state |
Der aktuelle Status des Vorgangs. |
|
stateTransitionTime |
string |
Der Zeitpunkt, zu dem der Task in seinen 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. |
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 vom Benutzer 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 eine Aufgabe 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 der Aufgabe 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, der beim Registrierungsserver angemeldet werden soll. |
ContainerWorkingDirectory
Der Speicherort des Aufgabenarbeitsverzeichnisses des Containers.
Name | Typ | Beschreibung |
---|---|---|
containerImageDefault |
string |
Verwenden Sie das im Containerimage definierte Arbeitsverzeichnis. Beachten Sie, dass dieses Verzeichnis nicht die von Batch heruntergeladenen Ressourcendateien enthält. |
taskWorkingDirectory |
string |
Verwenden Sie das Standardmäßige Batch-Dienstarbeitsverzeichnis Task, 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 dieser Aufgabe abhängen.
Name | Typ | Beschreibung |
---|---|---|
block |
string |
Blockiert Aufgaben, die auf diese Aufgabe warten, und verhindert, dass sie geplant werden. |
satisfy |
string |
Aufgaben erfüllen, die auf diese Aufgabe warten; Sobald alle Abhängigkeiten erfüllt sind, wird die Ausführung der Aufgabe geplant. |
ElevationLevel
Die Höhenebene 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 falsche Konfiguration. |
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 Meldung. |
ExitCodeMapping
Wie der Batch-Dienst reagieren soll, wenn eine Aufgabe 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 von Anfang bis Ende (inklusive) beendet wird. |
|
start |
integer |
Der erste Exitcode im Bereich. |
ExitConditions
Gibt an, wie der Batch-Dienst reagieren soll, wenn der Task 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 Aufgabenausgangscodes 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 diesem Task 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 HTTP-Header-Name-Wert-Paar
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Name des Headers, der 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 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 Aufrufen der API zum Deaktivieren von Aufträgen mit dem wert disableTasks requeue. |
none |
string |
Ergreifen Sie keine Aktion. |
terminate |
string |
Beenden Sie den Auftrag. Der 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 diese koordiniert werden können, wenn der primäre Befehl den befehl Standard Task ausführt. |
numberOfInstances |
integer |
Die Anzahl von Computeknoten, die für den Task erforderlich sind. |
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 Datei(en) hochgeladen werden soll. |
identityReference |
Der Verweis auf die benutzerseitig 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 das virtuelle Verzeichnis innerhalb des Azure Storage-Containers. |
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, in 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 Datei(en) nach Dem Beenden des Vorgangs hoch, unabhängig davon, was der Exitcode war. |
taskfailure |
string |
Laden Sie die Datei(en) erst hoch, nachdem der Vorgangsprozess mit einem nichtzero-Exitcode beendet wurde. |
tasksuccess |
string |
Laden Sie die Datei(en) erst hoch, nachdem der Vorgangsprozess mit dem Exitcode 0 beendet wurde. |
OutputFileUploadOptions
Details zu einem Vorgang zum Hochladen einer Ausgabedatei, 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 |
Detaillierte 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 zum Erstellen von Containern. |
imageName |
string |
Das Image, das zum Erstellen des Containers verwendet werden soll, in dem die Aufgabe 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. Jeder Task, der explizit angegeben ist oder innerhalb eines Abhängigkeitsbereichs liegt, muss abgeschlossen werden, bevor der abhängige Task geplant wird.
Name | Typ | Beschreibung |
---|---|---|
taskIdRanges |
Die Liste der Aufgaben-ID-Bereiche, von denen dieser Task abhängt. Alle Tasks in allen Bereichen müssen erfolgreich abgeschlossen werden, bevor die abhängige Aufgabe geplant werden kann. |
|
taskIds |
string[] |
Die Liste der Aufgaben-IDs, von denen dieser Task 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 Aufgabenausführung.
Name | Typ | Beschreibung |
---|---|---|
failure |
string |
Während der Verarbeitung der Aufgabe 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 Vorgangsfehler. 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
Eine Reihe von Aufgaben-IDs, von denen eine Aufgabe abhängig sein kann. Alle Aufgaben 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 der 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 Task erfolgreich abgeschlossen wurde oder der Task nicht erfolgreich abgeschlossen wurde und sein Wiederholungslimit ausgeschöpft hat. Ein Task wird auch als abgeschlossen markiert, wenn beim Starten der Aufgabe ein Fehler 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 Taskbefehlszeile mit der Ausführung begonnen hat. |
TaskStatistics
Ressourcennutzungsstatistiken für einen Task.
Name | Typ | Beschreibung |
---|---|---|
kernelCPUTime |
string |
Die gesamte CPU-Zeit im Kernelmodus (summiert ü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 vom Task vom Datenträger gelesen werden. |
readIOps |
integer |
Die Gesamtanzahl der Datenträgerlesevorgänge, die vom Task ausgeführt werden. |
startTime |
string |
Die Startzeit des von der Statistik abgedeckten Zeitbereichs. |
url |
string |
Die URL der Statistiken. |
userCPUTime |
string |
Die gesamte CPU-Zeit im Benutzermodus (zusammengefasst über alle Kerne und alle Computeknoten), die vom Task verbraucht wird. |
waitTime |
string |
Die Gesamtwartezeit des Tasks. 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 Task aufgrund von Fehlern wiederholt wird, ist die Wartezeit die Zeit bis zur letzten Taskausführung.) |
wallClockTime |
string |
Die Gesamtzeit der Wanduhr des Vorgangs. |
writeIOGiB |
number |
Die gesamten Gibibytes, die vom Task auf den Datenträger geschrieben werden. |
writeIOps |
integer |
Die Gesamtanzahl der Vom Task durchgeführten Schreibvorgänge auf Datenträgern. |
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. |