TaskOperations Třída

Operace TaskOperations.

Neměli byste vytvořit instanci přímo této třídy, ale vytvořit instanci klienta, která ji vytvoří pro vás a připojí ji jako atribut.

Dědičnost

builtins.object

TaskOperations

Konstruktor

TaskOperations(client, config, serializer, deserializer)

Parametry

client

Vyžadováno

Klient pro žádosti o služby.

config

Vyžadováno

Konfigurace klienta služby.

serializer

Vyžadováno

Serializátor objektového modelu.

deserializer

Vyžadováno

Deserializátor objektového modelu.

Proměnné

api_version

Verze rozhraní API, která se má použít pro požadavek. Konstantní hodnota: "2023-05-01.17.0".

Metody

add	Přidá úkol do zadané úlohy. Maximální životnost úkolu od přidání do dokončení je 180 dnů. Pokud se úkol nedokončil do 180 dnů od přidání, služba Batch ho ukončí a ponechá v jakémkoli stavu, v jakém byl v té době.
add_collection	Přidá kolekci úkolů do zadané úlohy. Všimněte si, že každý úkol musí mít jedinečné ID. Služba Batch nemusí vrátit výsledky pro každý úkol ve stejném pořadí, v jakém byly úkoly odeslány v tomto požadavku. Pokud dojde k vypršení časového limitu serveru nebo k ukončení připojení během požadavku, je možné, že požadavek byl částečně nebo zcela zpracován nebo vůbec. V takových případech by uživatel měl žádost vydat znovu. Všimněte si, že je na uživateli, aby správně zvládl selhání při opětovném vystavení požadavku. Při opakování byste například měli použít stejná ID úloh, aby se v případě úspěchu předchozí operace neočekávaně nevytvořily další úkoly. Pokud odpověď obsahuje nějaké úkoly, které se nepodařilo přidat, může klient zkusit požadavek zopakovat. Při opakování je nejúčinnější znovu odeslat pouze úkoly, které se nepodařilo přidat, a vynechat úkoly, které byly úspěšně přidány při prvním pokusu. Maximální životnost úkolu od přidání do dokončení je 180 dnů. Pokud se úkol nedokončil do 180 dnů od přidání, služba Batch ho ukončí a ponechá v jakémkoli stavu, v jakém byl v té době.
delete	Odstraní úkol ze zadané úlohy. Při odstranění úlohy se odstraní také všechny soubory v jejím adresáři na výpočetním uzlu, na kterém byla úloha spuštěna (bez ohledu na dobu uchovávání). U úkolů s více instancemi se operace odstranění úlohy použije synchronně na primární úkol. dílčí úkoly a jejich soubory se pak asynchronně odstraňují na pozadí.
get	Získá informace o zadaném úkolu. Informace o úlohách s více instancemi, jako jsou affinityId, executionInfo a nodeInfo, odkazují na primární úlohu. K načtení informací o dílčích úkolůch použijte rozhraní API seznamu dílčích úkolů.
list	Zobrazí seznam všech úkolů přidružených k zadané úloze. Informace o úlohách s více instancemi, jako jsou affinityId, executionInfo a nodeInfo, odkazují na primární úlohu. K načtení informací o dílčích úkolůch použijte rozhraní API seznamu dílčích úkolů.
list_subtasks	Zobrazí seznam všech dílčích úkolů přidružených k zadané úloze s více instancemi. Pokud úloha není úlohou s více instancemi, vrátí se prázdná kolekce.
reactivate	Znovu aktivuje úlohu a umožní její opětovné spuštění, i když byl počet opakování vyčerpán. Opětovná aktivace způsobí, že úkol může být znovu zkoušený až do maximálního počtu opakování. Stav úkolu se změní na aktivní. Vzhledem k tomu, že úloha již není ve stavu dokončení, nebudou po opětovné aktivaci k dispozici žádné předchozí ukončovací kódy nebo informace o selhání. Při každé opětovné aktivaci úkolu se počet opakování resetuje na 0. Opětovná aktivace se nezdaří u úkolů, které nebyly dokončeny nebo které byly dříve úspěšně dokončeny (s ukončovacím kódem 0). Kromě toho selže, pokud se úloha dokončila (nebo ukončuje nebo odstraňuje).
terminate	Ukončí zadaný úkol. Po ukončení se úkol přesune do dokončeného stavu. U úloh s více instancemi se operace ukončení úlohy použije synchronně na primární úlohu; Dílčí úkoly se pak asynchronně ukončují na pozadí.
update	Aktualizace vlastnosti zadané úlohy.

