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 Batchdienst 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 das Zeitüberschreitungen des Servers oder die Verbindung während der Anforderung geschlossen wird, wurde die Anforderung möglicherweise teilweise oder vollständig verarbeitet oder gar nicht. In solchen Fällen sollte der Benutzer die Anforderung erneut ausstellen. Beachten Sie, dass der Benutzer fehler beim erneuten Ausgeben einer Anforderung ordnungsgemäß behandeln kann. Sie sollten z. B. die gleichen Vorgangs-IDs während eines Wiederholungsvorgangs verwenden, sodass beim erfolgreichen Vorherigen Vorgang keine zusätzlichen Aufgaben unerwartet erstellt werden. Wenn die Antwort Aufgaben enthält, die nicht hinzugefügt werden konnten, kann ein Client die Anforderung wiederholen. In einem Wiederholungsversuch ist es am effizientesten, nur Aufgaben erneut zu übermitteln, die nicht hinzugefügt wurden, und Aufgaben auszulassen, die erfolgreich beim ersten Versuch hinzugefügt wurden. Die maximale Lebensdauer eines Vorgangs von der Ergänzung zum Abschluss beträgt 180 Tage. Wenn eine Aufgabe nicht innerhalb von 180 Tagen nach dem Hinzufügen abgeschlossen wurde, wird sie vom Batchdienst beendet und in dem Zustand verbleiben, in dem es sich zu diesem Zeitpunkt befand.
POST {batchUrl}/jobs/{jobId}/addtaskcollection?api-version=2024-07-01.20.0
POST {batchUrl}/jobs/{jobId}/addtaskcollection?timeout={timeout}&api-version=2024-07-01.20.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 Aufgabenauflistung 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 ausgeben kann. Der Standardwert ist 2 Minuten. Wenn der Wert größer als 120 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. |
Anforderungstext
Media Types: "application/json; odata=minimalmetadata"
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
value | True |
Die Hinzuzufügende Sammlung von Tasks. Die maximale Anzahl von Vorgängen beträgt 100. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Eine Antwort, die die Ergebnisse des Vorgangs zum Hinzufügen von Aufgabenauflistung enthält. Header
|
|
Other Status Codes |
Unerwarteter Fehler |
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
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=2024-07-01.20.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=2024-07-01.20.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 Batchressourcen, auf die das Token Zugriff gewährt. |
Affinity |
Ein Gebietsschemahinweis, der vom Batchdienst 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 von der Aufgabe zum Ausführen von Batchdienstvorgängen verwendet werden kann. |
Auto |
Der Bereich für den automatischen Benutzer |
Auto |
Gibt die Parameter für den automatischen Benutzer an, der eine Aufgabe im Batchdienst 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 vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet. |
Container |
Der Eintrag des Pfad- und Bereitstellungsmodus, den Sie in Aufgabencontainer bereitstellen möchten. |
Container |
Die Pfade, die im Container der Containeraufgabe bereitgestellt werden. |
Container |
Eine private Containerregistrierung. |
Container |
Der Speicherort des Arbeitsverzeichnisses für containeraufgaben. |
Dependency |
Eine Aktion, die der Batchdienst für Aufgaben ausführt, die von dieser Aufgabe abhängig sind. |
Elevation |
Die Höhe des Benutzers. |
Environment |
Eine Umgebungsvariable, die für einen Vorgangsprozess festgelegt werden soll. |
Error |
Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde. |
Exit |
Wie der Batchdienst reagieren soll, wenn eine Aufgabe mit einem bestimmten Beendigungscode beendet wird. |
Exit |
Eine Reihe von Beendigungscodes und wie der Batchdienst auf Beendigungscodes innerhalb dieses Bereichs reagieren soll. |
Exit |
Gibt an, wie der Batchdienst reagieren soll, wenn die Aufgabe abgeschlossen ist. |
Exit |
Gibt an, wie der Batchdienst auf eine bestimmte Beendigungsbedingung reagiert. |
Http |
Ein HTTP-Headernamen-Wert-Paar |
Job |
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. |
Multi |
Einstellungen, die angeben, wie eine Aufgabe mit mehreren Instanzen ausgeführt werden soll. |
Output |
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. |
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 Aufgabenausgabedatei oder eine Gruppe von Dateien hochgeladen werden soll. |
Output |
Details zu einem Uploadvorgang einer Ausgabedatei, einschließlich der Bedingungen, unter denen der Upload ausgeführt werden soll. |
Resource |
Eine einzelne Datei oder mehrere Dateien, die in einen Computeknoten heruntergeladen werden sollen. |
Task |
Eine Sammlung von hinzuzufügenden Azure-Batchaufgaben. |
Task |
Das Ergebnis des Hinzufügens einer Sammlung von Aufgaben zu einem Auftrag. |
Task |
Eine hinzuzufügende Azure-Batchaufgabe. |
Task |
Ergebnis für einen einzelnen Vorgang, der als Teil eines Vorgangs zum Hinzufügen einer Aufgabenauflistung hinzugefügt wurde. |
Task |
Der Status der Aufgabenanforderung hinzufügen. |
Task |
Ausführungseinschränkungen, die auf einen Vorgang angewendet werden sollen. |
Task |
Die Containereinstellungen für eine Aufgabe. |
Task |
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. |
Task |
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. |
User |
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. |
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 weggelassen wird, wird die Standardversion bereitgestellt. |
AuthenticationTokenSettings
Die Einstellungen für ein Authentifizierungstoken, das von der Aufgabe zum Ausführen von Batchdienstvorgängen verwendet werden kann.
Name | Typ | Beschreibung |
---|---|---|
access |
Die Batchressourcen, auf die das Token Zugriff gewährt. |
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 |
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 sollen programmgesteuert genutzt werden. |
message |
Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist. |
|
values |
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. |
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. |
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). |
source |
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 |
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. |
|
password |
string |
Das Kennwort für die Anmeldung beim Registrierungsserver. |
registryServer |
string |
Die Registrierungs-URL. |
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. |
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 |
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 |
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 |
Wie der Batchdienst reagieren soll, wenn der Vorgang mit einer Beendigungsbedingung fehlschlägt, die von keiner der anderen Eigenschaften abgedeckt wird. |
|
exitCodeRanges |
Eine Liste der Aufgabenausgangscodebereiche und wie der Batchdienst darauf reagieren soll. |
|
exitCodes |
Eine Liste der einzelnen Aufgabenendecodes und derEn Reaktion des Batchdiensts. |
|
fileUploadError |
Wie der Batchdienst reagieren soll, wenn ein Dateiuploadfehler auftritt. |
|
preProcessingError |
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 |
Eine Aktion, die der Batchdienst für Aufgaben ausführt, die von dieser Aufgabe abhängig sind. |
|
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. |
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 |
Eine Liste der Dateien, die der Batchdienst herunterladen wird, 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 die primäre Aufgabe ausgeführt wird. |
numberOfInstances |
integer |
Die Anzahl der Computeknoten, die für den Vorgang erforderlich sind. |
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 |
Das Ziel für die Ausgabedatei(n). |
|
filePattern |
string |
Ein Muster, das angibt, welche Datei(en) hochgeladen werden soll. |
uploadOptions |
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. |
identityReference |
Der Verweis auf die vom Benutzer zugewiesene Identität für den Zugriff auf Azure Blob Storage, der durch containerUrl angegeben wird |
|
path |
string |
Das Ziel-BLOB oder virtuelle Verzeichnis im Azure Storage-Container. |
uploadHeaders |
Eine Liste von Namen-Wert-Paaren für Kopfzeilen, die beim Hochladen von Ausgabedateien verwendet werden sollen |
OutputFileDestination
Das Ziel, in das eine Datei hochgeladen werden soll.
Name | Typ | Beschreibung |
---|---|---|
container |
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 |
Die Bedingungen, unter denen die Task-Ausgabedatei oder -gruppe von Dateien hochgeladen werden soll. |
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. |
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 für den Dateiberechtigungsmodus im oktalen Format. |
filePath |
string |
Der Speicherort auf dem Computeknoten, in den die Datei(n) heruntergeladen werden soll, relativ zum Arbeitsverzeichnis der Aufgabe. |
httpUrl |
string |
Die URL der herunterzuladenden Datei. |
identityReference |
Der Verweis auf die vom Benutzer zugewiesene Identität für den Zugriff auf Azure Blob Storage, der durch "storageContainerUrl" oder "httpUrl" angegeben wird |
|
storageContainerUrl |
string |
Die URL des Blobcontainers in Azure Blob Storage. |
TaskAddCollectionParameter
Eine Sammlung von hinzuzufügenden Azure-Batchaufgaben.
Name | Typ | Beschreibung |
---|---|---|
value |
Die Hinzuzufügende Sammlung von Tasks. Die maximale Anzahl von Vorgängen beträgt 100. |
TaskAddCollectionResult
Das Ergebnis des Hinzufügens einer Sammlung von Aufgaben zu einem Auftrag.
Name | Typ | Beschreibung |
---|---|---|
value |
Die Ergebnisse des Vorgangs zum Hinzufügen der Aufgabenauflistung. |
TaskAddParameter
Eine hinzuzufügende Azure-Batchaufgabe.
Name | Typ | Beschreibung |
---|---|---|
affinityInfo |
Ein Gebietsschemahinweis, der vom Batchdienst verwendet werden kann, um einen Computeknoten auszuwählen, auf dem die neue Aufgabe gestartet werden soll. |
|
applicationPackageReferences |
Eine Liste der Pakete, die der Batchdienst vor dem Ausführen der Befehlszeile auf dem Computeknoten bereitstellen wird. |
|
authenticationTokenSettings |
Die Einstellungen für ein Authentifizierungstoken, das von der Aufgabe zum Ausführen von Batchdienstvorgängen verwendet werden kann. |
|
commandLine |
string |
Die Befehlszeile der Aufgabe. |
constraints |
Die Ausführungseinschränkungen, die für diesen Vorgang gelten. |
|
containerSettings |
Die Einstellungen für den Container, unter dem die Aufgabe ausgeführt wird. |
|
dependsOn |
Die Vorgänge, von denen dieser Vorgang abhängt. |
|
displayName |
string |
Ein Anzeigename für den Vorgang. |
environmentSettings |
Eine Liste der Umgebungsvariableneinstellungen für die Aufgabe. |
|
exitConditions |
Gibt an, wie der Batchdienst reagieren soll, wenn die Aufgabe abgeschlossen ist. |
|
id |
string |
Eine Zeichenfolge, die die Aufgabe innerhalb des Auftrags eindeutig identifiziert. |
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. |
|
outputFiles |
Eine Liste der Dateien, die der Batchdienst nach dem Ausführen der Befehlszeile vom Computeknoten hochladen wird. |
|
requiredSlots |
integer |
Die Anzahl der Zeitplanungsplätze, die der auszuführende Vorgang benötigt. |
resourceFiles |
Eine Liste der Dateien, die der Batchdienst vor dem Ausführen der Befehlszeile auf den Computeknoten herunterladen wird. |
|
userIdentity |
Die Benutzeridentität, unter der die Aufgabe ausgeführt wird. |
TaskAddResult
Ergebnis für einen einzelnen Vorgang, der als Teil eines Vorgangs zum Hinzufügen einer Aufgabenauflistung hinzugefügt wurde.
Name | Typ | Beschreibung |
---|---|---|
eTag |
string |
Das ETag des Vorgangs, wenn die Aufgabe erfolgreich hinzugefügt wurde. |
error |
Fehler beim Hinzufügen der Aufgabe. |
|
lastModified |
string |
Der Zeitpunkt der letzten Änderung des Vorgangs. |
location |
string |
Die URL der Aufgabe, wenn die Aufgabe erfolgreich hinzugefügt wurde. |
status |
Der Status der Aufgabenanforderung hinzufügen. |
|
taskId |
string |
Die ID des Vorgangs, für den dies das Ergebnis ist. |
TaskAddStatus
Der Status der Aufgabenanforderung hinzufügen.
Name | Typ | Beschreibung |
---|---|---|
clienterror |
string |
Die Aufgabe konnte aufgrund eines Clientfehlers nicht hinzugefügt werden und sollte nicht erneut versucht werden, ohne die Anforderung entsprechend zu ändern. |
servererror |
string |
Die Aufgabe konnte aufgrund eines Serverfehlers nicht hinzugefügt werden und kann ohne Änderung wiederholt werden. |
success |
string |
Die Aufgabe wurde erfolgreich hinzugefügt. |
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. |
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. |
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. |
TaskContainerSettings
Die Containereinstellungen für eine Aufgabe.
Name | Typ | Beschreibung |
---|---|---|
containerHostBatchBindMounts |
Die Pfade, die Sie an containeraufgaben bereitstellen möchten. |
|
containerRunOptions |
string |
Zusätzliche Optionen für den Befehl "Container erstellen". |
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 für containeraufgaben. |
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 |
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. |
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. |
UserIdentity
Die Definition der Benutzeridentität, unter der die Aufgabe ausgeführt wird.
Name | Typ | Beschreibung |
---|---|---|
autoUser |
Der automatische Benutzer, unter dem die Aufgabe ausgeführt wird. |
|
username |
string |
Der Name der Benutzeridentität, unter der die Aufgabe ausgeführt wird. |