Task - Add

Fügt dem angegebenen Auftrag eine Aufgabe hinzu.
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 dem Zustand belassen, in dem er sich zu diesem Zeitpunkt befand.

POST {batchUrl}/jobs/{jobId}/tasks?api-version=2023-11-01.18.0
POST {batchUrl}/jobs/{jobId}/tasks?timeout={timeout}&api-version=2023-11-01.18.0

URI-Parameter

Name In Erforderlich Typ Beschreibung
batchUrl
path True

string

Die Basis-URL für alle Azure Batch-Dienstanforderungen.

jobId
path True

string

Die ID des Auftrags, dem die Aufgabe 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 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.

Anforderungstext

Media Types: "application/json; odata=minimalmetadata"

Name Erforderlich Typ Beschreibung
commandLine True

string

Die Befehlszeile des Tasks.
Bei Aufgaben mit mehreren instance wird die Befehlszeile als primäre Aufgabe ausgeführt, nachdem der primäre Task und alle Teilvorgänge die Koordinationsbefehlszeile ausgeführt haben. Die Befehlszeile wird nicht unter einer Shell ausgeführt und kann daher keine Shellfeatures wie die Erweiterung von Umgebungsvariablen nutzen. Wenn Sie solche Features nutzen möchten, sollten Sie die Shell in der Befehlszeile aufrufen, z. B. mit "cmd /c MyCommand" in Windows oder "/bin/sh -c MyCommand" unter Linux. Wenn die Befehlszeile auf Dateipfade verweist, sollte sie einen relativen Pfad (relativ zum Arbeitsverzeichnis Task) oder die von Batch bereitgestellte Umgebungsvariable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) verwenden.

id True

string

Eine Zeichenfolge, die den Task innerhalb des Auftrags eindeutig identifiziert.
Die ID kann eine beliebige Kombination von alphanumerischen Zeichen einschließlich Bindestrichen und Unterstrichen enthalten und darf nicht mehr als 64 Zeichen enthalten. Bei der ID wird die Groß-/Kleinschreibung beibehalten und die Groß-/Kleinschreibung wird nicht beachtet (d. h., Sie verfügen möglicherweise nicht über zwei IDs innerhalb eines Auftrags, die sich nur nach Groß-/Kleinschreibung unterscheiden).

affinityInfo

AffinityInformation

Ein Lokalitätshinweis, der vom Batch-Dienst verwendet werden kann, um einen Computeknoten auszuwählen, auf dem der neue Task gestartet werden soll.

applicationPackageReferences

ApplicationPackageReference[]

Eine Liste der Pakete, die der Batch-Dienst auf dem Computeknoten bereitstellt, bevor die Befehlszeile ausgeführt wird.
Anwendungspakete werden heruntergeladen und in einem freigegebenen Verzeichnis bereitgestellt, nicht in das Arbeitsverzeichnis Task. Wenn sich ein Paket, auf das verwiesen wird, bereits auf dem Knoten befindet und auf dem neuesten Stand ist, wird es daher nicht erneut heruntergeladen. Die vorhandene Kopie auf dem Computeknoten wird verwendet. Wenn ein Paket, auf das verwiesen wird, nicht installiert werden kann, z. B. weil das Paket gelöscht wurde oder der Download fehlgeschlagen ist, schlägt der Task fehl.

authenticationTokenSettings

AuthenticationTokenSettings

Die Einstellungen für ein Authentifizierungstoken, das der Task zum Ausführen von Batch-Dienstvorgängen verwenden kann.
Wenn diese Eigenschaft festgelegt ist, stellt der Batch-Dienst der Aufgabe ein Authentifizierungstoken bereit, das zum Authentifizieren von Batch-Dienstvorgängen verwendet werden kann, ohne dass ein Kontozugriffsschlüssel erforderlich ist. Das Token wird über die AZ_BATCH_AUTHENTICATION_TOKEN Umgebungsvariable bereitgestellt. Die Vorgänge, die der Task mit dem Token ausführen kann, hängen von den Einstellungen ab. Beispielsweise kann ein Task Auftragsberechtigungen anfordern, um dem Auftrag weitere Aufgaben hinzuzufügen, oder die status des Auftrags oder anderer Aufgaben unter dem Auftrag überprüfen.

constraints

TaskConstraints

Die Ausführungseinschränkungen, die für diesen Task gelten.
Wenn Sie keine Einschränkungen angeben, entspricht maxTaskRetryCount dem für den Auftrag angegebenen maxTaskRetryCount, maxWallClockTime ist unendlich, und die retentionTime beträgt 7 Tage.

containerSettings

TaskContainerSettings

