JobOperations Klasse
JobOperations-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.objectJobOperations
Konstruktor
JobOperations(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 Konto einen Auftrag hinzu. Der Batch-Dienst unterstützt zwei Möglichkeiten, die im Rahmen eines Auftrags ausgeführte Arbeit zu steuern. Im ersten Ansatz gibt der Benutzer eine Auftrags-Manager-Aufgabe an. Der Batch-Dienst startet diesen Task, wenn er bereit ist, den Auftrag zu starten. Der Auftrags-Manager-Task steuert alle anderen Aufgaben, die unter diesem Auftrag ausgeführt werden, mithilfe der Aufgaben-APIs. Beim zweiten Ansatz steuert der Benutzer direkt die Ausführung von Aufgaben unter einem aktiven Auftrag mithilfe der Aufgaben-APIs. Beachten Sie außerdem: Vermeiden Sie beim Benennen von Aufträgen das Einschließen vertraulicher Informationen wie Benutzernamen oder geheimer Projektnamen. Diese Informationen können in Telemetrieprotokollen enthalten sein, auf die Microsoft-Supporttechniker zugreifen können. |
| delete |
Löscht einen Auftrag. Durch das Löschen eines Auftrags werden auch alle Aufgaben gelöscht, die Teil dieses Auftrags sind, sowie alle Auftragsstatistiken. Dadurch wird auch der Aufbewahrungszeitraum für Vorgangsdaten außer Kraft gesetzt. Das heißt, wenn der Auftrag Aufgaben enthält, die noch auf Computeknoten aufbewahrt werden, löscht der Batch-Dienst die Arbeitsverzeichnisse dieser Tasks und ihren gesamten Inhalt. Wenn eine Anforderung zum Löschen von Aufträgen empfangen wird, legt der Batch-Dienst den Auftrag auf den Löschstatus fest. Alle Aktualisierungsvorgänge für einen Auftrag, der sich im Löschzustand befindet, schlagen mit status Code 409 (Konflikt) fehl, mit zusätzlichen Informationen, die angeben, dass der Auftrag gelöscht wird. |
| disable |
Deaktiviert den angegebenen Auftrag und verhindert, dass neue Tasks ausgeführt werden. Der Batch-Dienst versetzt den Auftrag sofort in den deaktivierten Zustand. Batch verwendet dann den disableTasks-Parameter, um zu bestimmen, was mit den derzeit ausgeführten Tasks des Auftrags ausgeführt werden soll. Der Auftrag bleibt im deaktivierten Zustand, bis der Deaktivierungsvorgang abgeschlossen ist und alle Aufgaben gemäß der Option disableTasks behandelt wurden. Der Auftrag wechselt dann in den deaktivierten Zustand. Unter dem Auftrag werden keine neuen Aufgaben gestartet, bis er wieder in den aktiven Zustand wechselt. Wenn Sie versuchen, einen Auftrag zu deaktivieren, der sich in einem anderen Status als aktiv, deaktiviert oder deaktiviert befindet, schlägt die Anforderung mit status Code 409 fehl. |
| enable |
Aktiviert den angegebenen Auftrag, sodass neue Tasks ausgeführt werden können. Wenn Sie diese API aufrufen, legt der Batch-Dienst einen deaktivierten Auftrag auf den Aktivierungszustand fest. Nach Abschluss dieses Vorgangs wechselt der Auftrag in den aktiven Zustand, und die Planung neuer Aufgaben unter dem Auftrag wird fortgesetzt. Der Batch-Dienst lässt nicht zu, dass ein Task länger als 180 Tage im aktiven Zustand bleibt. Wenn Sie also einen Auftrag aktivieren, der aktive Aufgaben enthält, die vor mehr als 180 Tagen hinzugefügt wurden, werden diese Tasks nicht ausgeführt. |
| get |
Ruft Informationen zum angegebenen Auftrag ab. |
| get_task_counts |
Ruft die Anzahl der Aufgaben für den angegebenen Auftrag ab. Die Anzahl der Aufgaben gibt die Anzahl der Aufgaben nach aktivem, ausgeführtem oder abgeschlossenem Vorgangsstatus und die Anzahl der erfolgreichen oder fehlgeschlagenen Aufgaben an. Aufgaben im Vorbereitungszustand werden als ausgeführt gezählt. Beachten Sie, dass die zurückgegebenen Zahlen möglicherweise nicht immer auf dem neuesten Stand sind. Wenn Sie genaue Aufgabenanzahl benötigen, verwenden Sie eine Listenabfrage. |
| list |
Listet alle Aufträge im angegebenen Konto auf. |
| list_from_job_schedule |
Listet die Aufträge auf, die unter dem angegebenen Auftragszeitplan erstellt wurden. |
| list_preparation_and_release_task_status |
Listet die Ausführung status des Auftragsvorbereitungs- und Auftragsfreigabetasks für den angegebenen Auftrag auf den Computeknoten auf, auf denen der Auftrag ausgeführt wurde. Diese API gibt den Task "Auftragsvorbereitung und Auftragsfreigabe" status auf allen Computeknoten zurück, auf denen der Auftragsvorbereitungs- oder Auftragsfreigabetask ausgeführt wurde. Dies schließt Computeknoten ein, die inzwischen aus dem Pool entfernt wurden. Wenn diese API für einen Auftrag ohne Auftragsvorbereitung oder Auftragsfreigabetask aufgerufen wird, gibt der Batch-Dienst HTTP-status Code 409 (Conflict) mit dem Fehlercode JobPreparationTaskNotSpecified zurück. |
| patch |
Updates die Eigenschaften des angegebenen Auftrags. Dadurch werden nur die in der Anforderung angegebenen Auftragseigenschaften ersetzt. Wenn der Auftrag beispielsweise Einschränkungen aufweist und eine Anforderung das constraints-Element nicht angibt, behält der Auftrag die vorhandenen Einschränkungen bei. |
| terminate |
Beendet den angegebenen Auftrag und markiert ihn als abgeschlossen. Wenn eine Anforderung zum Beenden von Aufträgen empfangen wird, legt der Batch-Dienst den Auftrag auf den Status "Beenden" fest. Der Batch-Dienst beendet dann alle ausgeführten Aufgaben, die dem Auftrag zugeordnet sind, und führt alle erforderlichen Auftragsfreigabetasks aus. Anschließend wechselt der Auftrag in den Status Abgeschlossen. Wenn aufgaben im Status "Aktiv" vorhanden sind, verbleiben diese im aktiven Zustand. Sobald ein Auftrag beendet wurde, können keine neuen Aufgaben hinzugefügt werden, und alle verbleibenden aktiven Aufgaben werden nicht geplant. |
| update |
Updates die Eigenschaften des angegebenen Auftrags. Dadurch werden alle aktualisierbaren Eigenschaften des Auftrags vollständig ersetzt. Wenn dem Auftrag beispielsweise Einschränkungen zugeordnet sind und mit dieser Anforderung keine Einschränkungen angegeben werden, entfernt der Batch-Dienst die vorhandenen Einschränkungen. |
add
Fügt dem angegebenen Konto einen Auftrag hinzu.
Der Batch-Dienst unterstützt zwei Möglichkeiten, die im Rahmen eines Auftrags ausgeführte Arbeit zu steuern. Im ersten Ansatz gibt der Benutzer eine Auftrags-Manager-Aufgabe an. Der Batch-Dienst startet diesen Task, wenn er bereit ist, den Auftrag zu starten. Der Auftrags-Manager-Task steuert alle anderen Aufgaben, die unter diesem Auftrag ausgeführt werden, mithilfe der Aufgaben-APIs. Beim zweiten Ansatz steuert der Benutzer direkt die Ausführung von Aufgaben unter einem aktiven Auftrag mithilfe der Aufgaben-APIs. Beachten Sie außerdem: Vermeiden Sie beim Benennen von Aufträgen das Einschließen vertraulicher Informationen wie Benutzernamen oder geheimer Projektnamen. Diese Informationen können in Telemetrieprotokollen enthalten sein, auf die Microsoft-Supporttechniker zugreifen können.
add(job, job_add_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- 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
delete
Löscht einen Auftrag.
Durch das Löschen eines Auftrags werden auch alle Aufgaben gelöscht, die Teil dieses Auftrags sind, sowie alle Auftragsstatistiken. Dadurch wird auch der Aufbewahrungszeitraum für Vorgangsdaten außer Kraft gesetzt. Das heißt, wenn der Auftrag Aufgaben enthält, die noch auf Computeknoten aufbewahrt werden, löscht der Batch-Dienst die Arbeitsverzeichnisse dieser Tasks und ihren gesamten Inhalt. Wenn eine Anforderung zum Löschen von Aufträgen empfangen wird, legt der Batch-Dienst den Auftrag auf den Löschstatus fest. Alle Aktualisierungsvorgänge für einen Auftrag, der sich im Löschzustand befindet, schlagen mit status Code 409 (Konflikt) fehl, mit zusätzlichen Informationen, die angeben, dass der Auftrag gelöscht wird.
delete(job_id, job_delete_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- 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
disable
Deaktiviert den angegebenen Auftrag und verhindert, dass neue Tasks ausgeführt werden.
Der Batch-Dienst versetzt den Auftrag sofort in den deaktivierten Zustand. Batch verwendet dann den disableTasks-Parameter, um zu bestimmen, was mit den derzeit ausgeführten Tasks des Auftrags ausgeführt werden soll. Der Auftrag bleibt im deaktivierten Zustand, bis der Deaktivierungsvorgang abgeschlossen ist und alle Aufgaben gemäß der Option disableTasks behandelt wurden. Der Auftrag wechselt dann in den deaktivierten Zustand. Unter dem Auftrag werden keine neuen Aufgaben gestartet, bis er wieder in den aktiven Zustand wechselt. Wenn Sie versuchen, einen Auftrag zu deaktivieren, der sich in einem anderen Status als aktiv, deaktiviert oder deaktiviert befindet, schlägt die Anforderung mit status Code 409 fehl.
disable(job_id, disable_tasks, job_disable_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- 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
enable
Aktiviert den angegebenen Auftrag, sodass neue Tasks ausgeführt werden können.
Wenn Sie diese API aufrufen, legt der Batch-Dienst einen deaktivierten Auftrag auf den Aktivierungszustand fest. Nach Abschluss dieses Vorgangs wechselt der Auftrag in den aktiven Zustand, und die Planung neuer Aufgaben unter dem Auftrag wird fortgesetzt. Der Batch-Dienst lässt nicht zu, dass ein Task länger als 180 Tage im aktiven Zustand bleibt. Wenn Sie also einen Auftrag aktivieren, der aktive Aufgaben enthält, die vor mehr als 180 Tagen hinzugefügt wurden, werden diese Tasks nicht ausgeführt.
enable(job_id, job_enable_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- 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
get
Ruft Informationen zum angegebenen Auftrag ab.
get(job_id, job_get_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
CloudJob oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
get_task_counts
Ruft die Anzahl der Aufgaben für den angegebenen Auftrag ab.
Die Anzahl der Aufgaben gibt die Anzahl der Aufgaben nach aktivem, ausgeführtem oder abgeschlossenem Vorgangsstatus und die Anzahl der erfolgreichen oder fehlgeschlagenen Aufgaben an. Aufgaben im Vorbereitungszustand werden als ausgeführt gezählt. Beachten Sie, dass die zurückgegebenen Zahlen möglicherweise nicht immer auf dem neuesten Stand sind. Wenn Sie genaue Aufgabenanzahl benötigen, verwenden Sie eine Listenabfrage.
get_task_counts(job_id, job_get_task_counts_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- job_get_task_counts_options
- JobGetTaskCountsOptions
Zusätzliche Parameter für den Vorgang
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
TaskCountsResult oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
list
Listet alle Aufträge im angegebenen Konto auf.
list(job_list_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
Ein Iterator wie instance von CloudJob
Rückgabetyp
Ausnahmen
list_from_job_schedule
Listet die Aufträge auf, die unter dem angegebenen Auftragszeitplan erstellt wurden.
list_from_job_schedule(job_schedule_id, job_list_from_job_schedule_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- job_schedule_id
- str
Die ID des Auftragszeitplans, aus dem Sie eine Liste der Aufträge abrufen möchten.
- job_list_from_job_schedule_options
- JobListFromJobScheduleOptions
Zusätzliche Parameter für den Vorgang
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
Ein Iterator wie instance von CloudJob
Rückgabetyp
Ausnahmen
list_preparation_and_release_task_status
Listet die Ausführung status des Auftragsvorbereitungs- und Auftragsfreigabetasks für den angegebenen Auftrag auf den Computeknoten auf, auf denen der Auftrag ausgeführt wurde.
Diese API gibt den Task "Auftragsvorbereitung und Auftragsfreigabe" status auf allen Computeknoten zurück, auf denen der Auftragsvorbereitungs- oder Auftragsfreigabetask ausgeführt wurde. Dies schließt Computeknoten ein, die inzwischen aus dem Pool entfernt wurden. Wenn diese API für einen Auftrag ohne Auftragsvorbereitung oder Auftragsfreigabetask aufgerufen wird, gibt der Batch-Dienst HTTP-status Code 409 (Conflict) mit dem Fehlercode JobPreparationTaskNotSpecified zurück.
list_preparation_and_release_task_status(job_id, job_list_preparation_and_release_task_status_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- job_list_preparation_and_release_task_status_options
- JobListPreparationAndReleaseTaskStatusOptions
Zusätzliche Parameter für den Vorgang
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
Ein Iterator wie instance von JobPreparationAndReleaseTaskExecutionInformation
Rückgabetyp
Ausnahmen
patch
Updates die Eigenschaften des angegebenen Auftrags.
Dadurch werden nur die in der Anforderung angegebenen Auftragseigenschaften ersetzt. Wenn der Auftrag beispielsweise Einschränkungen aufweist und eine Anforderung das constraints-Element nicht angibt, behält der Auftrag die vorhandenen Einschränkungen bei.
patch(job_id, job_patch_parameter, job_patch_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- 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
terminate
Beendet den angegebenen Auftrag und markiert ihn als abgeschlossen.
Wenn eine Anforderung zum Beenden von Aufträgen empfangen wird, legt der Batch-Dienst den Auftrag auf den Status "Beenden" fest. Der Batch-Dienst beendet dann alle ausgeführten Aufgaben, die dem Auftrag zugeordnet sind, und führt alle erforderlichen Auftragsfreigabetasks aus. Anschließend wechselt der Auftrag in den Status Abgeschlossen. Wenn aufgaben im Status "Aktiv" vorhanden sind, verbleiben diese im aktiven Zustand. Sobald ein Auftrag beendet wurde, können keine neuen Aufgaben hinzugefügt werden, und alle verbleibenden aktiven Aufgaben werden nicht geplant.
terminate(job_id, terminate_reason=None, job_terminate_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- terminate_reason
- str
- 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
update
Updates die Eigenschaften des angegebenen Auftrags.
Dadurch werden alle aktualisierbaren Eigenschaften des Auftrags vollständig ersetzt. Wenn dem Auftrag beispielsweise Einschränkungen zugeordnet sind und mit dieser Anforderung keine Einschränkungen angegeben werden, entfernt der Batch-Dienst die vorhandenen Einschränkungen.
update(job_id, job_update_parameter, job_update_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- 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