Freigeben über

Task - Update

  • Referenz
Dienst:
Batch Service
API-Version:
2024-07-01.20.0

Aktualisiert die Eigenschaften des angegebenen Vorgangs.

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2024-07-01.20.0
Mit optionalen Parametern: 
PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?timeout={timeout}&api-version=2024-07-01.20.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, der die Aufgabe enthält.
taskId
 path True

string

Die ID der zu aktualisierenden Aufgabe.
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 30 Sekunden. Wenn der Wert größer als 30 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.
If-Match

string

Ein ETag-Wert, der der Version der Ressource zugeordnet ist, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn das aktuelle ETag der Ressource für den Dienst exakt mit dem vom Client angegebenen Wert übereinstimmt.
If-None-Match

string

Ein ETag-Wert, der der Version der Ressource zugeordnet ist, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn das aktuelle ETag der Ressource für den Dienst nicht mit dem vom Client angegebenen Wert übereinstimmt.
If-Modified-Since

string

date-time-rfc1123

Ein Zeitstempel, der die uhrzeit der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource für den Dienst seit dem angegebenen Zeitpunkt geändert wurde.
If-Unmodified-Since

string

date-time-rfc1123

Ein Zeitstempel, der die uhrzeit der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource für den Dienst seit dem angegebenen Zeitpunkt nicht geändert wurde.

Anforderungstext

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

Name Typ Beschreibung
constraints

TaskConstraints

Einschränkungen, die für diesen Vorgang gelten.
Wenn sie weggelassen wird, erhält der Vorgang die Standardeinschränkungen. Bei Aufgaben mit mehreren Instanzen gilt die Aktualisierung der Aufbewahrungszeit nur für den primären Vorgang und nicht für Teilvorgänge.

Antworten

Name Typ Beschreibung
200 OK

Die Anforderung an den Batchdienst war erfolgreich.

Header

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

BatchError

Der Fehler vom Batchdienst.

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

Task update

Beispielanforderung

PUT account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2024-07-01.20.0



{
  "constraints": {
    "maxWallClockTime": "PT1H",
    "maxTaskRetryCount": 3,
    "retentionTime": "PT1H"
  }
}

Beispiel für eine Antwort

Statuscode:
200

Definitionen

Name Beschreibung
BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail

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

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

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

Die Gruppe von Änderungen, die an einem Vorgang vorgenommen werden sollen.

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

ErrorMessage

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
values

BatchErrorDetail[]

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.

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.

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.
Beachten Sie, dass dieser Wert die Anzahl der Wiederholungen für die ausführbare Aufgabe aufgrund eines Nichtzero-Beendigungscodes steuert. Der Batchdienst versucht die Aufgabe einmal, und kann dann bis zu diesem Grenzwert erneut versuchen. Wenn die maximale Wiederholungsanzahl beispielsweise 3 ist, versucht Batch die Aufgabe bis zu 4 Mal (ein erster Versuch und 3 Wiederholungsversuche). Wenn die maximale Wiederholungsanzahl 0 ist, versucht der Batchdienst den Vorgang nach dem ersten Versuch nicht erneut. Wenn die maximale Wiederholungsanzahl -1 ist, wiederholt der Batchdienst den Vorgang ohne Beschränkung, dies wird jedoch nicht für einen Startvorgang oder einen Vorgang empfohlen. Der Standardwert ist 0 (keine Wiederholungen).
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.
Wenn dies nicht angegeben ist, gibt es kein Zeitlimit für die Dauer der Ausführung des Vorgangs.
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.
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.

TaskUpdateParameter

Die Gruppe von Änderungen, die an einem Vorgang vorgenommen werden sollen.

Name Typ Beschreibung
constraints

TaskConstraints

Einschränkungen, die für diesen Vorgang gelten.
Wenn sie weggelassen wird, erhält der Vorgang die Standardeinschränkungen. Bei Aufgaben mit mehreren Instanzen gilt die Aktualisierung der Aufbewahrungszeit nur für den primären Vorgang und nicht für Teilvorgänge.