Die Einstellungen für den Container, unter dem der Task ausgeführt wird.
Wenn für den Pool, der diesen Task ausführen wird, containerConfiguration festgelegt ist, muss auch dies festgelegt werden. Wenn für den Pool, der diesen Task ausführen wird, containerConfiguration nicht festgelegt ist, darf dies nicht festgelegt werden. Wenn dies angegeben ist, werden alle Verzeichnisse rekursiv unterhalb der AZ_BATCH_NODE_ROOT_DIR (dem Stammverzeichnis der Azure Batch Verzeichnisse auf dem Knoten) dem Container zugeordnet, alle Taskumgebungsvariablen werden dem Container zugeordnet, und die Taskbefehlszeile wird im Container ausgeführt. Dateien, die im Container außerhalb von AZ_BATCH_NODE_ROOT_DIR erstellt werden, werden möglicherweise nicht auf den Hostdatenträger wiedergegeben, was bedeutet, dass Batch-Datei-APIs nicht auf diese Dateien zugreifen können.

dependsOn

TaskDependencies

Die Aufgaben, von denen diese Aufgabe abhängt.
Diese Aufgabe wird erst geplant, wenn alle Aufgaben, von denen sie abhängt, erfolgreich abgeschlossen wurden. Wenn eine dieser Aufgaben fehlschlägt und die Wiederholungsanzahl erschöpft ist, wird diese Aufgabe nie geplant. Wenn für den Auftrag nicht usesTaskDependencies auf true festgelegt ist und dieses Element vorhanden ist, schlägt die Anforderung mit dem Fehlercode TaskDependenciesNotSpecifiedOnJob fehl.

displayName

string

Ein Anzeigename für den Task.
Der Anzeigename muss nicht eindeutig sein und kann Unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten.

environmentSettings

EnvironmentSetting[]

Eine Liste der Umgebungsvariableneinstellungen für den Task.

exitConditions

ExitConditions

Gibt an, wie der Batch-Dienst reagieren soll, wenn der Task abgeschlossen ist.
Wie der Batch-Dienst reagieren soll, wenn der Task abgeschlossen ist.

multiInstanceSettings

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.
Aufgaben mit mehreren instance werden häufig zur Unterstützung von MPI-Aufgaben verwendet. Wenn im MPI-Fall einer der Teiltasks fehlschlägt (z. B. aufgrund des Beendens mit einem Nicht-Null-Exitcode), schlägt der gesamte Task mit mehreren instance fehl. Der Task mit mehreren instance wird dann beendet und bis zu seinem Wiederholungslimit wiederholt.

outputFiles

OutputFile[]

Eine Liste der Dateien, die der Batch-Dienst nach dem Ausführen der Befehlszeile vom Computeknoten hochlädt.
Bei Aufgaben mit mehreren instance werden die Dateien nur aus dem Computeknoten hochgeladen, auf dem der primäre Task ausgeführt wird.

requiredSlots

integer

Die Anzahl der Zeitplanungsslots, die der Task ausführen muss.
Der Standardwert ist 1. Die Ausführung eines Tasks auf einem Computeknoten kann nur geplant werden, wenn der Knoten über genügend freie Zeitplanungsslots verfügt. Bei Aufgaben mit mehreren instance muss dies 1 sein.

resourceFiles

ResourceFile[]

Eine Liste der Dateien, die vom Batch-Dienst auf den Computeknoten heruntergeladen werden, bevor die Befehlszeile ausgeführt wird.
Bei Aufgaben mit mehreren instance werden die Ressourcendateien nur auf den Computeknoten heruntergeladen, auf dem der primäre Task ausgeführt wird. Es gibt eine maximale Größe für die Liste der Ressourcendateien. Wenn die maximale Größe überschritten wird, schlägt die Anforderung fehl, und der Antwortfehlercode lautet RequestEntityTooLarge. In diesem Fall muss die Sammlung von ResourceFiles verkleinert werden. Dies kann mithilfe von .zip-Dateien, Anwendungspaketen oder Docker-Containern erreicht werden.

userIdentity

UserIdentity

Die Benutzeridentität, unter der der Task ausgeführt wird.
Wenn der Task nicht angegeben wird, wird er als nicht administrativer Benutzer ausgeführt, der für den Task eindeutig ist.

Antworten

Name Typ Beschreibung
201 Created

Die Anforderung an den Batch-Dienst war erfolgreich.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

Der Fehler vom Batch-Dienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodeflow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Authorization

Type: apiKey
In: header

Beispiele

Add a basic task
Add a task with container settings
Add a task with exit conditions
Add a task with extra slot requirement

Add a basic task

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2023-11-01.18.0



{
  "id": "task1",
  "commandLine": "cmd /c echo task1"
}

Sample Response

Add a task with container settings

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2023-11-01.18.0



