Task - Add Collection
Fügt dem angegebenen Auftrag eine Auflistung von Tasks hinzu.
Beachten Sie, dass jede Aufgabe über eine eindeutige ID verfügen muss. Der Batch-Dienst gibt möglicherweise nicht die Ergebnisse für jeden Vorgang in derselben Reihenfolge zurück, in der die Aufgaben in dieser Anforderung übermittelt wurden. Wenn für den Server ein Timeout auftritt oder die Verbindung während der Anforderung geschlossen wird, wurde die Anforderung möglicherweise teilweise oder vollständig oder gar nicht verarbeitet. In einem solchen Fall sollte der Benutzer die Anforderung erneut senden. Beachten Sie, dass der Benutzer Fehler beim erneuten Ausstellen einer Anforderung ordnungsgemäß behandeln kann. Beispielsweise sollten Sie während eines Wiederholungsversuchs die gleichen Aufgaben-IDs verwenden, damit bei erfolgreicher Ausführung des vorherigen Vorgangs bei der Wiederholung nicht unerwartet zusätzliche Aufgaben erstellt werden. Wenn die Antwort Tasks enthält, die nicht hinzugefügt werden konnten, kann ein Client die Anforderung wiederholen. Bei einer Wiederholung ist es am effizientesten, nur Aufgaben erneut zu übermitteln, die nicht hinzugefügt werden konnten, und Aufgaben auszulassen, die beim ersten Versuch erfolgreich hinzugefügt wurden. Die maximale Lebensdauer eines Vorgangs vom Hinzufügen bis zum Abschluss beträgt 180 Tage. Wenn ein Task nicht innerhalb von 180 Tagen nach dem Hinzufügen abgeschlossen wurde, wird er vom Batch-Dienst beendet und in einem beliebigen Zustand belassen, in dem er sich zu diesem Zeitpunkt befand.
POST {batchUrl}/jobs/{jobId}/addtaskcollection?api-version=2023-11-01.18.0
POST {batchUrl}/jobs/{jobId}/addtaskcollection?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, dem die Task-Auflistung hinzugefügt werden soll. |
api-version
|
query | True |
string |
Client-API-Version. |
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. |
Anforderungstext
Media Types: "application/json; odata=minimalmetadata"
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
value | True |
Die Auflistung der hinzuzufügenden Aufgaben. Die maximale Anzahl von Aufgaben beträgt 100. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Eine Antwort, die die Ergebnisse des Vorgangs "Tasksammlung hinzufügen" enthält. Header
|
|
Other Status Codes |
Unerwarteter Fehler |
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
Add a basic collection of tasks |
Add a complex collection of tasks |
Add a basic collection of tasks
Beispielanforderung
POST account.region.batch.azure.com/jobs/jobId/addtaskcollection?api-version=2023-11-01.18.0
{
"value": [
{
"id": "simple1",
"commandLine": "cmd /c dir /s"
},
{
"id": "simple2",
"commandLine": "cmd /c dir /s"
}
]
}
Beispiel für eine Antwort
{
"value": [
{
"status": "success",
"taskId": "simple1",
"eTag": "0x8D3D623CD661246",
"lastModified": "2016-09-06T07:02:44.7589958Z",
"location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple1"
},
{
"status": "success",
"taskId": "simple2",
"eTag": "0x8D3D623CD7072CC",
"lastModified": "2016-09-06T07:02:44.8270028Z",
"location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple2"
}
]
}
Add a complex collection of tasks
Beispielanforderung
POST account.region.batch.azure.com/jobs/jobId/addtaskcollection?api-version=2023-11-01.18.0
{
"value": [
{
"id": "complex1",
"commandLine": "cmd /c dir /s",
"resourceFiles": [
{
"autoStorageContainerName": "containerName",
"filePath": "data"
}
],
"environmentSettings": [
{
"name": "env1",
"value": "value1"
},
{
"name": "env2",
"value": "value2"
}
],
"affinityInfo": {
"affinityId": "affinityId"
},
"constraints": {
"maxWallClockTime": "P1D",
"retentionTime": "P2D",
"maxTaskRetryCount": 5
},
"requiredSlots": 2,
"multiInstanceSettings": {
"numberOfInstances": 3,
"coordinationCommandLine": "cmd /c echo coordinating",
"commonResourceFiles": [
{
"httpUrl": "https://common.blob.core.windows.net/",
"filePath": "common.exe"
}
]
}
},
{
"id": "simple3",
"commandLine": "cmd /c dir /s"
}
]
}
Beispiel für eine Antwort
{
"value": [
{
"taskId": "simple3",
"status": "success",
"eTag": "0x8D3D623CE295629",
"lastModified": "2016-09-06T07:02:46.0386857Z",
"location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple3"
},
{
"taskId": "complex1",
"status": "success",
"eTag": "0x8D3D623CE29A412",
"lastModified": "2016-09-06T07:02:46.0406802Z",
"location": "https://account.region.batch.azure.com/jobs/jobId/tasks/complex1"
}
]
}
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. |
Compute |
Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet. |
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 diesem Task abhängen. |
Elevation |
Die Höhenstufe des Benutzers. |
Environment |
Eine Umgebungsvariable, die für einen Vorgangsvorgang festgelegt werden soll. |
Error |
Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird. |
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 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. |
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 |
Eine Sammlung von Azure Batch Tasks, die hinzugefügt werden sollen. |
Task |
Das Ergebnis des Hinzufügens einer Sammlung von Tasks zu einem Auftrag. |
Task |
Eine hinzuzufügende Azure Batch-Aufgabe. |
Task |
Ergebnis für einen einzelnen Task, der als Teil eines Vorgangs zum Hinzufügen eines Vorgangs hinzugefügt wurde. |
Task |
Die status der Anforderung "Task hinzufügen". |
Task |
Ausführungseinschränkungen, die auf einen Task angewendet werden sollen. |
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 |
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. |
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, 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. |
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. |
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 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. |
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 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 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. |
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, 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 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 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 Auto Storage-Konto. |
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. |
TaskAddCollectionParameter
Eine Sammlung von Azure Batch Tasks, die hinzugefügt werden sollen.
Name | Typ | Beschreibung |
---|---|---|
value |
Die Auflistung der hinzuzufügenden Aufgaben. Die maximale Anzahl von Aufgaben beträgt 100. |
TaskAddCollectionResult
Das Ergebnis des Hinzufügens einer Sammlung von Tasks zu einem Auftrag.
Name | Typ | Beschreibung |
---|---|---|
value |
Die Ergebnisse des Vorgangs "Tasksammlung hinzufügen". |
TaskAddParameter
Eine hinzuzufügende 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 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. |
|
dependsOn |
Die Aufgaben, von denen dieser Task abhängt. |
|
displayName |
string |
Ein Anzeigename für den Task. |
environmentSettings |
Eine Liste der Umgebungsvariableneinstellungen für den Task. |
|
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. |
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. |
|
outputFiles |
Eine Liste der Dateien, die der Batch-Dienst nach dem Ausführen der Befehlszeile vom Computeknoten hochlädt. |
|
requiredSlots |
integer |
Die Anzahl der Zeitplanungsslots, die der Task ausführen muss. |
resourceFiles |
Eine Liste der Dateien, die vom Batch-Dienst auf den Computeknoten heruntergeladen werden, bevor die Befehlszeile ausgeführt wird. |
|
userIdentity |
Die Benutzeridentität, unter der der Task ausgeführt wird. |
TaskAddResult
Ergebnis für einen einzelnen Task, der als Teil eines Vorgangs zum Hinzufügen eines Vorgangs hinzugefügt wurde.
Name | Typ | Beschreibung |
---|---|---|
eTag |
string |
Das ETag des Vorgangs, wenn der Task erfolgreich hinzugefügt wurde. |
error |
Der Fehler, der beim Hinzufügen der Aufgabe aufgetreten ist. |
|
lastModified |
string |
Der Zeitpunkt der letzten Änderung des Vorgangs. |
location |
string |
Die URL des Vorgangs, wenn die Aufgabe erfolgreich hinzugefügt wurde. |
status |
Die status der Task-Add-Anforderung. |
|
taskId |
string |
Die ID der Aufgabe, für die dies das Ergebnis ist. |
TaskAddStatus
Die status der Anforderung "Task hinzufügen".
Name | Typ | Beschreibung |
---|---|---|
clienterror |
string |
Der Task konnte aufgrund eines Clientfehlers nicht hinzugefügt werden und sollte nicht wiederholt werden, ohne die Anforderung entsprechend zu ändern. |
servererror |
string |
Der Task konnte aufgrund eines Serverfehlers nicht hinzugefügt werden und kann ohne Änderung wiederholt werden. |
success |
string |
Der Task wurde erfolgreich hinzugefügt. |
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. |
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 Aufgabenarbeitsverzeichnisses des Containers. |
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. |
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. |
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. |