Delen via


JobAddParameter Klas

Een Azure Batch taak om toe te voegen.

Alle vereiste parameters moeten worden ingevuld om naar Azure te kunnen worden verzonden.

Overname
JobAddParameter

Constructor

JobAddParameter(*, id: str, pool_info, display_name: str = None, priority: int = None, max_parallel_tasks: int = -1, allow_task_preemption: bool = None, constraints=None, job_manager_task=None, job_preparation_task=None, job_release_task=None, common_environment_settings=None, on_all_tasks_complete=None, on_task_failure=None, metadata=None, uses_task_dependencies: bool = None, network_configuration=None, **kwargs)

Parameters

id
str
Vereist

Vereist. De id kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens, en mag niet meer dan 64 tekens bevatten. De id is hoofdletterbewaarbaar en niet hoofdlettergevoelig (dat wil dat u mogelijk geen twee id's binnen een account hebt die alleen per geval verschillen).

display_name
str
Vereist

De weergavenaam hoeft niet uniek te zijn en mag Unicode-tekens bevatten tot een maximale lengte van 1024.

priority
int
Vereist

De prioriteit van de taak. Prioriteitswaarden kunnen variëren van -1000 tot 1000, waarbij -1000 de laagste prioriteit is en 1000 de hoogste prioriteit. De standaardwaarde is 0.

max_parallel_tasks
int
Vereist

Het maximum aantal taken dat parallel voor de taak kan worden uitgevoerd. De waarde van maxParallelTasks moet -1 of groter zijn dan 0 indien opgegeven. Als u niet opgeeft, is de standaardwaarde -1, wat betekent dat er geen limiet is voor het aantal taken dat in één keer kan worden uitgevoerd. U kunt de maxParallelTasks van een taak bijwerken nadat deze is gemaakt met behulp van de API voor de updatetaak. Standaardwaarde: -1 .

allow_task_preemption
bool
Vereist

Of taken in deze taak kunnen worden afgebroken door andere taken met hoge prioriteit. Als de waarde is ingesteld op Waar, hebben andere taken met hoge prioriteit die naar het systeem worden verzonden voorrang en kunnen taken uit deze taak worden verwijderd. U kunt de allowTaskPreemption van een taak bijwerken nadat deze is gemaakt met behulp van de API voor de updatetaak.

constraints
JobConstraints
Vereist

De uitvoeringsbeperkingen voor de taak.

job_manager_task
JobManagerTask
Vereist

Details van een Taakbeheertaak die moet worden gestart wanneer de taak wordt gestart. Als de taak geen Taakbeheertaak opgeeft, moet de gebruiker expliciet Taken toevoegen aan de taak. Als de taak wel een Job Manager-taak opgeeft, maakt de Batch-service de Job Manager-taak wanneer de taak wordt gemaakt en wordt geprobeerd de Job Manager-taak te plannen voordat andere taken in de taak worden gepland. Het typische doel van de Taakbeheertaak is het beheren en/of bewaken van de taakuitvoering, bijvoorbeeld door te bepalen welke extra taken moeten worden uitgevoerd, te bepalen wanneer het werk is voltooid, enzovoort. (Een Job Manager-taak is echter niet beperkt tot deze activiteiten - het is een volwaardige taak in het systeem en voert de acties uit die nodig zijn voor de taak.) Een Job Manager-taak kan bijvoorbeeld een bestand downloaden dat is opgegeven als parameter, de inhoud van dat bestand analyseren en aanvullende taken verzenden op basis van die inhoud.

job_preparation_task
JobPreparationTask
Vereist

De taak voor het voorbereiden van de taak. Als een taak een taakvoorbereidingstaak heeft, voert de Batch-service de taak voor taakvoorbereiding uit op een knooppunt voordat taken van die taak op dat rekenknooppunt worden gestart.

job_release_task
JobReleaseTask
Vereist

De taak voor het vrijgeven van de taak. Een jobreleasetaak kan niet worden opgegeven zonder ook een taakvoorbereidingstaak voor de taak op te geven. De Batch-service voert de taak jobrelease uit op de knooppunten waarop de taak voor taakvoorbereiding is uitgevoerd. Het primaire doel van de jobreleasetaak is het ongedaan maken van wijzigingen in rekenknooppunten die zijn aangebracht door de taak voor taakvoorbereiding. Voorbeelden van activiteiten zijn het verwijderen van lokale bestanden of het afsluiten van services die zijn gestart als onderdeel van taakvoorbereiding.

common_environment_settings
list[EnvironmentSetting]
Vereist

Afzonderlijke taken kunnen een omgevingsinstelling die hier is opgegeven overschrijven door dezelfde instellingsnaam met een andere waarde op te geven.

pool_info
PoolInformation
Vereist

Vereist. De pool waarop de Batch-service de taken van de taak uitvoert.

on_all_tasks_complete
str of OnAllTasksComplete
Vereist

De actie die de Batch-service moet uitvoeren wanneer alle taken in de taak de status Voltooid hebben. Houd er rekening mee dat als een taak geen taken bevat, alle taken als voltooid worden beschouwd. Deze optie wordt daarom het meest gebruikt bij een Job Manager-taak; Als u automatische taakbeëindiging wilt gebruiken zonder een Job Manager, moet u in eerste instantie onAllTasksComplete instellen op noaction en de jobeigenschappen bijwerken om in te stellen opAllTasksComplete om de taak te beëindigen zodra u klaar bent met het toevoegen van taken. De standaardwaarde is noaction. Mogelijke waarden zijn: 'noAction', 'terminateJob'

on_task_failure
str of OnTaskFailure
Vereist

De actie die de Batch-service moet uitvoeren wanneer een taak in de taak mislukt. Een taak wordt beschouwd als mislukt als het een failureInfo heeft. Een failureInfo wordt ingesteld als de taak wordt voltooid met een afsluitcode die niet nul is nadat het aantal nieuwe pogingen is uitgeput, of als er een fout is opgetreden bij het starten van de taak, bijvoorbeeld vanwege een fout bij het downloaden van een resourcebestand. De standaardwaarde is noaction. Mogelijke waarden zijn: 'noAction', 'performExitOptionsJobAction'

metadata
list[MetadataItem]
Vereist

De Batch-service wijst geen betekenis toe aan metagegevens; het is uitsluitend voor het gebruik van gebruikerscode.

uses_task_dependencies
bool
Vereist

Of taken in de taak afhankelijkheden van elkaar kunnen definiëren. De standaardwaarde is false.

network_configuration
JobNetworkConfiguration
Vereist

De netwerkconfiguratie voor de taak.

Methoden

as_dict

Retourneer een dict die JSONify kan zijn met behulp van json.dump.

Geavanceerd gebruik kan eventueel een callback gebruiken als parameter:

Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dictaat van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de RestAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object.

De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiërarchische resultaatdicteerfunctie.

Bekijk de drie voorbeelden in dit bestand:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Als u XML-serialisatie wilt, kunt u de kwargs-is_xml=True doorgeven.

deserialize

Parseert een str met behulp van de RestAPI-syntaxis en retourneer een model.

enable_additional_properties_sending
from_dict

Een dicteren met behulp van de opgegeven sleutelextractor retourneert een model.

Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

Retourneert de JSON die vanuit dit model naar Azure wordt verzonden.

Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False).

