Udostępnij za pośrednictwem


TaskOperations Klasa

Operacje TaskOperations.

Nie należy tworzyć wystąpienia bezpośrednio tej klasy, ale utworzyć wystąpienie klienta, które utworzy je dla Ciebie i dołączyć jako atrybut.

Dziedziczenie
builtins.object
TaskOperations

Konstruktor

TaskOperations(client, config, serializer, deserializer)

Parametry

client
Wymagane

Klient żądań obsługi.

config
Wymagane

Konfiguracja klienta usługi.

serializer
Wymagane

Serializator modelu obiektów.

deserializer
Wymagane

Deserializator modelu obiektów.

Zmienne

api_version

Wersja interfejsu API do użycia dla żądania. Stała wartość: "2023-05-01.17.0".

Metody

add

Dodaje zadanie do określonego zadania.

Maksymalny okres istnienia zadania od dodania do ukończenia wynosi 180 dni. Jeśli zadanie nie zostało ukończone w ciągu 180 dni od dodania, zostanie zakończone przez usługę Batch i pozostawione w jakimkolwiek stanie było w tym czasie.

add_collection

Dodaje kolekcję zadań do określonego zadania.

Należy pamiętać, że każde zadanie musi mieć unikatowy identyfikator. Usługa Batch może nie zwracać wyników dla każdego zadania w tej samej kolejności, w których zadania zostały przesłane w tym żądaniu. Jeśli przekroczono limit czasu serwera lub połączenie zostało zamknięte podczas żądania, żądanie mogło zostać częściowo lub w pełni przetworzone lub nie w ogóle. W takich przypadkach użytkownik powinien ponownie wysłać żądanie. Należy pamiętać, że użytkownik musi poprawnie obsługiwać błędy podczas ponownego wystawiania żądania. Na przykład należy użyć tych samych identyfikatorów zadań podczas ponawiania próby, aby jeśli poprzednia operacja zakończyła się pomyślnie, ponawianie próby nie spowoduje nieoczekiwanego utworzenia dodatkowych zadań. Jeśli odpowiedź zawiera jakiekolwiek zadania, których nie można dodać, klient może ponowić próbę żądania. Podczas ponawiania próby najbardziej wydajne jest ponowne przesłanie tylko zadań, które nie powiodły się, oraz pomijanie zadań, które zostały pomyślnie dodane podczas pierwszej próby. Maksymalny okres istnienia zadania od dodania do ukończenia wynosi 180 dni. Jeśli zadanie nie zostało ukończone w ciągu 180 dni od dodania, zostanie zakończone przez usługę Batch i pozostawione w jakimkolwiek stanie było w tym czasie.

delete

Usuwa zadanie z określonego zadania.

Po usunięciu zadania wszystkie pliki w katalogu w węźle obliczeniowym, w którym zostało uruchomione, również zostaną usunięte (niezależnie od czasu przechowywania). W przypadku zadań z wieloma wystąpieniami operacja usuwania zadania jest stosowana synchronicznie do zadania podstawowego; podzadania i ich pliki są następnie usuwane asynchronicznie w tle.

get

Pobiera informacje o określonym zadaniu.

W przypadku zadań z wieloma wystąpieniami informacje, takie jak koligacjaId, executionInfo i nodeInfo, zapoznaj się z podstawowym zadaniem. Użyj interfejsu API podzadania listy, aby pobrać informacje o podzadaniach.

list

Wyświetla listę wszystkich zadań skojarzonych z określonym zadaniem.

W przypadku zadań z wieloma wystąpieniami informacje, takie jak koligacjaId, executionInfo i nodeInfo, zapoznaj się z podstawowym zadaniem. Użyj interfejsu API podzadania listy, aby pobrać informacje o podzadaniach.

list_subtasks

Wyświetla listę wszystkich podzadań skojarzonych z określonym zadaniem z wieloma wystąpieniami.

Jeśli zadanie nie jest zadaniem z wieloma wystąpieniami, zwraca pustą kolekcję.

reactivate

Reactivates a Task (Zadanie), co pozwala na jego ponowne uruchomienie, nawet jeśli liczba ponownych prób została wyczerpana.

Ponowne aktywowanie powoduje, że zadanie kwalifikuje się do ponownego ponawiania próby do maksymalnej liczby ponownych prób. Stan zadania jest zmieniany na aktywny. Ponieważ zadanie nie jest już w stanie ukończonym, żadne poprzednie informacje o kodzie zakończenia lub niepowodzeniu nie są już dostępne po ponownym aktywowaniu. Za każdym razem, gdy zadanie zostanie ponownie aktywowane, jego liczba ponownych prób zostanie zresetowana do wartości 0. Ponowne aktywowanie zakończy się niepowodzeniem dla zadań, które nie zostały ukończone lub które zostały ukończone wcześniej pomyślnie (z kodem zakończenia 0). Ponadto zakończy się niepowodzeniem, jeśli zadanie zostało ukończone (lub kończy lub usuwa).

