JobOperations Třída
Operace JobOperations.
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.objectJobOperations
Konstruktor
JobOperations(client, config, serializer, deserializer)
Parametry
- client
Klient pro žádosti o služby.
- config
Konfigurace klienta služby.
- serializer
Serializátor objektového modelu.
- deserializer
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á úlohu do zadaného účtu. Služba Batch podporuje dva způsoby řízení práce provedené v rámci úlohy. Při prvním přístupu uživatel určí úlohu Správce úloh. Služba Batch spustí tuto úlohu, jakmile je připravená ke spuštění úlohy. Úloha Správce úloh řídí všechny ostatní úlohy spuštěné v rámci této úlohy pomocí rozhraní API úloh. Při druhém přístupu uživatel přímo řídí provádění úkolů v rámci aktivní úlohy pomocí rozhraní API úloh. Poznámka: Při pojmenování úloh nepoužívejte citlivé informace, jako jsou uživatelská jména nebo názvy tajných projektů. Tyto informace se můžou zobrazit v protokolech telemetrie přístupných technikům podpora Microsoftu. |
delete |
Odstraní úlohu. Odstranění úlohy také odstraní všechny úkoly, které jsou součástí této úlohy, a všechny statistiky úlohy. Tím se také přepíše doba uchovávání dat úlohy. To znamená, že pokud úloha obsahuje úkoly, které jsou stále uchovány ve výpočetních uzlech, služby Batch odstraní pracovní adresáře a veškerý jejich obsah. Po přijetí žádosti o odstranění úlohy služba Batch nastaví úlohu do stavu odstranění. Všechny operace aktualizace u úlohy, která je ve stavu odstraňování, selžou se stavovým kódem 409 (Konflikt) a další informace o tom, že se úloha odstraňuje. |
disable |
Zakáže zadanou úlohu a zabrání spuštění nových úloh. Služba Batch okamžitě přesune úlohu do stavu zákazu. Batch pak pomocí parametru disableTasks určí, co dělat s aktuálně spuštěnými úkoly úlohy. Úloha zůstává ve stavu zákazu, dokud není dokončena operace zakázání a všechny úkoly byly vyřešeny podle možnosti disableTasks; Úloha se pak přesune do zakázaného stavu. Pod úlohou se nesouvají žádné nové úkoly, dokud se nepřesunou zpět do aktivního stavu. Pokud se pokusíte zakázat úlohu, která je v jiném stavu než aktivní, zakázaná nebo zakázaná, požadavek selže se stavovým kódem 409. |
enable |
Povolí zadanou úlohu a umožní spuštění nových úloh. Při volání tohoto rozhraní API služba Batch nastaví zakázanou úlohu do stavu povolení. Po dokončení této operace se úloha přesune do aktivního stavu a plánování nových úkolů v části Úloha se obnoví. Služba Batch neumožňuje, aby úloha zůstala v aktivním stavu déle než 180 dnů. Pokud tedy povolíte úlohu obsahující aktivní úkoly, které byly přidány před více než 180 dny, tyto úlohy se nespustí. |
get |
Získá informace o zadané úloze. |
get_task_counts |
Získá počet úloh pro zadanou úlohu. Počty úkolů poskytují počet úkolů podle stavu aktivních, spuštěných nebo dokončených úkolů a počet úspěšných nebo neúspěšných úkolů. Úkoly ve stavu přípravy se počítají jako spuštěné. Všimněte si, že vrácená čísla nemusí být vždy aktuální. Pokud potřebujete přesné počty úkolů, použijte dotaz na seznam. |
list |
Zobrazí seznam všech úloh v zadaném účtu. |
list_from_job_schedule |
Zobrazí seznam úloh, které byly vytvořeny v rámci zadaného plánu úloh. |
list_preparation_and_release_task_status |
Vypíše stav spuštění úlohy přípravy a úlohy uvolnění úlohy pro zadanou úlohu na výpočetních uzlech, na kterých se úloha spustila. Toto rozhraní API vrací stav úlohy příprava a uvolnění úlohy na všech výpočetních uzlech, na kterých byla spuštěna úloha přípravy úlohy nebo uvolnění úlohy. To zahrnuje výpočetní uzly, které byly od té doby z fondu odebrány. Pokud je toto rozhraní API vyvoláno u úlohy, která nemá žádnou úlohu přípravy úlohy nebo uvolnění úlohy, vrátí služba Batch stavový kód HTTP 409 (Konflikt) s kódem chyby JobPreparationTaskNotSpecified. |
patch |
Aktualizace vlastnosti zadané úlohy. Tím se nahradí pouze vlastnosti úlohy zadané v požadavku. Pokud má například úloha omezení a požadavek neurčuje prvek constraints, pak úloha zachová stávající omezení. |
terminate |
Ukončí zadanou úlohu a označí ji jako dokončenou. Po přijetí žádosti o ukončení úlohy služba Batch nastaví úlohu do ukončujícího stavu. Služba Batch pak ukončí všechny spuštěné úkoly přidružené k úloze a spustí všechny požadované úkoly uvolnění úlohy. Úloha se pak přesune do dokončeného stavu. Pokud jsou v úloze nějaké úkoly v aktivním stavu, zůstanou v aktivním stavu. Po ukončení úlohy nelze přidat nové úkoly a žádné zbývající aktivní úkoly nebudou naplánovány. |
update |
Aktualizace vlastnosti zadané úlohy. Tím se plně nahradí všechny aktualizovatelné vlastnosti úlohy. Pokud má například úloha přidružená omezení a pokud nejsou v tomto požadavku zadána omezení, služba Batch stávající omezení odebere. |
add
Přidá úlohu do zadaného účtu.
Služba Batch podporuje dva způsoby řízení práce provedené v rámci úlohy. Při prvním přístupu uživatel určí úlohu Správce úloh. Služba Batch spustí tuto úlohu, jakmile je připravená ke spuštění úlohy. Úloha Správce úloh řídí všechny ostatní úlohy spuštěné v rámci této úlohy pomocí rozhraní API úloh. Při druhém přístupu uživatel přímo řídí provádění úkolů v rámci aktivní úlohy pomocí rozhraní API úloh. Poznámka: Při pojmenování úloh nepoužívejte citlivé informace, jako jsou uživatelská jména nebo názvy tajných projektů. Tyto informace se můžou zobrazit v protokolech telemetrie přístupných technikům podpora Microsoftu.
add(job, job_add_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
delete
Odstraní úlohu.
Odstranění úlohy také odstraní všechny úkoly, které jsou součástí této úlohy, a všechny statistiky úlohy. Tím se také přepíše doba uchovávání dat úlohy. To znamená, že pokud úloha obsahuje úkoly, které jsou stále uchovány ve výpočetních uzlech, služby Batch odstraní pracovní adresáře a veškerý jejich obsah. Po přijetí žádosti o odstranění úlohy služba Batch nastaví úlohu do stavu odstranění. Všechny operace aktualizace u úlohy, která je ve stavu odstraňování, selžou se stavovým kódem 409 (Konflikt) a další informace o tom, že se úloha odstraňuje.
delete(job_id, job_delete_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
disable
Zakáže zadanou úlohu a zabrání spuštění nových úloh.
Služba Batch okamžitě přesune úlohu do stavu zákazu. Batch pak pomocí parametru disableTasks určí, co dělat s aktuálně spuštěnými úkoly úlohy. Úloha zůstává ve stavu zákazu, dokud není dokončena operace zakázání a všechny úkoly byly vyřešeny podle možnosti disableTasks; Úloha se pak přesune do zakázaného stavu. Pod úlohou se nesouvají žádné nové úkoly, dokud se nepřesunou zpět do aktivního stavu. Pokud se pokusíte zakázat úlohu, která je v jiném stavu než aktivní, zakázaná nebo zakázaná, požadavek selže se stavovým kódem 409.
disable(job_id, disable_tasks, job_disable_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- disable_tasks
- str nebo DisableJobOption
Mezi možné hodnoty patří: 'requeue', 'terminate', 'wait'
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
enable
Povolí zadanou úlohu a umožní spuštění nových úloh.
Při volání tohoto rozhraní API služba Batch nastaví zakázanou úlohu do stavu povolení. Po dokončení této operace se úloha přesune do aktivního stavu a plánování nových úkolů v části Úloha se obnoví. Služba Batch neumožňuje, aby úloha zůstala v aktivním stavu déle než 180 dnů. Pokud tedy povolíte úlohu obsahující aktivní úkoly, které byly přidány před více než 180 dny, tyto úlohy se nespustí.
enable(job_id, job_enable_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
get
Získá informace o zadané úloze.
get(job_id, job_get_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- operation_config
Přepsání konfigurace operace
Návraty
CloudJob nebo ClientRawResponse, pokud raw=true
Návratový typ
Výjimky
get_task_counts
Získá počet úloh pro zadanou úlohu.
Počty úkolů poskytují počet úkolů podle stavu aktivních, spuštěných nebo dokončených úkolů a počet úspěšných nebo neúspěšných úkolů. Úkoly ve stavu přípravy se počítají jako spuštěné. Všimněte si, že vrácená čísla nemusí být vždy aktuální. Pokud potřebujete přesné počty úkolů, použijte dotaz na seznam.
get_task_counts(job_id, job_get_task_counts_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- job_get_task_counts_options
- JobGetTaskCountsOptions
Další parametry pro operaci
- operation_config
Přepsání konfigurace operace
Návraty
TaskCountsResult nebo ClientRawResponse, pokud raw=true
Návratový typ
Výjimky
list
Zobrazí seznam všech úloh v zadaném účtu.
list(job_list_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- operation_config
Přepsání konfigurace operace
Návraty
Iterátor, jako je instance CloudJob
Návratový typ
Výjimky
list_from_job_schedule
Zobrazí seznam úloh, které byly vytvořeny v rámci zadaného plánu úloh.
list_from_job_schedule(job_schedule_id, job_list_from_job_schedule_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- job_list_from_job_schedule_options
- JobListFromJobScheduleOptions
Další parametry pro operaci
- operation_config
Přepsání konfigurace operace
Návraty
Iterátor, jako je instance CloudJob
Návratový typ
Výjimky
list_preparation_and_release_task_status
Vypíše stav spuštění úlohy přípravy a úlohy uvolnění úlohy pro zadanou úlohu na výpočetních uzlech, na kterých se úloha spustila.
Toto rozhraní API vrací stav úlohy příprava a uvolnění úlohy na všech výpočetních uzlech, na kterých byla spuštěna úloha přípravy úlohy nebo uvolnění úlohy. To zahrnuje výpočetní uzly, které byly od té doby z fondu odebrány. Pokud je toto rozhraní API vyvoláno u úlohy, která nemá žádnou úlohu přípravy úlohy nebo uvolnění úlohy, vrátí služba Batch stavový kód HTTP 409 (Konflikt) s kódem chyby JobPreparationTaskNotSpecified.
list_preparation_and_release_task_status(job_id, job_list_preparation_and_release_task_status_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- job_list_preparation_and_release_task_status_options
- JobListPreparationAndReleaseTaskStatusOptions
Další parametry pro operaci
- operation_config
Přepsání konfigurace operace
Návraty
Iterátor, jako je instance JobPreparationAndReleaseTaskExecutionInformation
Návratový typ
Výjimky
patch
Aktualizace vlastnosti zadané úlohy.
Tím se nahradí pouze vlastnosti úlohy zadané v požadavku. Pokud má například úloha omezení a požadavek neurčuje prvek constraints, pak úloha zachová stávající omezení.
patch(job_id, job_patch_parameter, job_patch_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
terminate
Ukončí zadanou úlohu a označí ji jako dokončenou.
Po přijetí žádosti o ukončení úlohy služba Batch nastaví úlohu do ukončujícího stavu. Služba Batch pak ukončí všechny spuštěné úkoly přidružené k úloze a spustí všechny požadované úkoly uvolnění úlohy. Úloha se pak přesune do dokončeného stavu. Pokud jsou v úloze nějaké úkoly v aktivním stavu, zůstanou v aktivním stavu. Po ukončení úlohy nelze přidat nové úkoly a žádné zbývající aktivní úkoly nebudou naplánovány.
terminate(job_id, terminate_reason=None, job_terminate_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- terminate_reason
- str
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
update
Aktualizace vlastnosti zadané úlohy.
Tím se plně nahradí všechny aktualizovatelné vlastnosti úlohy. Pokud má například úloha přidružená omezení a pokud nejsou v tomto požadavku zadána omezení, služba Batch stávající omezení odebere.
update(job_id, job_update_parameter, job_update_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- operation_config
Přepsání konfigurace operace
Návraty
None nebo ClientRawResponse if raw=true
Návratový typ
Výjimky
Atributy
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>
Azure SDK for Python