TaskAddParameter Klass

En Azure Batch uppgift att lägga till.

Batch försöker utföra uppgifter igen när en återställningsåtgärd utlöses på en nod. Exempel på återställningsåtgärder är (men är inte begränsade till) när en nod med feltillstånd startas om eller en beräkningsnod försvinner på grund av värdfel. Återförsök på grund av återställningsåtgärder är oberoende av och räknas inte mot maxTaskRetryCount. Även om maxTaskRetryCount är 0 kan ett internt återförsök på grund av en återställningsåtgärd inträffa. Därför bör alla aktiviteter vara idempotent. Det innebär att uppgifter måste tolerera att avbrytas och startas om utan att orsaka några skador eller duplicerade data. Bästa praxis för långvariga uppgifter är att använda någon form av kontrollpunkter.

Alla obligatoriska parametrar måste fyllas i för att kunna skickas till Azure.

Arv
TaskAddParameter

Konstruktor

TaskAddParameter(*, id: str, command_line: str, display_name: str = None, container_settings=None, exit_conditions=None, resource_files=None, output_files=None, environment_settings=None, affinity_info=None, constraints=None, required_slots: int = None, user_identity=None, multi_instance_settings=None, depends_on=None, application_package_references=None, authentication_token_settings=None, **kwargs)

Parametrar

id
str
Obligatorisk

Krävs. ID:t kan innehålla valfri kombination av alfanumeriska tecken, inklusive bindestreck och understreck, och får inte innehålla fler än 64 tecken. ID:t är skiftlägesbevarande och skiftlägesokänsligt (dvs. du kanske inte har två ID:n i ett jobb som endast skiljer sig från fall till fall).

display_name
str
Obligatorisk

Visningsnamnet behöver inte vara unikt och kan innehålla unicode-tecken upp till en maximal längd på 1 024.

command_line
str
Obligatorisk

Krävs. För aktiviteter med flera instanser körs kommandoraden som den primära aktiviteten, efter att den primära aktiviteten och alla underaktiviteter har slutfört körningen av kommandoraden för samordning. Kommandoraden körs inte under ett gränssnitt och kan därför inte dra nytta av gränssnittsfunktioner som expansion av miljövariabler. Om du vill dra nytta av sådana funktioner bör du anropa gränssnittet på kommandoraden, till exempel med "cmd /c MyCommand" i Windows eller "/bin/sh -c MyCommand" i Linux. Om kommandoraden refererar till filsökvägar bör den använda en relativ sökväg (i förhållande till arbetskatalogen Uppgift) eller använda miljövariabeln som tillhandahålls av Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

container_settings
TaskContainerSettings
Obligatorisk

Inställningarna för containern under vilken aktiviteten körs. Om den pool som ska köra den här aktiviteten har containerConfiguration angivet måste detta också anges. Om den pool som ska köra uppgiften inte har containerConfiguration angivet får detta inte anges. När detta anges mappas alla kataloger rekursivt under AZ_BATCH_NODE_ROOT_DIR (roten av Azure Batch kataloger på noden) till containern, alla miljövariabler för aktivitet mappas till containern och kommandoraden Task körs i containern. Filer som skapas i containern utanför AZ_BATCH_NODE_ROOT_DIR kanske inte återspeglas på värddisken, vilket innebär att Batch-fil-API:er inte kommer åt dessa filer.

exit_conditions
ExitConditions
Obligatorisk

Hur Batch-tjänsten ska svara när uppgiften har slutförts.

resource_files
list[ResourceFile]
Obligatorisk

För aktiviteter med flera instanser laddas resursfilerna bara ned till beräkningsnoden där den primära aktiviteten körs. Det finns en maximal storlek för listan över resursfiler. När maxstorleken överskrids misslyckas begäran och svarsfelkoden är RequestEntityTooLarge. Om detta inträffar måste mängden ResourceFiles minskas i storlek. Detta kan uppnås med hjälp av .zip filer, programpaket eller Docker-containrar.

output_files
list[OutputFile]
Obligatorisk

För aktiviteter med flera instanser laddas filerna bara upp från beräkningsnoden där den primära aktiviteten körs.

environment_settings
list[EnvironmentSetting]
Obligatorisk
affinity_info
AffinityInformation
Obligatorisk

En lokalitetstips som kan användas av Batch-tjänsten för att välja en beräkningsnod som den nya aktiviteten ska startas på.

constraints
TaskConstraints
Obligatorisk

De körningsbegränsningar som gäller för den här aktiviteten. Om du inte anger begränsningar är maxTaskRetryCount det maxTaskRetryCount som angetts för jobbet, maxWallClockTime är oändligt och retentionTime är 7 dagar.

required_slots
int
Obligatorisk

Antalet schemaläggningsplatser som aktiviteten måste köra. Standard är 1. En aktivitet kan bara schemaläggas att köras på en beräkningsnod om noden har tillräckligt med tillgängliga kostnadsfria schemaläggningsplatser. För uppgifter med flera instanser måste detta vara 1.

