CloudJob Klasse

Ein Azure Batch-Auftrag.

Vererbung

Model

CloudJob

Konstruktor

CloudJob(*, id: str = None, display_name: str = None, uses_task_dependencies: bool = None, url: str = None, e_tag: str = None, last_modified=None, creation_time=None, state=None, state_transition_time=None, previous_state=None, previous_state_transition_time=None, priority: int = None, allow_task_preemption: bool = None, max_parallel_tasks: int = -1, constraints=None, job_manager_task=None, job_preparation_task=None, job_release_task=None, common_environment_settings=None, pool_info=None, on_all_tasks_complete=None, on_task_failure=None, network_configuration=None, metadata=None, execution_info=None, stats=None, **kwargs)

Parameter

id

str

Erforderlich

Bei der ID wird die Groß-/Kleinschreibung beibehalten und die Groß-/Kleinschreibung nicht beachtet (d. h. sie verfügen möglicherweise nicht über zwei IDs innerhalb eines Kontos, die sich nur nach Groß- und Kleinschreibung unterscheiden).

display_name

str

Erforderlich

uses_task_dependencies

bool

Erforderlich

Gibt an, ob Aufgaben im Auftrag Abhängigkeiten voneinander definieren können. Die Standardeinstellung ist „false“.

url

str

Erforderlich

e_tag

str

Erforderlich

Dies ist eine undurchsichtige Zeichenfolge. Sie können es verwenden, um zu erkennen, ob sich der Auftrag zwischen Anforderungen geändert hat. Insbesondere können Sie das ETag übergeben, wenn Sie einen Auftrag aktualisieren, um anzugeben, dass Ihre Änderungen nur wirksam werden sollen, wenn der Auftrag in der Zwischenzeit von keiner anderen Person geändert wurde.

last_modified

datetime

Erforderlich

Dies ist der letzte Zeitpunkt, zu dem sich die Daten auf Auftragsebene, z. B. der Auftragsstatus oder die Priorität, geändert haben. Änderungen auf Aufgabenebene, z. B. das Hinzufügen neuer Aufgaben oder aufgabenverändernder Status, werden nicht mit einbeglichen.

creation_time

datetime

Erforderlich

state

str oder JobState

Erforderlich

Der aktuelle Status des Auftrags. Mögliche Werte sind: "aktiv", "deaktivieren", "deaktiviert", "aktivieren", "beenden", "abgeschlossen", "löschen".

state_transition_time

datetime

Erforderlich

previous_state

str oder JobState

Erforderlich

Der vorherige Status des Auftrags. Diese Eigenschaft wird nicht festgelegt, wenn sich der Auftrag im anfangs aktiven Zustand befindet. Mögliche Werte sind: "aktiv", "deaktivieren", "deaktiviert", "aktivieren", "beenden", "abgeschlossen", "löschen".

previous_state_transition_time

datetime

Erforderlich

Diese Eigenschaft wird nicht festgelegt, wenn sich der Auftrag im anfangs aktiven Zustand befindet.

priority

int

Erforderlich

Die Priorität des Auftrags. Die Prioritätswerte reichen von -1.000 bis 1.000. Dabei ist -1.000 die niedrigste Priorität und 1000 die höchste Priorität. Der Standardwert ist 0.

allow_task_preemption

bool

Erforderlich

Gibt an, ob Aufgaben in diesem Auftrag von anderen Aufträgen mit hoher Priorität entfernt werden können. Wenn der Wert auf True festgelegt ist, haben andere Aufträge mit hoher Priorität, die an das System übermittelt werden, Vorrang und können Aufgaben aus diesem Auftrag erneut quequenen. Sie können die allowTaskPreemption eines Auftrags aktualisieren, nachdem er mithilfe der Aktualisierungsauftrags-API erstellt wurde.

max_parallel_tasks

int

Erforderlich

Die maximale Anzahl von Aufgaben, die parallel für den Auftrag ausgeführt werden können. Der Wert von maxParallelTasks muss -1 oder größer als 0 sein, sofern angegeben. Wenn nicht angegeben, ist der Standardwert -1. Dies bedeutet, dass es keine Begrenzung für die Anzahl von Aufgaben gibt, die gleichzeitig ausgeführt werden können. Sie können die maxParallelTasks eines Auftrags aktualisieren, nachdem er mithilfe der Updateauftrags-API erstellt wurde. Standardwert: -1 .

constraints

JobConstraints

Erforderlich

Die Ausführungseinschränkungen für den Auftrag.

job_manager_task

JobManagerTask

Erforderlich

Details zu einer Auftrags-Manager-Aufgabe, die beim Starten des Auftrags gestartet werden soll.

job_preparation_task

JobPreparationTask

Erforderlich

Der Vorgang zur Auftragsvorbereitung. Der Auftragsvorbereitungstask ist eine spezielle Aufgabe, die auf jedem Computeknoten vor jeder anderen Aufgabe des Auftrags ausgeführt wird.

job_release_task

JobReleaseTask

Erforderlich

Der Auftragsfreigabetask. Der Auftragsfreigabetask ist eine spezielle Aufgabe, die am Ende des Auftrags auf jedem Computeknoten ausgeführt wird, der eine andere Aufgabe des Auftrags ausgeführt hat.

common_environment_settings

list[EnvironmentSetting]

Erforderlich

Einzelne Aufgaben können eine hier angegebene Umgebungseinstellung überschreiben, indem sie denselben Einstellungsnamen mit einem anderen Wert angeben.

pool_info

PoolInformation

Erforderlich

Die Pooleinstellungen, die dem Auftrag zugeordnet sind.

on_all_tasks_complete

str oder OnAllTasksComplete