{
  "id": "taskId",
  "commandLine": "bash -c 'echo hello'",
  "containerSettings": {
    "imageName": "ubuntu",
    "containerRunOptions": "--rm"
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Sample Response

Add a task with exit conditions

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2023-11-01.18.0



{
  "id": "taskId",
  "commandLine": "cmd /c exit 3",
  "exitConditions": {
    "exitCodeRanges": [
      {
        "start": 2,
        "end": 4,
        "exitOptions": {
          "jobAction": "terminate"
        }
      }
    ]
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Sample Response

Add a task with extra slot requirement

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2023-11-01.18.0



{
  "id": "task1",
  "requiredSlots": 2,
  "commandLine": "cmd /c echo task1"
}

Sample Response

Definitionen

Name Beschreibung
AccessScope

Die Batch-Ressourcen, auf die das Token Zugriff gewährt.

AffinityInformation

Ein Lokalitätshinweis, der vom Batch-Dienst verwendet werden kann, um einen Computeknoten auszuwählen, auf dem eine Aufgabe gestartet werden soll.

ApplicationPackageReference

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

AuthenticationTokenSettings

Die Einstellungen für ein Authentifizierungstoken, das der Task zum Ausführen von Batch-Dienstvorgängen verwenden kann.

AutoUserScope

Der Bereich für den automatischen Benutzer

AutoUserSpecification

Gibt die Parameter für den automatischen Benutzer an, der einen Task im Batch-Dienst ausführt.

BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

BatchErrorDetail

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.

ComputeNodeIdentityReference

Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.

ContainerRegistry

Eine private Containerregistrierung.

ContainerWorkingDirectory

Der Speicherort des Aufgabenarbeitsverzeichnisses des Containers.

DependencyAction

Eine Aktion, die der Batch-Dienst für Aufgaben ausführt, die von diesem Task abhängen.

ElevationLevel

Die Höhenstufe des Benutzers.

EnvironmentSetting

Eine Umgebungsvariable, die für einen Taskprozess festgelegt werden soll.

ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde.

ExitCodeMapping

Wie der Batch-Dienst reagieren soll, wenn eine Aufgabe mit einem bestimmten Exitcode beendet wird.

ExitCodeRangeMapping

Eine Reihe von Exitcodes und wie der Batch-Dienst auf Exitcodes innerhalb dieses Bereichs reagieren soll.

ExitConditions

Gibt an, wie der Batch-Dienst reagieren soll, wenn der Task abgeschlossen ist.

ExitOptions

Gibt an, wie der Batch-Dienst auf eine bestimmte Beendigungsbedingung reagiert.

HttpHeader

Ein Name-Wert-Paar für HTTP-Header

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.

MultiInstanceSettings

Einstellungen, die angeben, wie ein Task mit mehreren instance ausgeführt werden soll.

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.

OutputFileBlobContainerDestination

Gibt ein Dateiuploadziel in einem Azure Blob Storage-Container an.

OutputFileDestination

Das Ziel, in das eine Datei hochgeladen werden soll.

OutputFileUploadCondition

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

OutputFileUploadOptions

Details zu einem Vorgang zum Hochladen einer Ausgabedatei, einschließlich der Bedingungen, unter welchen Bedingungen der Upload ausgeführt werden soll.

ResourceFile

Eine einzelne Datei oder mehrere Dateien, die auf einen Computeknoten heruntergeladen werden sollen.

TaskAddParameter

Eine hinzuzufügende Azure Batch-Aufgabe.

TaskConstraints

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

TaskContainerSettings

Die Containereinstellungen für einen Task.

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.

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.

UserIdentity

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 Zuvor ausgeführten Aufgabe darstellt.
Sie können die AffinityId eines Knotens übergeben, um anzugeben, dass dieser Task auf diesem Computeknoten ausgeführt werden muss. Beachten Sie, dass dies nur eine weiche Affinität ist. Wenn der Zielcomputeknoten ausgelastet ist oder zum Zeitpunkt der Geplanten Ausführung des Tasks nicht verfügbar ist, wird der Task an anderer Stelle geplant.

ApplicationPackageReference

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

Name Typ Beschreibung
applicationId

string

Die ID der bereitzustellenden Anwendung.
Beim Erstellen eines Pools muss die Anwendungs-ID des Pakets voll qualifiziert sein (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).

version

string

Die Version der bereitzustellenden Anwendung. Wenn sie nicht angegeben wird, wird die Standardversion bereitgestellt.
Wenn dies in einem Pool ausgelassen wird und keine Standardversion für diese Anwendung angegeben wird, schlägt die Anforderung mit dem Fehlercode InvalidApplicationPackageReferences und HTTP status Code 409 fehl. Wenn dies für einen Task ausgelassen wird und keine Standardversion für diese Anwendung angegeben ist, schlägt der Task mit einem Vorverarbeitungsfehler fehl.

AuthenticationTokenSettings

Die Einstellungen für ein Authentifizierungstoken, das der Task zum Ausführen von Batch-Dienstvorgängen verwenden kann.

Name Typ Beschreibung
access

AccessScope[]

Die Batch-Ressourcen, auf die das Token Zugriff gewährt.
Das Authentifizierungstoken gewährt Zugriff auf eine begrenzte Gruppe von Batch-Dienstvorgängen. Der einzige unterstützte Wert für die Access-Eigenschaft ist "job", der Zugriff auf alle Vorgänge im Zusammenhang mit dem Auftrag gewährt, der den Task enthält.

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

ElevationLevel

Die Höhenstufe des automatischen Benutzers.
Der Standardwert ist nonAdmin.

scope

AutoUserScope

Der Bereich für den automatischen Benutzer
Der Standardwert ist pool. Wenn im Pool Windows ausgeführt wird, sollte der Wert Task angegeben werden, wenn eine strengere Isolation zwischen Tasks erforderlich ist. Beispielsweise, wenn die Aufgabe die Registrierung auf eine Weise mutiert, die sich auf andere Aufgaben auswirken kann, oder wenn Zertifikate für den Pool angegeben wurden, auf die normale Aufgaben nicht zugreifen können, sondern von StartTasks zugänglich sein sollten.

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

ErrorMessage

Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

values

BatchErrorDetail[]

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

ComputeNodeIdentityReference

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.
Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.

password

string

Das Kennwort für die Anmeldung beim Registrierungsserver.

registryServer

string

Die Registrierungs-URL
Wenn die Angabe weggelassen wird, ist der Standardwert "docker.io".

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 Taskprozess 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 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

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

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

ExitOptions

Wie der Batch-Dienst reagieren soll, wenn der Task mit einer Beendigungsbedingung fehlschlägt, die von keiner der anderen Eigenschaften abgedeckt ist.
Dieser Wert wird verwendet, wenn der Task mit einem Exitcode ungleich null beendet wird, der nicht in der exitCodes- oder exitCodeRanges-Auflistung aufgeführt ist, mit einem Vorverarbeitungsfehler, wenn die preProcessingError-Eigenschaft nicht vorhanden ist, oder mit einem Dateiuploadfehler, wenn die fileUploadError-Eigenschaft nicht vorhanden ist. Wenn Sie ein nicht standardmäßiges Verhalten für Exitcode 0 verwenden möchten, müssen Sie es explizit mithilfe der exitCodes- oder exitCodeRanges-Auflistung auflisten.

exitCodeRanges

ExitCodeRangeMapping[]

Eine Liste der Aufgabenausgangscodebereiche und wie der Batch-Dienst darauf reagieren soll.

exitCodes

ExitCodeMapping[]

Eine Liste der einzelnen Aufgabenausgangscodes und wie der Batch-Dienst darauf reagieren soll.

fileUploadError

ExitOptions

Wie der Batch-Dienst reagieren soll, wenn ein Dateiuploadfehler auftritt.
Wenn der Task mit einem Exitcode beendet wurde, der über exitCodes oder exitCodeRanges angegeben wurde, und dann ein Dateiuploadfehler aufgetreten ist, hat die vom Exitcode angegebene Aktion Vorrang.

preProcessingError

ExitOptions

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

DependencyAction

Eine Aktion, die der Batch-Dienst für Aufgaben ausführt, die von diesem Task abhängen.
Mögliche Werte sind "satisfy" (sodass abhängige Aufgaben fortgesetzt werden können) und "block" (abhängige Aufgaben warten weiterhin). Batch unterstützt noch nicht das Abbruch abhängiger Aufgaben.

jobAction

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.
Der Standardwert ist keine für Exitcode 0 und wird für alle anderen Exitbedingungen beendet. Wenn die onTaskFailed-Eigenschaft des Auftrags noaction ist, gibt die Angabe dieser Eigenschaft einen Fehler zurück, und die Anforderung zum Hinzufügen von Task schlägt mit einem ungültigen Eigenschaftswertfehler fehl. Wenn Sie die REST-API direkt aufrufen, ist der HTTP-status Code 400 (ungültige Anforderung).

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

ResourceFile[]

Eine Liste der Dateien, die vom Batch-Dienst heruntergeladen werden, bevor die Koordinationsbefehlszeile ausgeführt wird.
Der Unterschied zwischen allgemeinen Ressourcendateien und Taskressourcendateien besteht darin, dass allgemeine Ressourcendateien für alle Teilvorgänge einschließlich des primären heruntergeladen werden, während Taskressourcendateien nur für die primäre Datei heruntergeladen werden. Beachten Sie auch, dass diese Ressourcendateien nicht in das Arbeitsverzeichnis Task heruntergeladen werden, sondern stattdessen in das Stammverzeichnis der Aufgabe (ein Verzeichnis oberhalb des Arbeitsverzeichnisses) heruntergeladen werden. Es gibt eine maximale Größe für die Liste der Ressourcendateien. Wenn die maximale Größe überschritten wird, schlägt die Anforderung fehl, und der Antwortfehlercode lautet RequestEntityTooLarge. In diesem Fall muss die Sammlung von ResourceFiles verkleinert werden. Dies kann mithilfe von .zip-Dateien, Anwendungspaketen oder Docker-Containern erreicht werden.

coordinationCommandLine

string

Die Befehlszeile, die auf allen Computeknoten ausgeführt werden soll, damit diese koordiniert werden können, wenn der primäre Befehl den befehl Standard Task ausführt.
Eine typische Koordinationsbefehlszeile startet einen Hintergrunddienst und überprüft, ob der Dienst für die Verarbeitung knotenübergreifender Nachrichten bereit ist.

numberOfInstances

integer

Die Anzahl von Computeknoten, die für den Task erforderlich sind.
Wenn die Angabe weggelassen wird, ist der Standardwert 1.

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

OutputFileDestination

Das Ziel für die Ausgabedateien.

filePattern

string

Ein Muster, das angibt, welche Dateien hochgeladen werden sollen.
Sowohl relative als auch absolute Pfade werden unterstützt. Relative Pfade sind relativ zum Arbeitsverzeichnis Task. Die folgenden Wildcards werden unterstützt: * entspricht 0 oder mehr Zeichen (z. B. Muster abc* entspricht abc oder abcdef), ** entspricht jedem Verzeichnis, ? entspricht jedem einzelnen Zeichen, [abc] entspricht einem Zeichen in den Klammern und [a-c] einem Zeichen im Bereich. Klammern können eine Negation enthalten, die mit einem nicht angegebenen Zeichen übereinstimmt (z. B. [!abc] entspricht einem beliebigen Zeichen, aber a, b oder c). Wenn ein Dateiname mit "." beginnt, wird er standardmäßig ignoriert, kann aber durch explizite Angabe abgeglichen werden (z. B. stimmt.gif nicht mit .a.gif überein, sondern.gif ). Ein einfaches Beispiel: ***.txt entspricht jeder Datei, die nicht mit "." beginnt und mit .txt im Arbeitsverzeichnis der Aufgabe oder in einem beliebigen Unterverzeichnis endet. Wenn der Dateiname ein Wildcardzeichen enthält, kann er mithilfe von Klammern mit Escapezeichen versehen werden (z. B. würde abc[] mit einer Datei namens abc übereinstimmen). Beachten Sie, dass sowohl \ als auch / unter Windows als Verzeichnistrennzeichen behandelt werden, aber nur / ist unter Linux. Umgebungsvariablen (%var% unter Windows oder $var unter Linux) werden erweitert, bevor das Muster angewendet wird.

uploadOptions

OutputFileUploadOptions

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.
Wenn Sie keine verwaltete Identität verwenden, muss die URL eine Shared Access Signature (SAS) enthalten, die Schreibberechtigungen für den Container erteilt.

identityReference

ComputeNodeIdentityReference

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.
Die Identität muss über Schreibzugriff auf den Azure Blob Storage Container verfügen.

path

string

Das Zielblob oder virtuelle Verzeichnis im Azure Storage-Container.
Wenn filePattern auf eine bestimmte Datei verweist (d. h. keine Wildcards enthält), ist path der Name des Blobs, in das diese Datei hochgeladen werden soll. Wenn filePattern einen oder mehrere Wildcards enthält (und daher mit mehreren Dateien übereinstimmen kann), ist path der Name des virtuellen Blobverzeichnisses (das jedem Blobnamen vorangestellt ist), in das die Dateien hochgeladen werden sollen. Wenn nicht angegeben, werden Die Dateien in den Stamm des Containers mit einem Blobnamen hochgeladen, der ihrem Dateinamen entspricht.

uploadHeaders

HttpHeader[]

Eine Liste von Name-Wert-Paaren für Header, die beim Hochladen von Ausgabedateien verwendet werden sollen
Diese Header werden beim Hochladen von Dateien in Azure Storage angegeben. Offizielles Dokument zu zulässigen Headern beim Hochladen von Blobs: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

Das Ziel, in das eine Datei hochgeladen werden soll.

Name Typ Beschreibung
container

OutputFileBlobContainerDestination

Ein Speicherort 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

OutputFileUploadCondition

Die Bedingungen, unter denen die Taskausgabedatei oder der Satz von Dateien hochgeladen werden soll.
Der Standardwert ist taskcompletion.

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.
Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden.

blobPrefix

string

Das Blobpräfix, das beim Herunterladen von Blobs aus einem Azure Storage-Container verwendet werden soll. Nur die Blobs, deren Namen mit dem angegebenen Präfix beginnen, werden heruntergeladen.
Die -Eigenschaft ist nur gültig, wenn autoStorageContainerName oder storageContainerUrl verwendet wird. Dieses Präfix kann ein partieller Dateiname oder ein Unterverzeichnis sein. Wenn kein Präfix angegeben wird, werden alle Dateien im Container heruntergeladen.

fileMode

string

Das Attribut des Dateiberechtigungsmodus im oktalen Format.
Diese Eigenschaft gilt nur für Dateien, die auf Linux-Computeknoten heruntergeladen werden. Sie wird ignoriert, wenn sie für eine resourceFile-Datei angegeben ist, die auf einen Windows-Computeknoten heruntergeladen wird. Wenn diese Eigenschaft nicht für einen Linux-Computeknoten angegeben ist, wird der Standardwert 0770 auf die Datei angewendet.

filePath

string

Der Speicherort auf dem Computeknoten, in den die Datei(en) heruntergeladen werden sollen, relativ zum Arbeitsverzeichnis des Tasks.
Wenn die httpUrl-Eigenschaft angegeben ist, ist der filePath erforderlich und beschreibt den Pfad, in den die Datei heruntergeladen wird, einschließlich des Dateinamens. Wenn andernfalls die Eigenschaft autoStorageContainerName oder storageContainerUrl angegeben wird, ist filePath optional und das Verzeichnis, in das die Dateien heruntergeladen werden sollen. Wenn filePath als Verzeichnis verwendet wird, wird jede verzeichnisstruktur, die bereits den Eingabedaten zugeordnet ist, vollständig beibehalten und an das angegebene filePath-Verzeichnis angefügt. Der angegebene relative Pfad kann nicht aus dem Arbeitsverzeichnis der Aufgabe herausbrechen (z. B. durch Verwendung von "..").

httpUrl

string

Die URL der herunterzuladenden Bilds.
Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden. Wenn die URL auf Azure Blob Storage zeigt, muss sie von Computeknoten gelesen werden. Es gibt drei Möglichkeiten, eine solche URL für ein Blob in Azure Storage abzurufen: z. B. eine Shared Access Signature (SAS), die Leseberechtigungen für das Blob erteilt, eine verwaltete Identität mit Leseberechtigung verwenden oder die ACL für das Blob oder dessen Container festlegen, um den öffentlichen Zugriff zuzulassen.

identityReference

ComputeNodeIdentityReference

Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf Azure Blob Storage verwendet werden soll, der durch storageContainerUrl oder httpUrl angegeben ist.
Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.

storageContainerUrl

string

Die URL des Blobcontainers in Azure Blob Storage.
Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden. Diese URL muss für Computeknoten lesbar und auflistenbar sein. Es gibt drei Möglichkeiten, eine solche URL für einen Container in Azure Storage abzurufen: eine Shared Access Signature (SAS), die Lese- und Listenberechtigungen für den Container erteilt, eine verwaltete Identität mit Lese- und Listenberechtigungen verwenden oder die ACL für den Container festlegen, um öffentlichen Zugriff zuzulassen.

TaskAddParameter

Eine hinzuzufügende Azure Batch-Aufgabe.

Name Typ Beschreibung
affinityInfo

AffinityInformation

Ein Lokalitätshinweis, der vom Batch-Dienst verwendet werden kann, um einen Computeknoten auszuwählen, auf dem der neue Task gestartet werden soll.

applicationPackageReferences

ApplicationPackageReference[]

Eine Liste der Pakete, die vom Batch-Dienst auf dem Computeknoten bereitgestellt werden, bevor die Befehlszeile ausgeführt wird.
Anwendungspakete werden heruntergeladen und in einem freigegebenen Verzeichnis bereitgestellt, nicht im Aufgabenarbeitsverzeichnis. Wenn sich ein Paket, auf das verwiesen wird, bereits auf dem Knoten befindet und auf dem neuesten Stand ist, wird es daher nicht erneut heruntergeladen. Die vorhandene Kopie auf dem Computeknoten wird verwendet. Wenn ein Paket, auf das verwiesen wird, nicht installiert werden kann, z. B. weil das Paket gelöscht wurde oder der Download fehlgeschlagen ist, schlägt der Task fehl.

authenticationTokenSettings

AuthenticationTokenSettings

Die Einstellungen für ein Authentifizierungstoken, das der Task zum Ausführen von Batch-Dienstvorgängen verwenden kann.
Wenn diese Eigenschaft festgelegt ist, stellt der Batch-Dienst dem Task ein Authentifizierungstoken bereit, das zum Authentifizieren von Batch-Dienstvorgängen verwendet werden kann, ohne dass ein Kontozugriffsschlüssel erforderlich ist. Das Token wird über die umgebungsvariable AZ_BATCH_AUTHENTICATION_TOKEN bereitgestellt. Die Vorgänge, die der Task mit dem Token ausführen kann, hängen von den Einstellungen ab. Beispielsweise kann eine Aufgabe Auftragsberechtigungen anfordern, um dem Auftrag weitere Aufgaben hinzuzufügen, oder die status des Auftrags oder anderer Aufgaben unter dem Auftrag überprüfen.

commandLine

string

Die Befehlszeile des Tasks.
Bei Aufgaben mit mehreren instance wird die Befehlszeile als primäre Aufgabe ausgeführt, nachdem der primäre Task und alle Teilvorgänge die Koordinationsbefehlszeile ausgeführt haben. Die Befehlszeile wird nicht unter einer Shell ausgeführt und kann daher keine Shellfeatures wie die Erweiterung von Umgebungsvariablen nutzen. Wenn Sie solche Features nutzen möchten, sollten Sie die Shell in der Befehlszeile aufrufen, z. B. mit "cmd /c MyCommand" in Windows oder "/bin/sh -c MyCommand" unter Linux. Wenn die Befehlszeile auf Dateipfade verweist, sollte sie einen relativen Pfad (relativ zum Arbeitsverzeichnis Task) oder die von Batch bereitgestellte Umgebungsvariable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) verwenden.

constraints

TaskConstraints

Die Ausführungseinschränkungen, die für diesen Task gelten.
Wenn Sie keine Einschränkungen angeben, entspricht maxTaskRetryCount dem für den Auftrag angegebenen maxTaskRetryCount, maxWallClockTime ist unendlich, und die retentionTime beträgt 7 Tage.

containerSettings

TaskContainerSettings

Die Einstellungen für den Container, unter dem der Task ausgeführt wird.
Wenn für den Pool, der diesen Task ausführen wird, containerConfiguration festgelegt ist, muss auch dies festgelegt werden. Wenn für den Pool, der diesen Task ausführen wird, containerConfiguration nicht festgelegt ist, darf dies nicht festgelegt werden. Wenn dies angegeben ist, werden alle Verzeichnisse rekursiv unterhalb der AZ_BATCH_NODE_ROOT_DIR (dem Stammverzeichnis der Azure Batch Verzeichnisse auf dem Knoten) dem Container zugeordnet, alle Taskumgebungsvariablen werden dem Container zugeordnet, und die Taskbefehlszeile wird im Container ausgeführt. Dateien, die im Container außerhalb von AZ_BATCH_NODE_ROOT_DIR erstellt werden, werden möglicherweise nicht auf den Hostdatenträger wiedergegeben, was bedeutet, dass Batch-Datei-APIs nicht auf diese Dateien zugreifen können.

dependsOn

TaskDependencies

Die Aufgaben, von denen dieser Task abhängt.
Dieser Task wird erst geplant, wenn alle Aufgaben, von denen er abhängt, erfolgreich abgeschlossen wurden. Wenn eine dieser Tasks fehlschlägt und die Wiederholungsanzahl aufgebraucht ist, wird dieser Task nie geplant. Wenn für den Auftrag keine usesTaskDependencies auf true festgelegt ist und dieses Element vorhanden ist, schlägt die Anforderung mit dem Fehlercode TaskDependenciesNotSpecifiedOnJob fehl.

displayName

string

Ein Anzeigename für den Task.
Der Anzeigename muss nicht eindeutig sein und kann Unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten.

environmentSettings

EnvironmentSetting[]

Eine Liste der Umgebungsvariableneinstellungen für den Task.

exitConditions

ExitConditions

Gibt an, wie der Batch-Dienst reagieren soll, wenn der Task abgeschlossen ist.
Wie der Batch-Dienst reagieren soll, wenn der Task abgeschlossen ist.

id

string

Eine Zeichenfolge, die den Task innerhalb des Auftrags eindeutig identifiziert.
Die ID kann eine beliebige Kombination von alphanumerischen Zeichen einschließlich Bindestrichen und Unterstrichen enthalten und darf nicht mehr als 64 Zeichen enthalten. Bei der ID wird die Groß-/Kleinschreibung beibehalten und die Groß-/Kleinschreibung wird nicht beachtet (d. h., Sie verfügen möglicherweise nicht über zwei IDs innerhalb eines Auftrags, die sich nur nach Groß-/Kleinschreibung unterscheiden).

multiInstanceSettings

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.
Aufgaben mit mehreren instance werden häufig zur Unterstützung von MPI-Aufgaben verwendet. Im MPI-Fall schlägt der gesamte Multi-instance-Task fehl, wenn einer der Teiltasks fehlschlägt (z. B. aufgrund des Beendens mit einem Exitcode ungleich 0). Der Task mit mehreren instance wird dann beendet und bis zu seinem Wiederholungslimit wiederholt.

outputFiles

OutputFile[]

Eine Liste der Dateien, die der Batch-Dienst nach dem Ausführen der Befehlszeile vom Computeknoten hochlädt.
Bei Aufgaben mit mehreren instance werden die Dateien nur aus dem Computeknoten hochgeladen, auf dem der primäre Task ausgeführt wird.

requiredSlots

integer

Die Anzahl der Zeitplanungsslots, die der Task ausführen muss.
Der Standardwert ist 1. Die Ausführung eines Tasks auf einem Computeknoten kann nur geplant werden, wenn der Knoten über genügend freie Zeitplanungsslots verfügt. Bei Aufgaben mit mehreren instance muss dies 1 sein.

resourceFiles

ResourceFile[]

Eine Liste der Dateien, die vom Batch-Dienst auf den Computeknoten heruntergeladen werden, bevor die Befehlszeile ausgeführt wird.
Bei Aufgaben mit mehreren instance werden die Ressourcendateien nur auf den Computeknoten heruntergeladen, auf dem der primäre Task ausgeführt wird. Es gibt eine maximale Größe für die Liste der Ressourcendateien. Wenn die maximale Größe überschritten wird, schlägt die Anforderung fehl, und der Antwortfehlercode lautet RequestEntityTooLarge. In diesem Fall muss die Sammlung von ResourceFiles verkleinert werden. Dies kann mithilfe von .zip-Dateien, Anwendungspaketen oder Docker-Containern erreicht werden.

userIdentity

UserIdentity

Die Benutzeridentität, unter der der Task ausgeführt wird.
Wenn der Task nicht angegeben wird, wird er als nicht administrativer Benutzer ausgeführt, der für den Task eindeutig ist.

TaskConstraints

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

Name Typ Beschreibung
maxTaskRetryCount

integer

Die maximale Anzahl von Wiederholungsversuchen für den Task. Der Batch-Dienst führt einen Task erneut aus, wenn der Exitcode ungleich null ist.
Beachten Sie, dass dieser Wert speziell die Anzahl von Wiederholungen für die ausführbare Task-Datei steuert, die auf einen Exitcode ungleich null zurückzuführen ist. Der Batch-Dienst versucht den Task einmal und kann es dann bis zu diesem Grenzwert wiederholen. Wenn die maximale Wiederholungsanzahl beispielsweise 3 beträgt, versucht Batch den Task bis zu 4 Mal (ein erster Versuch und drei Wiederholungen). Wenn die maximale Wiederholungsanzahl 0 ist, versucht der Batch-Dienst den Task nach dem ersten Versuch nicht erneut. Wenn die maximale Wiederholungsanzahl -1 beträgt, wiederholt der Batch-Dienst die Aufgabe ohne Beschränkung. Dies wird jedoch nicht für einen Starttask oder einen Vorgang empfohlen. Der Standardwert ist 0 (keine Wiederholungsversuche).

maxWallClockTime

string

Die maximal verstrichene Zeit, die der Task ausführen kann, gemessen ab dem Zeitpunkt, zu dem der Task gestartet wird. Wenn der Task nicht innerhalb des Zeitlimits abgeschlossen wird, wird er vom Batch-Dienst beendet.
Wenn dies nicht angegeben ist, gibt es keine Zeitliche Begrenzung für die Dauer der Ausführung des Tasks.

retentionTime

string

Die mindeste Zeit, um das Aufgabenverzeichnis auf dem Computeknoten beizubehalten, in 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.
Der Standardwert ist 7 Tage, d. h. das Aufgabenverzeichnis wird 7 Tage lang aufbewahrt, es sei denn, der Computeknoten wird entfernt oder der Auftrag gelöscht.

TaskContainerSettings

Die Containereinstellungen für einen Task.

Name Typ Beschreibung
containerRunOptions

string

Zusätzliche Optionen für den Befehl zum Erstellen von Containern.
Diese zusätzlichen Optionen werden zusätzlich zu den vom Batch-Dienst gesteuerten Optionen als Argumente für den Befehl "docker create" bereitgestellt.

imageName

string

Das Image, das zum Erstellen des Containers verwendet werden soll, in dem die Aufgabe ausgeführt wird.
Dies ist der vollständige Imageverweis, wie für "docker pull" angegeben wird. Wenn kein Tag als Teil des Imagenamens angegeben wird, wird das Tag ":latest" als Standard verwendet.

registry

ContainerRegistry

Die private Registrierung, die das Containerimage enthält.
Diese Einstellung kann weggelassen werden, wenn bereits bei der Poolerstellung angegeben wurde.

workingDirectory

ContainerWorkingDirectory

Der Speicherort des Aufgabenarbeitsverzeichnisses des Containers.
Der Standardwert ist "taskWorkingDirectory".

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

TaskIdRange[]

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.
Die taskIds-Auflistung ist auf insgesamt 64.000 Zeichen (d. h. die kombinierte Länge aller Aufgaben-IDs) beschränkt. Wenn die taskIds-Auflistung die maximale Länge überschreitet, schlägt die Anforderung Task hinzufügen mit dem Fehlercode TaskDependencyListTooLong fehl. In diesem Fall sollten Sie stattdessen Aufgaben-ID-Bereiche verwenden.

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

AutoUserSpecification

Der automatische Benutzer, unter dem der Task ausgeführt wird.
Die Eigenschaften userName und autoUser schließen sich gegenseitig aus. Sie müssen eine angeben, aber nicht beide.

username

string

Der Name der Benutzeridentität, unter der der Task ausgeführt wird.
Die Eigenschaften userName und autoUser schließen sich gegenseitig aus. Sie müssen eine angeben, aber nicht beide.