TaskOperations Klasse
TaskOperations-Vorgänge.
Sie sollten diese Klasse nicht direkt instanziieren, sondern einen Client instance erstellen, der sie für Sie erstellt und als Attribut anfügen wird.
- Vererbung
-
builtins.objectTaskOperations
Konstruktor
TaskOperations(client, config, serializer, deserializer)Parameter
- client
Client für Dienstanforderungen.
- config
Konfiguration des Dienstclients.
- serializer
Ein Objektmodellserialisierungsprogramm.
- deserializer
Ein Objektmodell-Deserialisierer.
Variablen
- api_version
API-Version, die für die Anforderung verwendet werden soll. Konstanter Wert: "2023-05-01.17.0".
Methoden
| 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. |
| add_collection |
Fügt dem angegebenen Auftrag eine Auflistung von Aufgaben hinzu. Beachten Sie, dass jede Aufgabe über eine eindeutige ID verfügen muss. Der Batch-Dienst gibt die Ergebnisse für jede Aufgabe möglicherweise nicht in derselben Reihenfolge zurück, in der die Aufgaben in dieser Anforderung übermittelt wurden. Wenn für den Server ein Timeout besteht 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 es am Benutzer liegt, Fehler beim erneuten Ausstellen einer Anforderung ordnungsgemäß zu behandeln. Beispielsweise sollten Sie während eines Wiederholungsversuchs dieselben Aufgaben-IDs verwenden, damit bei erfolgreicher Ausführung des vorherigen Vorgangs nicht unerwartet zusätzliche Aufgaben erstellt werden. Wenn die Antwort Aufgaben enthält, die nicht hinzugefügt werden konnten, kann ein Client die Anforderung wiederholen. Bei einem Wiederholungsversuch ist es am effizientesten, nur Aufgaben erneut zu übermitteln, die nicht hinzugefügt werden konnten, und Aufgaben wegzulassen, die beim ersten Versuch erfolgreich hinzugefügt wurden. Die maximale Lebensdauer einer Aufgabe vom Hinzufügen bis zum Abschluss beträgt 180 Tage. Wenn eine Aufgabe nicht innerhalb von 180 Tagen nach dem Hinzufügen abgeschlossen wurde, wird sie vom Batch-Dienst beendet und in dem Zustand belassen, in dem sie sich zu diesem Zeitpunkt befand. |
| delete |
Löscht einen Task aus dem angegebenen Auftrag. Wenn ein Task gelöscht wird, werden alle Dateien in seinem Verzeichnis auf dem Computeknoten, auf dem er ausgeführt wurde, ebenfalls gelöscht (unabhängig von der Aufbewahrungszeit). Bei Aufgaben mit mehreren instance gilt der Vorgang "Task löschen" synchron für die primäre Aufgabe. Teiltasks und ihre Dateien werden dann asynchron im Hintergrund gelöscht. |
| get |
Ruft Informationen zum angegebenen Task ab. Informationen wie affinityId, executionInfo und nodeInfo finden Sie bei Aufgaben mit mehreren instance auf den primären Task. Verwenden Sie die Listenuntertasks-API, um Informationen zu Teilvorgängen abzurufen. |
| list |
Listet alle Aufgaben auf, die dem angegebenen Auftrag zugeordnet sind. Informationen wie affinityId, executionInfo und nodeInfo finden Sie bei Aufgaben mit mehreren instance auf den primären Task. Verwenden Sie die Listenuntertasks-API, um Informationen zu Teilvorgängen abzurufen. |
| list_subtasks |
Listet alle Teilvorgänge auf, die dem angegebenen Multi-instance-Task zugeordnet sind. Wenn der Task kein Task mit mehreren instance ist, wird eine leere Auflistung zurückgegeben. |
| reactivate |
Reaktiviert einen Task, sodass er auch dann wieder ausgeführt werden kann, wenn die Wiederholungsanzahl erschöpft ist. Durch die Reaktivierung kann ein Vorgang bis zur maximalen Wiederholungsanzahl erneut ausgeführt werden. Der Status des Vorgangs wird in aktiv geändert. Da sich der Vorgang nicht mehr im Zustand abgeschlossen befindet, sind nach der Reaktivierung keine vorherigen Exitcode- oder Fehlerinformationen mehr verfügbar. Jedes Mal, wenn eine Aufgabe erneut aktiviert wird, wird die Wiederholungsanzahl auf 0 zurückgesetzt. Die Reaktivierung schlägt für Aufgaben fehl, die nicht abgeschlossen wurden oder die zuvor erfolgreich abgeschlossen wurden (mit dem Exitcode 0). Darüber hinaus tritt ein Fehler auf, wenn der Auftrag abgeschlossen wurde (oder beendet oder gelöscht wird). |
| terminate |
Beendet den angegebenen Task. Wenn der Task beendet wurde, wechselt er in den Status Abgeschlossen. Bei Aufgaben mit mehreren instance wird der Vorgang Task beenden synchron auf die primäre Aufgabe angewendet. Teiltasks werden dann asynchron im Hintergrund beendet. |
| update |
Updates die Eigenschaften des angegebenen Vorgangs. |
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.
add(job_id, task, task_add_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
None oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
add_collection
Fügt dem angegebenen Auftrag eine Auflistung von Aufgaben hinzu.
Beachten Sie, dass jede Aufgabe über eine eindeutige ID verfügen muss. Der Batch-Dienst gibt die Ergebnisse für jede Aufgabe möglicherweise nicht in derselben Reihenfolge zurück, in der die Aufgaben in dieser Anforderung übermittelt wurden. Wenn für den Server ein Timeout besteht 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 es am Benutzer liegt, Fehler beim erneuten Ausstellen einer Anforderung ordnungsgemäß zu behandeln. Beispielsweise sollten Sie während eines Wiederholungsversuchs dieselben Aufgaben-IDs verwenden, damit bei erfolgreicher Ausführung des vorherigen Vorgangs nicht unerwartet zusätzliche Aufgaben erstellt werden. Wenn die Antwort Aufgaben enthält, die nicht hinzugefügt werden konnten, kann ein Client die Anforderung wiederholen. Bei einem Wiederholungsversuch ist es am effizientesten, nur Aufgaben erneut zu übermitteln, die nicht hinzugefügt werden konnten, und Aufgaben wegzulassen, die beim ersten Versuch erfolgreich hinzugefügt wurden. Die maximale Lebensdauer einer Aufgabe vom Hinzufügen bis zum Abschluss beträgt 180 Tage. Wenn eine Aufgabe nicht innerhalb von 180 Tagen nach dem Hinzufügen abgeschlossen wurde, wird sie vom Batch-Dienst beendet und in dem Zustand belassen, in dem sie sich zu diesem Zeitpunkt befand.
add_collection(job_id, value, task_add_collection_options=None, custom_headers=None, raw=False, threads=0, **operation_config)Parameter
- value
- list of TaskAddParameter
Die Auflistung der hinzuzufügenden Aufgaben. Die serialisierte Gesamtgröße dieser Sammlung muss kleiner als 4 MB sein. Wenn sie größer als 4 MB ist (z. B. wenn jede Aufgabe über 100 Ressourcendateien oder Umgebungsvariablen verfügt), schlägt die Anforderung mit dem Code "RequestBodyTooLarge" fehl und sollte mit weniger Aufgaben erneut durchgeführt werden.
- task_add_collection_options
- TaskAddCollectionOptions
Zusätzliche Parameter für den Vorgang
- threads
- int
Anzahl von Threads, die beim Hinzufügen von Aufgaben parallel verwendet werden sollen. Wenn angegeben und größer als 0, werden zusätzliche Threads gestartet, um Anforderungen zu übermitteln, und warten Sie, bis sie abgeschlossen sind. Andernfalls werden add_collection Anforderungen sequenziell in Standard Thread übermittelt.
Gibt zurück
TaskAddCollectionResult oder ClientRawResponse , wenn raw=true
Rückgabetyp
Ausnahmen
delete
Löscht einen Task aus dem angegebenen Auftrag.
Wenn ein Task gelöscht wird, werden alle Dateien in seinem Verzeichnis auf dem Computeknoten, auf dem er ausgeführt wurde, ebenfalls gelöscht (unabhängig von der Aufbewahrungszeit). Bei Aufgaben mit mehreren instance gilt der Vorgang "Task löschen" synchron für die primäre Aufgabe. Teiltasks und ihre Dateien werden dann asynchron im Hintergrund gelöscht.
delete(job_id, task_id, task_delete_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
None oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
get
Ruft Informationen zum angegebenen Task ab.
Informationen wie affinityId, executionInfo und nodeInfo finden Sie bei Aufgaben mit mehreren instance auf den primären Task. Verwenden Sie die Listenuntertasks-API, um Informationen zu Teilvorgängen abzurufen.
get(job_id, task_id, task_get_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
CloudTask oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
list
Listet alle Aufgaben auf, die dem angegebenen Auftrag zugeordnet sind.
Informationen wie affinityId, executionInfo und nodeInfo finden Sie bei Aufgaben mit mehreren instance auf den primären Task. Verwenden Sie die Listenuntertasks-API, um Informationen zu Teilvorgängen abzurufen.
list(job_id, task_list_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
Ein Iterator wie instance von CloudTask
Rückgabetyp
Ausnahmen
list_subtasks
Listet alle Teilvorgänge auf, die dem angegebenen Multi-instance-Task zugeordnet sind.
Wenn der Task kein Task mit mehreren instance ist, wird eine leere Auflistung zurückgegeben.
list_subtasks(job_id, task_id, task_list_subtasks_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- task_list_subtasks_options
- TaskListSubtasksOptions
Zusätzliche Parameter für den Vorgang
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
CloudTaskListSubtasksResult oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
reactivate
Reaktiviert einen Task, sodass er auch dann wieder ausgeführt werden kann, wenn die Wiederholungsanzahl erschöpft ist.
Durch die Reaktivierung kann ein Vorgang bis zur maximalen Wiederholungsanzahl erneut ausgeführt werden. Der Status des Vorgangs wird in aktiv geändert. Da sich der Vorgang nicht mehr im Zustand abgeschlossen befindet, sind nach der Reaktivierung keine vorherigen Exitcode- oder Fehlerinformationen mehr verfügbar. Jedes Mal, wenn eine Aufgabe erneut aktiviert wird, wird die Wiederholungsanzahl auf 0 zurückgesetzt. Die Reaktivierung schlägt für Aufgaben fehl, die nicht abgeschlossen wurden oder die zuvor erfolgreich abgeschlossen wurden (mit dem Exitcode 0). Darüber hinaus tritt ein Fehler auf, wenn der Auftrag abgeschlossen wurde (oder beendet oder gelöscht wird).
reactivate(job_id, task_id, task_reactivate_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- task_reactivate_options
- TaskReactivateOptions
Zusätzliche Parameter für den Vorgang
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
None oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
terminate
Beendet den angegebenen Task.
Wenn der Task beendet wurde, wechselt er in den Status Abgeschlossen. Bei Aufgaben mit mehreren instance wird der Vorgang Task beenden synchron auf die primäre Aufgabe angewendet. Teiltasks werden dann asynchron im Hintergrund beendet.
terminate(job_id, task_id, task_terminate_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- task_terminate_options
- TaskTerminateOptions
Zusätzliche Parameter für den Vorgang
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
None oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
update
Updates die Eigenschaften des angegebenen Vorgangs.
update(job_id, task_id, constraints=None, task_update_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- constraints
- TaskConstraints
Einschränkungen, die für diesen Task gelten. Wenn sie nicht angegeben wird, erhält der Task die Standardeinschränkungen. Bei Aufgaben mit mehreren instance gilt die Aktualisierung der Aufbewahrungszeit nur für den primären Task und nicht für Teilvorgänge.
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
None oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
Attribute
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>
Azure SDK for Python
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für