Sdílet prostřednictvím

JobScheduleOperations Třída

  • Reference

Operace JobScheduleOperations.

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
JobScheduleOperations

Konstruktor

JobScheduleOperations(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á plán úlohy k zadanému účtu.
delete

Odstraní plán úloh ze zadaného účtu.

Když odstraníte plán úloh, odstraní se tím také všechny úlohy a úkoly v rámci tohoto plánu. Při odstranění úkolů se odstraní také všechny soubory v jejich pracovních adresářích na výpočetních uzlech (doba uchovávání se ignoruje). Statistiky plánu úloh už nebudou po odstranění plánu úloh dostupné, i když se stále započítávají do statistiky životnosti účtu.
disable

Zakáže plán úloh.

Dokud se plán úloh znovu nepovolí, nebudou vytvořeny žádné nové úlohy.
enable

Povolí plán úloh.
exists

Zkontroluje, že zadaný plán úloh existuje.
get

Získá informace o zadaném plánu úlohy.
list

Zobrazí seznam všech plánů úloh v zadaném účtu.
patch

Aktualizace vlastnosti zadaného plánu úloh.

Tím se nahradí pouze vlastnosti plánu úloh zadané v požadavku. Pokud například u tohoto požadavku není zadána vlastnost schedule, služba Batch zachová stávající plán. Změny plánu úloh ovlivní pouze úlohy vytvořené plánem po provedení aktualizace. Aktuálně spuštěné úlohy nejsou ovlivněné.
terminate

Ukončí plán úlohy.
update

Aktualizace vlastnosti zadaného plánu úloh.

Tím se plně nahradí všechny aktualizovatelné vlastnosti plánu úloh. Pokud například u tohoto požadavku není zadána vlastnost schedule, služba Batch stávající plán odebere. Změny plánu úloh ovlivní pouze úlohy vytvořené plánem po provedení aktualizace. Aktuálně spuštěné úlohy nejsou ovlivněné.

add

Přidá plán úlohy k zadanému účtu.

add(cloud_job_schedule, job_schedule_add_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

cloud_job_schedule
JobScheduleAddParameter
Vyžadováno

Plán úloh, který se má přidat.

job_schedule_add_options
JobScheduleAddOptions
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

delete

Odstraní plán úloh ze zadaného účtu.

Když odstraníte plán úloh, odstraní se tím také všechny úlohy a úkoly v rámci tohoto plánu. Při odstranění úkolů se odstraní také všechny soubory v jejich pracovních adresářích na výpočetních uzlech (doba uchovávání se ignoruje). Statistiky plánu úloh už nebudou po odstranění plánu úloh dostupné, i když se stále započítávají do statistiky životnosti účtu.

delete(job_schedule_id, job_schedule_delete_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_schedule_id
str
Vyžadováno

ID plánu úlohy, který se má odstranit.

job_schedule_delete_options
JobScheduleDeleteOptions
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

disable

Zakáže plán úloh.

Dokud se plán úloh znovu nepovolí, nebudou vytvořeny žádné nové úlohy.

disable(job_schedule_id, job_schedule_disable_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_schedule_id
str
Vyžadováno

ID plánu úlohy, který chcete zakázat.

job_schedule_disable_options
JobScheduleDisableOptions
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

enable

Povolí plán úloh.

enable(job_schedule_id, job_schedule_enable_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_schedule_id
str
Vyžadováno

ID plánu úlohy, který se má povolit.

job_schedule_enable_options
JobScheduleEnableOptions
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

exists

Zkontroluje, že zadaný plán úloh existuje.

exists(job_schedule_id, job_schedule_exists_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_schedule_id
str
Vyžadováno

ID plánu úlohy, který chcete zkontrolovat.

job_schedule_exists_options
JobScheduleExistsOptions
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

bool nebo ClientRawResponse, pokud raw=true

Návratový typ

bool,
ClientRawResponse

Výjimky

BatchErrorException

get

Získá informace o zadaném plánu úlohy.

get(job_schedule_id, job_schedule_get_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_schedule_id
str
Vyžadováno

ID plánu úlohy, který chcete získat.

job_schedule_get_options
JobScheduleGetOptions
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

CloudJobSchedule nebo ClientRawResponse, pokud raw=true

Návratový typ

CloudJobSchedule,
ClientRawResponse

Výjimky

BatchErrorException

list

Zobrazí seznam všech plánů úloh v zadaném účtu.

list(job_schedule_list_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_schedule_list_options
JobScheduleListOptions
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

Iterátor, jako je instance CloudJobSchedule

Návratový typ

CloudJobSchedulePaged[CloudJobSchedule]

Výjimky

BatchErrorException

patch

Aktualizace vlastnosti zadaného plánu úloh.

Tím se nahradí pouze vlastnosti plánu úloh zadané v požadavku. Pokud například u tohoto požadavku není zadána vlastnost schedule, služba Batch zachová stávající plán. Změny plánu úloh ovlivní pouze úlohy vytvořené plánem po provedení aktualizace. Aktuálně spuštěné úlohy nejsou ovlivněné.

patch(job_schedule_id, job_schedule_patch_parameter, job_schedule_patch_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_schedule_id
str
Vyžadováno

ID plánu úlohy, který se má aktualizovat.

job_schedule_patch_parameter
JobSchedulePatchParameter
Vyžadováno

Parametry požadavku.

job_schedule_patch_options
JobSchedulePatchOptions
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

terminate

Ukončí plán úlohy.

terminate(job_schedule_id, job_schedule_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_schedule_id
str
Vyžadováno

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

job_schedule_terminate_options
JobScheduleTerminateOptions
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

update

Aktualizace vlastnosti zadaného plánu úloh.

Tím se plně nahradí všechny aktualizovatelné vlastnosti plánu úloh. Pokud například u tohoto požadavku není zadána vlastnost schedule, služba Batch stávající plán odebere. Změny plánu úloh ovlivní pouze úlohy vytvořené plánem po provedení aktualizace. Aktuálně spuštěné úlohy nejsou ovlivněné.

update(job_schedule_id, job_schedule_update_parameter, job_schedule_update_options=None, custom_headers=None, raw=False, **operation_config)

Parametry

job_schedule_id
str
Vyžadováno

ID plánu úlohy, který se má aktualizovat.

job_schedule_update_parameter
JobScheduleUpdateParameter
Vyžadováno

Parametry požadavku.

job_schedule_update_options
JobScheduleUpdateOptions
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'>