terminate

Kończy określone zadanie.

Po zakończeniu zadania zostanie ono przeniesione do stanu ukończonego. W przypadku zadań z wieloma wystąpieniami operacja zakończenia zadania jest stosowana synchronicznie do zadania podstawowego; podzadania są następnie przerywane asynchronicznie w tle.

update

Aktualizacje właściwości określonego zadania.

add

Dodaje zadanie do określonego zadania.

Maksymalny okres istnienia zadania od dodania do ukończenia wynosi 180 dni. Jeśli zadanie nie zostało ukończone w ciągu 180 dni od dodania, zostanie zakończone przez usługę Batch i pozostawione w jakimkolwiek stanie było w tym czasie.

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

Parametry

job_id
str
Wymagane

Identyfikator zadania, do którego ma zostać dodane zadanie.

task
TaskAddParameter
Wymagane

Zadanie do dodania.

task_add_options
TaskAddOptions
wartość domyślna: None

Dodatkowe parametry operacji

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

Brak lub ClientRawResponse, jeśli wartość raw=true

Typ zwracany

None,

Wyjątki

add_collection

Dodaje kolekcję zadań do określonego zadania.

Należy pamiętać, że każde zadanie musi mieć unikatowy identyfikator. Usługa Batch może nie zwracać wyników dla każdego zadania w tej samej kolejności, w których zadania zostały przesłane w tym żądaniu. Jeśli przekroczono limit czasu serwera lub połączenie zostało zamknięte podczas żądania, żądanie mogło zostać częściowo lub w pełni przetworzone lub nie w ogóle. W takich przypadkach użytkownik powinien ponownie wysłać żądanie. Należy pamiętać, że użytkownik musi poprawnie obsługiwać błędy podczas ponownego wystawiania żądania. Na przykład należy użyć tych samych identyfikatorów zadań podczas ponawiania próby, aby jeśli poprzednia operacja zakończyła się pomyślnie, ponawianie próby nie spowoduje nieoczekiwanego utworzenia dodatkowych zadań. Jeśli odpowiedź zawiera jakiekolwiek zadania, których nie można dodać, klient może ponowić próbę żądania. Podczas ponawiania próby najbardziej wydajne jest ponowne przesłanie tylko zadań, które nie powiodły się, oraz pomijanie zadań, które zostały pomyślnie dodane podczas pierwszej próby. Maksymalny okres istnienia zadania od dodania do ukończenia wynosi 180 dni. Jeśli zadanie nie zostało ukończone w ciągu 180 dni od dodania, zostanie zakończone przez usługę Batch i pozostawione w jakimkolwiek stanie było w tym czasie.

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

Parametry

job_id
str
Wymagane

Identyfikator zadania, do którego ma zostać dodana kolekcja zadań.

value
list of TaskAddParameter
Wymagane

Kolekcja zadań do dodania. Łączny serializowany rozmiar tej kolekcji musi być mniejszy niż 4 MB. Jeśli jest on większy niż 4 MB (na przykład jeśli każde zadanie ma 100 plików zasobów lub zmiennych środowiskowych), żądanie zakończy się niepowodzeniem z kodem "RequestBodyTooLarge" i powinno zostać ponowione ponownie z mniejszą liczbą zadań.

task_add_collection_options
TaskAddCollectionOptions
wartość domyślna: None

Dodatkowe parametry operacji

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

threads
int
wartość domyślna: 0

liczba wątków do użycia równolegle podczas dodawania zadań. Jeśli określono wartość i większą niż 0, uruchomi dodatkowe wątki w celu przesłania żądań i zaczekaj na ich zakończenie. W przeciwnym razie żądania add_collection będą przesyłane sekwencyjnie w wątku głównym

Zwraca

TaskAddCollectionResult lub ClientRawResponse jeśli wartość raw=true

Typ zwracany

Wyjątki

azure.batch.custom.CreateTasksErrorException

delete

Usuwa zadanie z określonego zadania.

Po usunięciu zadania wszystkie pliki w katalogu w węźle obliczeniowym, w którym zostało uruchomione, również zostaną usunięte (niezależnie od czasu przechowywania). W przypadku zadań z wieloma wystąpieniami operacja usuwania zadania jest stosowana synchronicznie do zadania podstawowego; podzadania i ich pliki są następnie usuwane asynchronicznie w tle.

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

Parametry

job_id
str
Wymagane

Identyfikator zadania, z którego ma zostać usunięte zadanie.

task_id
str
Wymagane

Identyfikator zadania do usunięcia.

task_delete_options
TaskDeleteOptions
wartość domyślna: None

Dodatkowe parametry operacji

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

Brak lub ClientRawResponse, jeśli wartość raw=true

Typ zwracany

None,

Wyjątki

get

Pobiera informacje o określonym zadaniu.