user_identity
UserIdentity
Obligatorisk

Användaridentiteten som aktiviteten körs under. Om den utelämnas körs aktiviteten som en icke-administrativ användare som är unik för aktiviteten.

multi_instance_settings
MultiInstanceSettings
Obligatorisk

Ett objekt som anger att aktiviteten är en aktivitet med flera instanser och innehåller information om hur du kör multiinstansaktiviteten.

depends_on
TaskDependencies
Obligatorisk

De aktiviteter som den här aktiviteten är beroende av. Den här aktiviteten schemaläggs inte förrän alla aktiviteter som den är beroende av har slutförts. Om någon av dessa aktiviteter misslyckas och tar bort antalet återförsök kommer den här aktiviteten aldrig att schemaläggas. Om jobbet inte har usesTaskDependencies inställt på true och det här elementet finns, misslyckas begäran med felkoden TaskDependenciesNotSpecifiedOnJob.

application_package_references
list[ApplicationPackageReference]
Obligatorisk

Programpaket laddas ned och distribueras till en delad katalog, inte till arbetskatalogen Aktivitet. Om ett refererat paket redan finns på noden och är uppdaterat laddas det därför inte ned igen. den befintliga kopian på beräkningsnoden används. Om det inte går att installera ett refererat paket, till exempel på grund av att paketet har tagits bort eller eftersom nedladdningen misslyckades, misslyckas uppgiften.

authentication_token_settings
AuthenticationTokenSettings
Obligatorisk

Inställningarna för en autentiseringstoken som aktiviteten kan använda för att utföra Batch-tjänståtgärder. Om den här egenskapen anges tillhandahåller Batch-tjänsten uppgiften med en autentiseringstoken som kan användas för att autentisera Batch-tjänståtgärder utan att kräva en kontoåtkomstnyckel. Token tillhandahålls via miljövariabeln AZ_BATCH_AUTHENTICATION_TOKEN. Vilka åtgärder som aktiviteten kan utföra med hjälp av token beror på inställningarna. En aktivitet kan till exempel begära jobbbehörigheter för att lägga till andra aktiviteter i jobbet eller kontrollera status för jobbet eller andra aktiviteter under jobbet.

Metoder

as_dict

Returnera en diktamen som kan vara JSONify med hjälp av json.dump.

Avancerad användning kan också använda ett återanrop som parameter:

Nyckeln är det attributnamn som används i Python. Attr_desc är en diktering av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med den RestAPI-kodade nyckeln. Värde är det aktuella värdet i det här objektet.

Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt.

Se de tre exemplen i den här filen:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

deserialize

Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.

enable_additional_properties_sending
from_dict

Parsa en diktamen med hjälp av den angivna nyckelextraktorn returnerar en modell.

Som standard bör du överväga nyckelextraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

Returnera den JSON som skulle skickas till Azure från den här modellen.

Det här är ett alias för as_dict(full_restapi_key_transformer, keep_readonly=False).

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

validate

Verifiera den här modellen rekursivt och returnera en lista över ValidationError.

as_dict

Returnera en diktamen som kan vara JSONify med hjälp av json.dump.

Avancerad användning kan också använda ett återanrop som parameter:

Nyckeln är det attributnamn som används i Python. Attr_desc är en diktering av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med den RestAPI-kodade nyckeln. Värde är det aktuella värdet i det här objektet.

Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt.

Se de tre exemplen i den här filen:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

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

Parametrar

key_transformer
<xref:function>

En nyckeltransformatorfunktion.

keep_readonly
standardvärde: True

Returer

Ett dict JSON-kompatibelt objekt

Returtyp

deserialize

Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.

deserialize(data, content_type=None)

Parametrar

data
str
Obligatorisk

En str som använder RestAPI-struktur. JSON som standard.

content_type
str
standardvärde: None

JSON anger som standard application/xml om XML.

Returer

En instans av den här modellen

Undantag

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Parsa en diktamen med hjälp av den angivna nyckelextraktorn returnerar en modell.

Som standard bör du överväga nyckelextraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och last_rest_key_case_insensitive_extractor)

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

Parametrar

data
dict
Obligatorisk

En diktamen som använder RestAPI-struktur

content_type
str
standardvärde: None

JSON anger som standard application/xml om XML.

key_extractors
standardvärde: None

Returer

En instans av den här modellen

Undantag

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Returnera den JSON som skulle skickas till Azure från den här modellen.

Det här är ett alias för as_dict(full_restapi_key_transformer, keep_readonly=False).

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parametrar

keep_readonly
bool
standardvärde: False

Om du vill serialisera skrivskyddade attribut

Returer

Ett dict JSON-kompatibelt objekt

Returtyp

validate

Verifiera den här modellen rekursivt och returnera en lista över ValidationError.

validate()

Returer

En lista över valideringsfel

Returtyp