Erforderlich

Die Aktion, die der Batch-Dienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Status Abgeschlossen befinden. Der Standardwert ist noaction. Mögliche Werte: "noAction", "terminateJob"

on_task_failure

str oder OnTaskFailure

Erforderlich

Die Aktion, die der Batch-Dienst ausführen sollte, wenn eine Aufgabe im Auftrag fehlschlägt. Ein Task gilt als fehlgeschlagen, wenn eine failureInfo vorhanden ist. Eine failureInfo wird festgelegt, wenn der Task mit einem Exitcode von ungleich 0 abgeschlossen wird, nachdem die Wiederholungsanzahl ausgeschöpft wurde, oder wenn ein Fehler beim Starten des Tasks aufgetreten ist, z. B. aufgrund eines Fehlers zum Herunterladen einer Ressourcendatei. Der Standardwert ist noaction. Mögliche Werte: "noAction", "performExitOptionsJobAction"

network_configuration

JobNetworkConfiguration

Erforderlich

Die Netzwerkkonfiguration für den Auftrag.

metadata

list[MetadataItem]

Erforderlich

Der Batch-Dienst weist Metadaten keine Bedeutung zu. es dient ausschließlich der Verwendung von Benutzercode.

execution_info

JobExecutionInformation

Erforderlich

Die Ausführungsinformationen für den Auftrag.

stats

JobStatistics

Erforderlich

Ressourcennutzungsstatistiken für die gesamte Lebensdauer des Auftrags. Diese Eigenschaft wird nur aufgefüllt, wenn der CloudJob mit einer expand-Klausel einschließlich des Attributs "stats" abgerufen wurde. andernfalls ist es NULL. Die Statistiken sind möglicherweise nicht sofort verfügbar. Der Batch-Dienst führt ein regelmäßiges Rollup von Statistiken aus. Die typische Verzögerung beträgt etwa 30 Minuten.

Methoden

as_dict	Gibt ein Dict zurück, das mit json.dump JSONify sein kann. Bei erweiterter Verwendung kann optional ein Rückruf als Parameter verwendet werden: Key ist der Attributname, der in Python verwendet wird. Attr_desc ist ein Dict von Metadaten. Enthält derzeit "type" mit dem msrest-Typ und "key" mit dem RestAPI-codierten Schlüssel. Value ist der aktuelle Wert in diesem Objekt. Die zurückgegebene Zeichenfolge wird verwendet, um den Schlüssel zu serialisieren. Wenn der Rückgabetyp eine Liste ist, wird dies als hierarchisches Ergebnisdikt betrachtet. Sehen Sie sich die drei Beispiele in dieser Datei an: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.
deserialize	Analysieren Sie einen Str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück.
enable_additional_properties_sending
from_dict	Analysieren eines Diktats mithilfe des angegebenen Schlüsselextraktors gibt ein Modell zurück. Standardmäßig werden Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor) berücksichtigt.
is_xml_model
serialize	Gibt den JSON-Code zurück, der von diesem Modell an Azure gesendet würde. Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False). Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.
validate	Überprüfen Sie dieses Modell rekursiv, und geben Sie eine Liste von ValidationError zurück.

as_dict

Gibt ein Dict zurück, das mit json.dump JSONify sein kann.

Bei erweiterter Verwendung kann optional ein Rückruf als Parameter verwendet werden:

Key ist der Attributname, der in Python verwendet wird. Attr_desc ist ein Dict von Metadaten. Enthält derzeit "type" mit dem msrest-Typ und "key" mit dem RestAPI-codierten Schlüssel. Value ist der aktuelle Wert in diesem Objekt.

Die zurückgegebene Zeichenfolge wird verwendet, um den Schlüssel zu serialisieren. Wenn der Rückgabetyp eine Liste ist, wird dies als hierarchisches Ergebnisdikt betrachtet.

Sehen Sie sich die drei Beispiele in dieser Datei an:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parameter

key_transformer

<xref:function>

Eine Schlüsseltransformerfunktion.

keep_readonly

Standardwert: True

Gibt zurück

Ein JSON-kompatibles Objekt mit Dict

Rückgabetyp

dict

deserialize

Analysieren Sie einen Str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück.

deserialize(data, content_type=None)

Parameter

data

str

Erforderlich

Eine Str-Instanz mit RestAPI-Struktur. JSON standardmäßig.

content_type

str

Standardwert: None

JSON standardmäßig, legen Sie application/xml if XML fest.

Gibt zurück

Ein instance dieses Modells

Ausnahmen

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analysieren eines Diktats mithilfe des angegebenen Schlüsselextraktors gibt ein Modell zurück.

Standardmäßig werden Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor) berücksichtigt.

from_dict(data, key_extractors=None, content_type=None)

Parameter

data

dict

Erforderlich

Ein Diktat mithilfe der RestAPI-Struktur

content_type

str

Standardwert: None

JSON standardmäßig, legen Sie application/xml if XML fest.

key_extractors

Standardwert: None

Gibt zurück

Ein instance dieses Modells

Ausnahmen

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Gibt den JSON-Code zurück, der von diesem Modell an Azure gesendet würde.

Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False).

Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

serialize(keep_readonly=False, **kwargs)

Parameter

keep_readonly

bool

Standardwert: False

Wenn Sie die schreibgeschützten Attribute serialisieren möchten

Gibt zurück

Ein JSON-kompatibles Objekt mit Dict

Rückgabetyp

dict

validate

Überprüfen Sie dieses Modell rekursiv, und geben Sie eine Liste von ValidationError zurück.

validate()

Gibt zurück

Eine Liste von Überprüfungsfehlern

Rückgabetyp

list