add

Přidá úkol do zadané úlohy.

Maximální životnost úkolu od přidání do dokončení je 180 dnů. Pokud se úkol nedokončil do 180 dnů od přidání, služba Batch ho ukončí a ponechá v jakémkoli stavu, v jakém byl v té době.

add(job_id, task, task_add_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_id

str

Vyžadováno

ID úlohy, do které má být úkol přidán.

task

TaskAddParameter

Vyžadováno

Úkol, který se má přidat.

task_add_options

TaskAddOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

None nebo ClientRawResponse if raw=true

Návratový typ

None,

ClientRawResponse

Výjimky

BatchErrorException

add_collection

Přidá kolekci úkolů do zadané úlohy.

Všimněte si, že každý úkol musí mít jedinečné ID. Služba Batch nemusí vrátit výsledky pro každý úkol ve stejném pořadí, v jakém byly úkoly odeslány v tomto požadavku. Pokud dojde k vypršení časového limitu serveru nebo k ukončení připojení během požadavku, je možné, že požadavek byl částečně nebo zcela zpracován nebo vůbec. V takových případech by uživatel měl žádost vydat znovu. Všimněte si, že je na uživateli, aby správně zvládl selhání při opětovném vystavení požadavku. Při opakování byste například měli použít stejná ID úloh, aby se v případě úspěchu předchozí operace neočekávaně nevytvořily další úkoly. Pokud odpověď obsahuje nějaké úkoly, které se nepodařilo přidat, může klient zkusit požadavek zopakovat. Při opakování je nejúčinnější znovu odeslat pouze úkoly, které se nepodařilo přidat, a vynechat úkoly, které byly úspěšně přidány při prvním pokusu. Maximální životnost úkolu od přidání do dokončení je 180 dnů. Pokud se úkol nedokončil do 180 dnů od přidání, služba Batch ho ukončí a ponechá v jakémkoli stavu, v jakém byl v té době.

add_collection(job_id, value, task_add_collection_options=None, custom_headers=None, raw=False, threads=0, **operation_config)

Parametry

job_id

str

Vyžadováno

ID úlohy, do které má být kolekce úkolů přidána.

value

list of TaskAddParameter

Vyžadováno

Kolekce úkolů, které chcete přidat. Celková serializovaná velikost této kolekce musí být menší než 4 MB. Pokud je větší než 4 MB (například pokud má každý úkol 100 souborů prostředků nebo proměnných prostředí), požadavek selže s kódem RequestBodyTooLarge a měl by se opakovat s menším počtem úkolů.

task_add_collection_options

TaskAddCollectionOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

threads

int

výchozí hodnota: 0

počet vláken, která se mají použít paralelně při přidávání úkolů. Pokud je zadaný a větší než 0, spustí další vlákna pro odesílání požadavků a počká na jejich dokončení. Jinak budou požadavky add_collection odesílat postupně v hlavním vlákně.

Návraty

TaskAddCollectionResult nebo ClientRawResponse pokud raw=true

Návratový typ

TaskAddCollectionResult,

ClientRawResponse

Výjimky

azure.batch.custom.CreateTasksErrorException

delete

Odstraní úkol ze zadané úlohy.

Při odstranění úlohy se odstraní také všechny soubory v jejím adresáři na výpočetním uzlu, na kterém byla úloha spuštěna (bez ohledu na dobu uchovávání). U úkolů s více instancemi se operace odstranění úlohy použije synchronně na primární úkol. dílčí úkoly a jejich soubory se pak asynchronně odstraňují na pozadí.

delete(job_id, task_id, task_delete_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_id

str

Vyžadováno

ID úlohy, ze které chcete úkol odstranit.

task_id

str

Vyžadováno

ID úlohy, která se má odstranit.

task_delete_options

TaskDeleteOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

None nebo ClientRawResponse if raw=true

Návratový typ

None,

ClientRawResponse

Výjimky

BatchErrorException

get

Získá informace o zadaném úkolu.

Informace o úlohách s více instancemi, jako jsou affinityId, executionInfo a nodeInfo, odkazují na primární úlohu. K načtení informací o dílčích úkolůch použijte rozhraní API seznamu dílčích úkolů.

get(job_id, task_id, task_get_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_id

str

Vyžadováno

ID úlohy, která obsahuje úkol.

task_id

str

Vyžadováno

ID úlohy, o které chcete získat informace.

task_get_options

TaskGetOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

CloudTask nebo ClientRawResponse if raw=true

Návratový typ

CloudTask,

ClientRawResponse

Výjimky

BatchErrorException

list

Zobrazí seznam všech úkolů přidružených k zadané úloze.

Informace o úlohách s více instancemi, jako jsou affinityId, executionInfo a nodeInfo, odkazují na primární úlohu. K načtení informací o dílčích úkolůch použijte rozhraní API seznamu dílčích úkolů.

list(job_id, task_list_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_id

str

Vyžadováno

ID úlohy.

task_list_options

TaskListOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

Iterátor, jako je instance CloudTask

Návratový typ

CloudTaskPaged[CloudTask]

Výjimky

BatchErrorException

list_subtasks

Zobrazí seznam všech dílčích úkolů přidružených k zadané úloze s více instancemi.

Pokud úloha není úlohou s více instancemi, vrátí se prázdná kolekce.

list_subtasks(job_id, task_id, task_list_subtasks_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_id

str

Vyžadováno

ID úlohy.

task_id

str

Vyžadováno

ID úkolu.

task_list_subtasks_options

TaskListSubtasksOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

CloudTaskListSubtasksResult nebo ClientRawResponse, pokud raw=true

Návratový typ

CloudTaskListSubtasksResult,

ClientRawResponse

Výjimky

BatchErrorException

reactivate

Znovu aktivuje úlohu a umožní její opětovné spuštění, i když byl počet opakování vyčerpán.

Opětovná aktivace způsobí, že úkol může být znovu zkoušený až do maximálního počtu opakování. Stav úkolu se změní na aktivní. Vzhledem k tomu, že úloha již není ve stavu dokončení, nebudou po opětovné aktivaci k dispozici žádné předchozí ukončovací kódy nebo informace o selhání. Při každé opětovné aktivaci úkolu se počet opakování resetuje na 0. Opětovná aktivace se nezdaří u úkolů, které nebyly dokončeny nebo které byly dříve úspěšně dokončeny (s ukončovacím kódem 0). Kromě toho selže, pokud se úloha dokončila (nebo ukončuje nebo odstraňuje).

reactivate(job_id, task_id, task_reactivate_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_id

str

Vyžadováno

ID úlohy obsahující úkol.

task_id

str

Vyžadováno

ID úkolu, který se má znovu aktivovat.

task_reactivate_options

TaskReactivateOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

None nebo ClientRawResponse if raw=true

Návratový typ

None,

ClientRawResponse

Výjimky

BatchErrorException

terminate

Ukončí zadaný úkol.

Po ukončení se úkol přesune do dokončeného stavu. U úloh s více instancemi se operace ukončení úlohy použije synchronně na primární úlohu; Dílčí úkoly se pak asynchronně ukončují na pozadí.

terminate(job_id, task_id, task_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_id

str

Vyžadováno

ID úlohy obsahující úkol.

task_id

str

Vyžadováno

ID úlohy, která se má ukončit.

task_terminate_options

TaskTerminateOptions

výchozí hodnota: None

Další parametry pro operaci

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

None nebo ClientRawResponse if raw=true

Návratový typ

None,

ClientRawResponse

Výjimky

BatchErrorException

update

Aktualizace vlastnosti zadané úlohy.

update(job_id, task_id, constraints=None, task_update_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_id

str

Vyžadováno

ID úlohy obsahující úkol.

task_id

str

Vyžadováno

ID úlohy, která se má aktualizovat.

constraints

TaskConstraints

výchozí hodnota: None

Omezení, která se vztahují na tento úkol. Pokud ho vynecháte, bude úkol nastaven na výchozí omezení. U úloh s více instancemi se aktualizace doby uchovávání vztahuje pouze na primární úlohu, a ne na dílčí úkoly.

task_update_options

TaskUpdateOptions

výchozí hodnota: None

Další parametry operace

custom_headers

dict

výchozí hodnota: None

hlavičky, které se přidají do požadavku

raw

bool

výchozí hodnota: False

vrátí přímou odpověď společně s deserializovanou odpovědí.

operation_config

Vyžadováno

Přepsání konfigurace operace

Návraty

None nebo ClientRawResponse if raw=true

Návratový typ

None,

ClientRawResponse

Výjimky

BatchErrorException

Atributy

models

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>