Als u XML-serialisatie wilt, kunt u de kwargs-is_xml=True doorgeven.

validate

Valideer dit model recursief en retourneer een lijst met ValidationError.

as_dict

Retourneer een dict die JSONify kan zijn met behulp van json.dump.

Geavanceerd gebruik kan eventueel een callback gebruiken als parameter:

Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dictaat van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de RestAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object.

De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiërarchische resultaatdicteerfunctie.

Bekijk de drie voorbeelden in dit bestand:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Als u XML-serialisatie wilt, kunt u de kwargs-is_xml=True doorgeven.

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

Parameters

key_transformer
<xref:function>

Een sleuteltransformatorfunctie.

keep_readonly
standaardwaarde: True

Retouren

Een dict JSON-compatibel object

Retourtype

deserialize

Parseert een str met behulp van de RestAPI-syntaxis en retourneer een model.

deserialize(data, content_type=None)

Parameters

data
str
Vereist

Een str met behulp van restAPI-structuur. JSON standaard.

content_type
str
standaardwaarde: None

JSON stelt standaard toepassing/xml in als XML.

Retouren

Een exemplaar van dit model

Uitzonderingen

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Een dicteren met behulp van de opgegeven sleutelextractor retourneert een model.

Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en last_rest_key_case_insensitive_extractor)

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

Parameters

data
dict
Vereist

Een dicteerfunctie met restAPI-structuur

content_type
str
standaardwaarde: None

JSON stelt standaard toepassing/xml in als XML.

key_extractors
standaardwaarde: None

Retouren

Een exemplaar van dit model

Uitzonderingen

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Retourneert de JSON die vanuit dit model naar Azure wordt verzonden.

Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False).

Als u XML-serialisatie wilt, kunt u de kwargs-is_xml=True doorgeven.

serialize(keep_readonly=False, **kwargs)

Parameters

keep_readonly
bool
standaardwaarde: False

Als u de alleen-lezen kenmerken wilt serialiseren

Retouren

Een dict JSON-compatibel object

Retourtype

validate

Valideer dit model recursief en retourneer een lijst met ValidationError.

validate()

Retouren

Een lijst met validatiefouten

Retourtype