W przypadku zadań z wieloma wystąpieniami informacje, takie jak koligacjaId, executionInfo i nodeInfo, zapoznaj się z podstawowym zadaniem. Użyj interfejsu API podzadania listy, aby pobrać informacje o podzadaniach.

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

Parametry

job_id
str
Wymagane

Identyfikator zadania zawierającego zadanie.

task_id
str
Wymagane

Identyfikator zadania, aby uzyskać informacje o.

task_get_options
TaskGetOptions
wartość domyślna: None

Dodatkowe parametry operacji

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

CloudTask lub ClientRawResponse, jeśli raw=true

Typ zwracany

Wyjątki

list

Wyświetla listę wszystkich zadań skojarzonych z określonym zadaniem.

W przypadku zadań z wieloma wystąpieniami informacje, takie jak koligacjaId, executionInfo i nodeInfo, zapoznaj się z podstawowym zadaniem. Użyj interfejsu API podzadania listy, aby pobrać informacje o podzadaniach.

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

Parametry

job_id
str
Wymagane

Identyfikator zadania.

task_list_options
TaskListOptions
wartość domyślna: None

Dodatkowe parametry operacji

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

Iterator, taki jak wystąpienie usługi CloudTask

Typ zwracany

Wyjątki

list_subtasks

Wyświetla listę wszystkich podzadań skojarzonych z określonym zadaniem z wieloma wystąpieniami.

Jeśli zadanie nie jest zadaniem z wieloma wystąpieniami, zwraca pustą kolekcję.

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

Parametry

job_id
str
Wymagane

Identyfikator zadania.

task_id
str
Wymagane

Identyfikator zadania.

task_list_subtasks_options
TaskListSubtasksOptions
wartość domyślna: None

Dodatkowe parametry operacji

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

CloudTaskListSubtasksResult lub ClientRawResponse, jeśli raw=true

Typ zwracany

Wyjątki

reactivate

Reactivates a Task (Zadanie), co pozwala na jego ponowne uruchomienie, nawet jeśli liczba ponownych prób została wyczerpana.

Ponowne aktywowanie powoduje, że zadanie kwalifikuje się do ponownego ponawiania próby do maksymalnej liczby ponownych prób. Stan zadania jest zmieniany na aktywny. Ponieważ zadanie nie jest już w stanie ukończonym, żadne poprzednie informacje o kodzie zakończenia lub niepowodzeniu nie są już dostępne po ponownym aktywowaniu. Za każdym razem, gdy zadanie zostanie ponownie aktywowane, jego liczba ponownych prób zostanie zresetowana do wartości 0. Ponowne aktywowanie zakończy się niepowodzeniem dla zadań, które nie zostały ukończone lub które zostały ukończone wcześniej pomyślnie (z kodem zakończenia 0). Ponadto zakończy się niepowodzeniem, jeśli zadanie zostało ukończone (lub kończy lub usuwa).

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

Parametry

job_id
str
Wymagane

Identyfikator zadania zawierającego zadanie.

task_id
str
Wymagane

Identyfikator zadania do ponownego aktywowania.

task_reactivate_options
TaskReactivateOptions
wartość domyślna: None

Dodatkowe parametry operacji

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

Brak lub ClientRawResponse, jeśli wartość raw=true

Typ zwracany

None,

Wyjątki

terminate

Kończy określone zadanie.

Po zakończeniu zadania zostanie ono przeniesione do stanu ukończonego. W przypadku zadań z wieloma wystąpieniami operacja zakończenia zadania jest stosowana synchronicznie do zadania podstawowego; podzadania są następnie przerywane asynchronicznie w tle.

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

Parametry

job_id
str
Wymagane

Identyfikator zadania zawierającego zadanie.

task_id
str
Wymagane

Identyfikator zadania do zakończenia.

task_terminate_options
TaskTerminateOptions
wartość domyślna: None

Dodatkowe parametry operacji

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

Brak lub ClientRawResponse, jeśli wartość raw=true

Typ zwracany

None,

Wyjątki

update

Aktualizacje właściwości określonego zadania.

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

Parametry

job_id
str
Wymagane

Identyfikator zadania zawierającego zadanie.

task_id
str
Wymagane

Identyfikator zadania do zaktualizowania.

constraints
TaskConstraints
wartość domyślna: None

Ograniczenia, które mają zastosowanie do tego zadania. W przypadku pominięcia zadanie otrzymuje ograniczenia domyślne. W przypadku zadań z wieloma wystąpieniami aktualizowanie czasu przechowywania dotyczy tylko zadania podstawowego, a nie podzadań.

task_update_options
TaskUpdateOptions
wartość domyślna: None

Dodatkowe parametry operacji

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

Metoda zwraca bezpośrednią odpowiedź obok zdeserializowanej odpowiedzi

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

Brak lub Wartość ClientRawResponse, jeśli parametr raw=true

Typ zwracany

None,

Wyjątki

Atrybuty

models

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