Freigeben über


JobPatchParameter Klasse

Der Satz von Änderungen, die an einem Auftrag vorgenommen werden sollen.

Vererbung
JobPatchParameter

Konstruktor

JobPatchParameter(*, priority: int = None, max_parallel_tasks: int = None, allow_task_preemption: bool = None, on_all_tasks_complete=None, constraints=None, pool_info=None, metadata=None, **kwargs)

Parameter

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. Wenn sie nicht angegeben wird, bleibt die Priorität des Auftrags unverändert.

max_parallel_tasks
int
Erforderlich

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

allow_task_preemption
bool
Erforderlich

Gibt an, ob Aufgaben in diesem Auftrag von anderen Aufträgen mit hoher Priorität vorzeitig 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 in die Warteschlange stellen. Sie können die allowTaskPreemption eines Auftrags aktualisieren, nachdem er mithilfe der Updateauftrags-API erstellt wurde.

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. Wenn sie nicht angegeben wird, bleibt das Vervollständigungsverhalten unverändert. Sie dürfen den Wert von terminatejob nicht in noaction ändern. Das heißt, wenn Sie die automatische Auftragsbeendigung aktiviert haben, können Sie ihn nicht wieder deaktivieren. Wenn Sie dies versuchen, schlägt die Anforderung mit der Fehlerantwort "ungültiger Eigenschaftswert" fehl. Wenn Sie die REST-API direkt aufrufen, ist der HTTP-status Code 400 (ungültige Anforderung). Mögliche Werte: "noAction", "terminateJob"

constraints
JobConstraints
Erforderlich

Die Ausführungseinschränkungen für den Auftrag. Wenn sie nicht angegeben werden, bleiben die vorhandenen Ausführungseinschränkungen unverändert.

pool_info
PoolInformation
Erforderlich

Der Pool, in dem der Batch-Dienst die Aufgaben des Auftrags ausführt. Sie können den Pool für einen Auftrag nur ändern, wenn der Auftrag deaktiviert ist. Der Patchauftragsaufruf schlägt fehl, wenn Sie das poolInfo-Element einschließen und der Auftrag nicht deaktiviert ist. Wenn Sie eine autoPoolSpecification in poolInfo angeben, kann nur die keepAlive-Eigenschaft der autoPoolSpecification aktualisiert werden, und dann nur, wenn die autoPoolSpecification über eine poolLifetimeOption von Job verfügt (andere Auftragseigenschaften können wie normal aktualisiert werden). Wenn er nicht angegeben wird, wird der Auftrag weiterhin in seinem aktuellen Pool ausgeführt.

metadata
list[MetadataItem]
Erforderlich

Wenn sie nicht angegeben wird, bleiben die vorhandenen Auftragsmetadaten unverändert.

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 Diktat 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 hierarchische Ergebnisdikt betrachtet.

Sehen Sie sich die drei Beispiele in dieser Datei an:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

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

deserialize

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

enable_additional_properties_sending
from_dict

Analysieren eines Diktats mit dem angegebenen Schlüsselextraktor gibt ein Modell zurück.

Berücksichtigen Sie standardmäßig Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

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

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

Wenn Sie eine 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 Diktat 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 hierarchische Ergebnisdikt betrachtet.

Sehen Sie sich die drei Beispiele in dieser Datei an:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Wenn Sie eine 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üsseltransformatorfunktion.

keep_readonly
Standardwert: True

Gibt zurück

Ein JSON-kompatibles Diktatobjekt

Rückgabetyp

deserialize

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

deserialize(data, content_type=None)

Parameter

data
str
Erforderlich

Eine str-Struktur, die die RestAPI-Struktur verwendet. Standardmäßig JSON.

content_type
str
Standardwert: None

Json standardmäßig, legen Sie application/xml fest, wenn XML.

Gibt zurück

Eine instance dieses Modells

Ausnahmen

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analysieren eines Diktats mit dem angegebenen Schlüsselextraktor gibt ein Modell zurück.

Berücksichtigen Sie standardmäßig Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor)

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 fest, wenn XML.

key_extractors
Standardwert: None

Gibt zurück

Eine 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 wird.

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

Wenn Sie eine 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 Diktatobjekt

Rückgabetyp

validate

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

validate()

Gibt zurück

Eine Liste mit Validierungsfehlern

Rückgabetyp