JobOperations Klasa
Operacje JobOperations.
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.objectJobOperations
Konstruktor
JobOperations(client, config, serializer, deserializer)Parametry
- client
Klient żądań obsługi.
- config
Konfiguracja klienta usługi.
- serializer
Serializator modelu obiektów.
- deserializer
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 konta. Usługa Batch obsługuje dwa sposoby kontrolowania wykonanej pracy w ramach zadania. W pierwszym podejściu użytkownik określa zadanie Menedżera zadań. Usługa Batch uruchamia to zadanie, gdy jest gotowe do uruchomienia zadania. Zadanie Menedżera zadań steruje wszystkimi innymi zadaniami uruchamianymi w ramach tego zadania przy użyciu interfejsów API zadań. W drugim podejściu użytkownik bezpośrednio kontroluje wykonywanie zadań w ramach aktywnego zadania przy użyciu interfejsów API zadań. Uwaga: podczas nazywania zadań należy unikać uwzględniania poufnych informacji, takich jak nazwy użytkowników lub nazwy projektów tajnych. Te informacje mogą być wyświetlane w dziennikach telemetrycznych dostępnych dla inżynierów pomoc techniczna firmy Microsoft. |
| delete |
Usuwa zadanie. Usunięcie zadania powoduje również usunięcie wszystkich zadań będących częścią tego zadania oraz wszystkich statystyk zadań. Zastępuje to również okres przechowywania danych zadania; oznacza to, że jeśli zadanie zawiera zadania, które są nadal przechowywane w węzłach obliczeniowych, usługi Batch usuwa katalogi robocze zadań i całą ich zawartość. Po odebraniu żądania usunięcia zadania usługa Batch ustawia zadanie na stan usuwania. Wszystkie operacje aktualizacji zadania, które są w stanie usuwania, kończą się niepowodzeniem z kodem stanu 409 (konflikt), z dodatkowymi informacjami wskazującymi, że zadanie jest usuwane. |
| disable |
Wyłącza określone zadanie, uniemożliwiając uruchamianie nowych zadań. Usługa Batch natychmiast przenosi zadanie do stanu wyłączania. Usługa Batch następnie używa parametru disableTasks, aby określić, co zrobić z aktualnie uruchomionymi zadaniami zadania. Zadanie pozostaje w stanie wyłączania do momentu zakończenia operacji wyłączenia, a wszystkie zadania zostały rozwiązane zgodnie z opcją disableTasks; Zadanie następnie przechodzi do stanu wyłączonego. Żadne nowe zadania nie są uruchamiane w ramach zadania, dopóki nie zostanie przywrócony do stanu aktywnego. Jeśli spróbujesz wyłączyć zadanie, które jest w dowolnym stanie innym niż aktywne, wyłączenie lub wyłączenie, żądanie kończy się niepowodzeniem z kodem stanu 409. |
| enable |
Włącza określone zadanie, co umożliwia uruchamianie nowych zadań. Po wywołaniu tego interfejsu API usługa Batch ustawia wyłączone zadanie na stan włączania. Po zakończeniu tej operacji zadanie zostanie przeniesione do stanu aktywnego i zaplanowanie nowych zadań w ramach zadania zostanie wznowione. Usługa Batch nie zezwala na pozostanie zadania w stanie aktywnym przez ponad 180 dni. W związku z tym, jeśli włączysz zadanie zawierające aktywne zadania, które zostały dodane ponad 180 dni temu, te zadania nie zostaną uruchomione. |
| get |
Pobiera informacje o określonym zadaniu. |
| get_task_counts |
Pobiera liczbę zadań dla określonego zadania. Liczba zadań zapewnia liczbę zadań przez aktywne, uruchomione lub ukończone zadanie oraz liczbę zadań, które zakończyły się powodzeniem lub niepowodzeniem. Zadania w stanie przygotowywania są liczone jako uruchomione. Zwróć uwagę, że zwracane liczby mogą nie zawsze być aktualne. Jeśli potrzebujesz dokładnych liczb zadań, użyj zapytania listy. |
| list |
Wyświetla listę wszystkich zadań w określonym koncie. |
| list_from_job_schedule |
Wyświetla listę zadań utworzonych w ramach określonego harmonogramu zadań. |
| list_preparation_and_release_task_status |
Wyświetla stan wykonywania zadania przygotowania zadania i zwolnienia zadania dla określonego zadania w węzłach obliczeniowych, w których zadanie zostało uruchomione. Ten interfejs API zwraca stan zadania przygotowania i wydania zadania we wszystkich węzłach obliczeniowych, które uruchamiają zadanie przygotowania zadania lub wydania zadania. Obejmuje to węzły obliczeniowe, które zostały od tego czasu usunięte z puli. Jeśli ten interfejs API jest wywoływany w zadaniu, które nie ma zadania przygotowania zadania lub wydania zadania, usługa Batch zwraca kod stanu HTTP 409 (konflikt) z kodem błędu JobPreparationTaskNotSpecified. |
| patch |
Aktualizacje właściwości określonego zadania. Zastępuje to tylko właściwości zadania określone w żądaniu. Jeśli na przykład zadanie ma ograniczenia, a żądanie nie określa elementu ograniczeń, zadanie zachowuje istniejące ograniczenia. |
| terminate |
Kończy określone zadanie, oznaczając je jako ukończone. Po odebraniu żądania zakończenia zadania usługa Batch ustawia zadanie na stan zakończenia. Następnie usługa Batch kończy wszystkie uruchomione zadania skojarzone z zadaniem i uruchamia wszystkie wymagane zadania zwolnienia zadań. Następnie zadanie przechodzi do stanu ukończonego. Jeśli w stanie aktywnym istnieją jakiekolwiek zadania podrzędne, pozostaną w stanie aktywnym. Po zakończeniu zadania nie można dodać nowych zadań, a pozostałe aktywne zadania nie zostaną zaplanowane. |
| update |
Aktualizacje właściwości określonego zadania. Spowoduje to całkowite zastąpienie wszystkich aktualizowalnych właściwości zadania. Jeśli na przykład zadanie ma skojarzone ograniczenia i jeśli ograniczenia nie zostały określone z tym żądaniem, usługa Batch usunie istniejące ograniczenia. |
add
Dodaje zadanie do określonego konta.
Usługa Batch obsługuje dwa sposoby kontrolowania wykonanej pracy w ramach zadania. W pierwszym podejściu użytkownik określa zadanie Menedżera zadań. Usługa Batch uruchamia to zadanie, gdy jest gotowe do uruchomienia zadania. Zadanie Menedżera zadań steruje wszystkimi innymi zadaniami uruchamianymi w ramach tego zadania przy użyciu interfejsów API zadań. W drugim podejściu użytkownik bezpośrednio kontroluje wykonywanie zadań w ramach aktywnego zadania przy użyciu interfejsów API zadań. Uwaga: podczas nazywania zadań należy unikać uwzględniania poufnych informacji, takich jak nazwy użytkowników lub nazwy projektów tajnych. Te informacje mogą być wyświetlane w dziennikach telemetrycznych dostępnych dla inżynierów pomoc techniczna firmy Microsoft.
add(job, job_add_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Brak lub ClientRawResponse, jeśli wartość raw=true
Typ zwracany
Wyjątki
delete
Usuwa zadanie.
Usunięcie zadania powoduje również usunięcie wszystkich zadań będących częścią tego zadania oraz wszystkich statystyk zadań. Zastępuje to również okres przechowywania danych zadania; oznacza to, że jeśli zadanie zawiera zadania, które są nadal przechowywane w węzłach obliczeniowych, usługi Batch usuwa katalogi robocze zadań i całą ich zawartość. Po odebraniu żądania usunięcia zadania usługa Batch ustawia zadanie na stan usuwania. Wszystkie operacje aktualizacji zadania, które są w stanie usuwania, kończą się niepowodzeniem z kodem stanu 409 (konflikt), z dodatkowymi informacjami wskazującymi, że zadanie jest usuwane.
delete(job_id, job_delete_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Brak lub ClientRawResponse, jeśli wartość raw=true
Typ zwracany
Wyjątki
disable
Wyłącza określone zadanie, uniemożliwiając uruchamianie nowych zadań.
Usługa Batch natychmiast przenosi zadanie do stanu wyłączania. Usługa Batch następnie używa parametru disableTasks, aby określić, co zrobić z aktualnie uruchomionymi zadaniami zadania. Zadanie pozostaje w stanie wyłączania do momentu zakończenia operacji wyłączenia, a wszystkie zadania zostały rozwiązane zgodnie z opcją disableTasks; Zadanie następnie przechodzi do stanu wyłączonego. Żadne nowe zadania nie są uruchamiane w ramach zadania, dopóki nie zostanie przywrócony do stanu aktywnego. Jeśli spróbujesz wyłączyć zadanie, które jest w dowolnym stanie innym niż aktywne, wyłączenie lub wyłączenie, żądanie kończy się niepowodzeniem z kodem stanu 409.
disable(job_id, disable_tasks, job_disable_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Brak lub ClientRawResponse, jeśli wartość raw=true
Typ zwracany
Wyjątki
enable
Włącza określone zadanie, co umożliwia uruchamianie nowych zadań.
Po wywołaniu tego interfejsu API usługa Batch ustawia wyłączone zadanie na stan włączania. Po zakończeniu tej operacji zadanie zostanie przeniesione do stanu aktywnego i zaplanowanie nowych zadań w ramach zadania zostanie wznowione. Usługa Batch nie zezwala na pozostanie zadania w stanie aktywnym przez ponad 180 dni. W związku z tym, jeśli włączysz zadanie zawierające aktywne zadania, które zostały dodane ponad 180 dni temu, te zadania nie zostaną uruchomione.
enable(job_id, job_enable_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Brak lub ClientRawResponse, jeśli wartość raw=true
Typ zwracany
Wyjątki
get
Pobiera informacje o określonym zadaniu.
get(job_id, job_get_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
CloudJob lub ClientRawResponse, jeśli raw=true
Typ zwracany
Wyjątki
get_task_counts
Pobiera liczbę zadań dla określonego zadania.
Liczba zadań zapewnia liczbę zadań przez aktywne, uruchomione lub ukończone zadanie oraz liczbę zadań, które zakończyły się powodzeniem lub niepowodzeniem. Zadania w stanie przygotowywania są liczone jako uruchomione. Zwróć uwagę, że zwracane liczby mogą nie zawsze być aktualne. Jeśli potrzebujesz dokładnych liczb zadań, użyj zapytania listy.
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
Dodatkowe parametry operacji
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
TaskCountsResult lub ClientRawResponse, jeśli raw=true
Typ zwracany
Wyjątki
list
Wyświetla listę wszystkich zadań w określonym koncie.
list(job_list_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Iterator, taki jak wystąpienie zadania CloudJob
Typ zwracany
Wyjątki
list_from_job_schedule
Wyświetla listę zadań utworzonych w ramach określonego harmonogramu zadań.
list_from_job_schedule(job_schedule_id, job_list_from_job_schedule_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- job_schedule_id
- str
Identyfikator harmonogramu zadań, z którego chcesz uzyskać listę zadań.
- job_list_from_job_schedule_options
- JobListFromJobScheduleOptions
Dodatkowe parametry operacji
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Iterator, taki jak wystąpienie zadania CloudJob
Typ zwracany
Wyjątki
list_preparation_and_release_task_status
Wyświetla stan wykonywania zadania przygotowania zadania i zwolnienia zadania dla określonego zadania w węzłach obliczeniowych, w których zadanie zostało uruchomione.
Ten interfejs API zwraca stan zadania przygotowania i wydania zadania we wszystkich węzłach obliczeniowych, które uruchamiają zadanie przygotowania zadania lub wydania zadania. Obejmuje to węzły obliczeniowe, które zostały od tego czasu usunięte z puli. Jeśli ten interfejs API jest wywoływany w zadaniu, które nie ma zadania przygotowania zadania lub wydania zadania, usługa Batch zwraca kod stanu HTTP 409 (konflikt) z kodem błędu 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
Dodatkowe parametry operacji
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Iterator, taki jak wystąpienie jobPreparationAndReleaseTaskExecutionInformation
Typ zwracany
Wyjątki
patch
Aktualizacje właściwości określonego zadania.
Zastępuje to tylko właściwości zadania określone w żądaniu. Jeśli na przykład zadanie ma ograniczenia, a żądanie nie określa elementu ograniczeń, zadanie zachowuje istniejące ograniczenia.
patch(job_id, job_patch_parameter, job_patch_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- raw
- bool
Metoda zwraca bezpośrednią odpowiedź obok zdeserializowanej odpowiedzi
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Brak lub Wartość ClientRawResponse, jeśli parametr raw=true
Typ zwracany
Wyjątki
terminate
Kończy określone zadanie, oznaczając je jako ukończone.
Po odebraniu żądania zakończenia zadania usługa Batch ustawia zadanie na stan zakończenia. Następnie usługa Batch kończy wszystkie uruchomione zadania skojarzone z zadaniem i uruchamia wszystkie wymagane zadania zwolnienia zadań. Następnie zadanie przechodzi do stanu ukończonego. Jeśli w stanie aktywnym istnieją jakiekolwiek zadania podrzędne, pozostaną w stanie aktywnym. Po zakończeniu zadania nie można dodać nowych zadań, a pozostałe aktywne zadania nie zostaną zaplanowane.
terminate(job_id, terminate_reason=None, job_terminate_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- terminate_reason
- str
- raw
- bool
Metoda zwraca bezpośrednią odpowiedź obok zdeserializowanej odpowiedzi
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Brak lub Wartość ClientRawResponse, jeśli parametr raw=true
Typ zwracany
Wyjątki
update
Aktualizacje właściwości określonego zadania.
Spowoduje to całkowite zastąpienie wszystkich aktualizowalnych właściwości zadania. Jeśli na przykład zadanie ma skojarzone ograniczenia i jeśli ograniczenia nie zostały określone z tym żądaniem, usługa Batch usunie istniejące ograniczenia.
update(job_id, job_update_parameter, job_update_options=None, custom_headers=None, raw=False, **operation_config)Parametry
- raw
- bool
Metoda zwraca bezpośrednią odpowiedź obok zdeserializowanej odpowiedzi
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Brak lub Wartość ClientRawResponse, jeśli parametr raw=true
Typ zwracany
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'>
Azure SDK for Python
Opinia
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź: https://aka.ms/ContentUserFeedback.
Prześlij i wyświetl opinię dla