PoolOperations Klasa
Operacje PoolOperations.
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.objectPoolOperations
Konstruktor
PoolOperations(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 pulę do określonego konta. Podczas nazewnictwa pul należy unikać dołączania 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 pulę z określonego konta. Gdy zażądasz usunięcia puli, zostaną wykonane następujące akcje: stan puli zostanie ustawiony na usunięcie; wszystkie trwające operacje zmiany rozmiaru w puli są zatrzymywane; usługa Batch rozpoczyna zmianę rozmiaru puli na zero węzłów obliczeniowych; wszystkie zadania uruchomione w istniejących węzłach obliczeniowych są przerywane i ponownie w kolejce (tak jak gdyby zażądano operacji zmiany rozmiaru puli z domyślną opcją ponownego kolejkowania); na koniec pula zostanie usunięta z systemu. Ponieważ uruchomione zadania są ponownie w kolejce, użytkownik może ponownie uruchomić te zadania, aktualizując zadanie w celu kierowania innej puli. Zadania można następnie uruchomić w nowej puli. Jeśli chcesz zastąpić zachowanie ponownego kolejkowania, należy jawnie wywołać zmianę rozmiaru puli, aby zmniejszyć pulę do zera przed usunięciem puli. Jeśli wywołasz interfejs API Update, Patch lub Delete w puli w stanie usuwania, zakończy się niepowodzeniem z kodem stanu HTTP 409 z kodem błędu PoolBeingDeleted. |
disable_auto_scale |
Wyłącza automatyczne skalowanie dla puli. |
enable_auto_scale |
Włącza automatyczne skalowanie dla puli. Nie można włączyć automatycznego skalowania w puli, jeśli operacja zmiany rozmiaru jest w toku w puli. Jeśli automatyczne skalowanie puli jest obecnie wyłączone, należy określić prawidłową formułę autoskalowania w ramach żądania. Jeśli automatyczne skalowanie puli jest już włączone, możesz określić nową formułę autoskalowania i/lub nowy interwał oceny. Nie można wywołać tego interfejsu API dla tej samej puli więcej niż raz co 30 sekund. |
evaluate_auto_scale |
Pobiera wynik oceny formuły automatycznego skalowania w puli. Ten interfejs API jest przeznaczony przede wszystkim do sprawdzania poprawności formuły autoskalowania, ponieważ po prostu zwraca wynik bez stosowania formuły do puli. Pula musi mieć włączone automatyczne skalowanie, aby ocenić formułę. |
exists |
Pobiera podstawowe właściwości puli. |
get |
Pobiera informacje o określonej puli. |
list |
Wyświetla listę wszystkich pul w określonym koncie. |
list_usage_metrics |
Wyświetla listę metryk użycia zagregowanych według puli w poszczególnych interwałach czasowych dla określonego konta. Jeśli nie określisz klauzuli $filter, w tym poolId, odpowiedź zawiera wszystkie pule, które istniały w ramach konta w zakresie czasu zwracanych interwałów agregacji. Jeśli nie określisz klauzuli $filter, w tym parametru startTime lub endTime, te filtry są domyślne dla godzin początkowych i końcowych ostatniego dostępnego interwału agregacji; oznacza to, że zwracany jest tylko ostatni interwał agregacji. |
patch |
Aktualizacje właściwości określonej puli. Zastępuje to tylko właściwości puli określone w żądaniu. Jeśli na przykład pula ma skojarzona wartość StartTask, a żądanie nie określa elementu StartTask, pula przechowuje istniejący element StartTask. |
remove_nodes |
Usuwa węzły obliczeniowe z określonej puli. Ta operacja może być uruchamiana tylko wtedy, gdy stan alokacji puli jest stały. Po uruchomieniu tej operacji stan alokacji zmienia się z stałego na zmianę rozmiaru. Każde żądanie może usunąć maksymalnie 100 węzłów. |
resize |
Zmienia liczbę węzłów obliczeniowych przypisanych do puli. Rozmiar puli można zmienić tylko wtedy, gdy jego stan alokacji jest stały. Jeśli rozmiar puli jest już zmieniany, żądanie kończy się niepowodzeniem z kodem stanu 409. Po zmianie rozmiaru puli stan alokacji puli zmienia się ze stałej na zmianę rozmiaru. Nie można zmienić rozmiaru pul skonfigurowanych do automatycznego skalowania. Jeśli spróbujesz to zrobić, usługa Batch zwróci błąd 409. Jeśli rozmiar puli zostanie zmieniony w dół, usługa Batch wybierze węzły obliczeniowe do usunięcia. Aby usunąć określone węzły obliczeniowe, użyj interfejsu API usuwania węzłów obliczeniowych w puli. |
stop_resize |
Zatrzymuje trwającą operację zmiany rozmiaru w puli. Nie powoduje to przywrócenia puli do poprzedniego stanu przed operacją zmiany rozmiaru: zatrzymuje tylko wszelkie dalsze zmiany, a pula zachowuje bieżący stan. Po zatrzymaniu pula stabilizuje się na liczbie węzłów obliczeniowych, na których była wykonywana operacja zatrzymania. Podczas operacji zatrzymania stan alokacji puli zmienia się najpierw na zatrzymanie, a następnie na stałą. Operacja zmiany rozmiaru nie musi być jawnym żądaniem zmiany rozmiaru puli; Tego interfejsu API można również użyć do zatrzymania początkowego rozmiaru puli podczas jego tworzenia. |
update_properties |
Aktualizacje właściwości określonej puli. Spowoduje to całkowite zastąpienie wszystkich aktualizowalnych właściwości puli. Jeśli na przykład pula ma skojarzona wartość StartTask i jeśli parametr StartTask nie zostanie określony z tym żądaniem, usługa Batch usunie istniejący obiekt StartTask. |
add
Dodaje pulę do określonego konta.
Podczas nazewnictwa pul należy unikać dołączania 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(pool, pool_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 pulę z określonego konta.
Gdy zażądasz usunięcia puli, zostaną wykonane następujące akcje: stan puli zostanie ustawiony na usunięcie; wszystkie trwające operacje zmiany rozmiaru w puli są zatrzymywane; usługa Batch rozpoczyna zmianę rozmiaru puli na zero węzłów obliczeniowych; wszystkie zadania uruchomione w istniejących węzłach obliczeniowych są przerywane i ponownie w kolejce (tak jak gdyby zażądano operacji zmiany rozmiaru puli z domyślną opcją ponownego kolejkowania); na koniec pula zostanie usunięta z systemu. Ponieważ uruchomione zadania są ponownie w kolejce, użytkownik może ponownie uruchomić te zadania, aktualizując zadanie w celu kierowania innej puli. Zadania można następnie uruchomić w nowej puli. Jeśli chcesz zastąpić zachowanie ponownego kolejkowania, należy jawnie wywołać zmianę rozmiaru puli, aby zmniejszyć pulę do zera przed usunięciem puli. Jeśli wywołasz interfejs API Update, Patch lub Delete w puli w stanie usuwania, zakończy się niepowodzeniem z kodem stanu HTTP 409 z kodem błędu PoolBeingDeleted.
delete(pool_id, pool_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_auto_scale
Wyłącza automatyczne skalowanie dla puli.
disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- pool_disable_auto_scale_options
- PoolDisableAutoScaleOptions
Dodatkowe parametry operacji
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Brak lub ClientRawResponse, jeśli wartość raw=true
Typ zwracany
Wyjątki
enable_auto_scale
Włącza automatyczne skalowanie dla puli.
Nie można włączyć automatycznego skalowania w puli, jeśli operacja zmiany rozmiaru jest w toku w puli. Jeśli automatyczne skalowanie puli jest obecnie wyłączone, należy określić prawidłową formułę autoskalowania w ramach żądania. Jeśli automatyczne skalowanie puli jest już włączone, możesz określić nową formułę autoskalowania i/lub nowy interwał oceny. Nie można wywołać tego interfejsu API dla tej samej puli więcej niż raz co 30 sekund.
enable_auto_scale(pool_id, auto_scale_formula=None, auto_scale_evaluation_interval=None, pool_enable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- auto_scale_formula
- str
Formuła jest sprawdzana pod kątem ważności przed zastosowaniem jej do puli. Jeśli formuła jest nieprawidłowa, usługa Batch odrzuca żądanie ze szczegółowymi informacjami o błędzie. Aby uzyskać więcej informacji na temat określania tej formuły, zobacz Automatyczne skalowanie węzłów obliczeniowych w puli Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- auto_scale_evaluation_interval
- <xref:timedelta>
Wartość domyślna to 15 minut. Minimalna i maksymalna wartość to odpowiednio 5 minut i 168 godzin. Jeśli określisz wartość mniejszą niż 5 minut lub większą niż 168 godzin, usługa Batch odrzuci żądanie z nieprawidłowym błędem wartości właściwości; jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (nieprawidłowe żądanie). Jeśli określisz nowy interwał, istniejący harmonogram oceny skalowania automatycznego zostanie zatrzymany, a zostanie uruchomiony nowy harmonogram oceny autoskalu, a czas rozpoczęcia tego żądania zostanie uruchomiony.
- pool_enable_auto_scale_options
- PoolEnableAutoScaleOptions
Dodatkowe parametry operacji
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Brak lub ClientRawResponse, jeśli wartość raw=true
Typ zwracany
Wyjątki
evaluate_auto_scale
Pobiera wynik oceny formuły automatycznego skalowania w puli.
Ten interfejs API jest przeznaczony przede wszystkim do sprawdzania poprawności formuły autoskalowania, ponieważ po prostu zwraca wynik bez stosowania formuły do puli. Pula musi mieć włączone automatyczne skalowanie, aby ocenić formułę.
evaluate_auto_scale(pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- pool_id
- str
Identyfikator puli, na której ma być obliczana formuła automatycznego skalowania.
- auto_scale_formula
- str
Formuła jest weryfikowana i obliczana jej wyniki, ale nie jest stosowana do puli. Aby zastosować formułę do puli, "Włącz automatyczne skalowanie w puli". Aby uzyskać więcej informacji na temat określania tej formuły, zobacz Automatyczne skalowanie węzłów obliczeniowych w puli Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- pool_evaluate_auto_scale_options
- PoolEvaluateAutoScaleOptions
Dodatkowe parametry operacji
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
AutoScaleRun lub ClientRawResponse, jeśli wartość raw=true
Typ zwracany
Wyjątki
exists
Pobiera podstawowe właściwości puli.
exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
bool lub ClientRawResponse, jeśli raw=true
Typ zwracany
Wyjątki
get
Pobiera informacje o określonej puli.
get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
CloudPool lub ClientRawResponse, jeśli raw=true
Typ zwracany
Wyjątki
list
Wyświetla listę wszystkich pul w określonym koncie.
list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Iterator, taki jak wystąpienie usługi CloudPool
Typ zwracany
Wyjątki
list_usage_metrics
Wyświetla listę metryk użycia zagregowanych według puli w poszczególnych interwałach czasowych dla określonego konta.
Jeśli nie określisz klauzuli $filter, w tym poolId, odpowiedź zawiera wszystkie pule, które istniały w ramach konta w zakresie czasu zwracanych interwałów agregacji. Jeśli nie określisz klauzuli $filter, w tym parametru startTime lub endTime, te filtry są domyślne dla godzin początkowych i końcowych ostatniego dostępnego interwału agregacji; oznacza to, że zwracany jest tylko ostatni interwał agregacji.
list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- pool_list_usage_metrics_options
- PoolListUsageMetricsOptions
Dodatkowe parametry operacji
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Iterator, taki jak wystąpienie metryki PoolUsageMetrics
Typ zwracany
Wyjątki
patch
Aktualizacje właściwości określonej puli.
Zastępuje to tylko właściwości puli określone w żądaniu. Jeśli na przykład pula ma skojarzona wartość StartTask, a żądanie nie określa elementu StartTask, pula przechowuje istniejący element StartTask.
patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Brak lub Wartość ClientRawResponse, jeśli parametr raw=true
Typ zwracany
Wyjątki
remove_nodes
Usuwa węzły obliczeniowe z określonej puli.
Ta operacja może być uruchamiana tylko wtedy, gdy stan alokacji puli jest stały. Po uruchomieniu tej operacji stan alokacji zmienia się z stałego na zmianę rozmiaru. Każde żądanie może usunąć maksymalnie 100 węzłów.
remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- pool_remove_nodes_options
- PoolRemoveNodesOptions
Dodatkowe parametry operacji
- 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
resize
Zmienia liczbę węzłów obliczeniowych przypisanych do puli.
Rozmiar puli można zmienić tylko wtedy, gdy jego stan alokacji jest stały. Jeśli rozmiar puli jest już zmieniany, żądanie kończy się niepowodzeniem z kodem stanu 409. Po zmianie rozmiaru puli stan alokacji puli zmienia się ze stałej na zmianę rozmiaru. Nie można zmienić rozmiaru pul skonfigurowanych do automatycznego skalowania. Jeśli spróbujesz to zrobić, usługa Batch zwróci błąd 409. Jeśli rozmiar puli zostanie zmieniony w dół, usługa Batch wybierze węzły obliczeniowe do usunięcia. Aby usunąć określone węzły obliczeniowe, użyj interfejsu API usuwania węzłów obliczeniowych w puli.
resize(pool_id, pool_resize_parameter, pool_resize_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
stop_resize
Zatrzymuje trwającą operację zmiany rozmiaru w puli.
Nie powoduje to przywrócenia puli do poprzedniego stanu przed operacją zmiany rozmiaru: zatrzymuje tylko wszelkie dalsze zmiany, a pula zachowuje bieżący stan. Po zatrzymaniu pula stabilizuje się na liczbie węzłów obliczeniowych, na których była wykonywana operacja zatrzymania. Podczas operacji zatrzymania stan alokacji puli zmienia się najpierw na zatrzymanie, a następnie na stałą. Operacja zmiany rozmiaru nie musi być jawnym żądaniem zmiany rozmiaru puli; Tego interfejsu API można również użyć do zatrzymania początkowego rozmiaru puli podczas jego tworzenia.
stop_resize(pool_id, pool_stop_resize_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
update_properties
Aktualizacje właściwości określonej puli.
Spowoduje to całkowite zastąpienie wszystkich aktualizowalnych właściwości puli. Jeśli na przykład pula ma skojarzona wartość StartTask i jeśli parametr StartTask nie zostanie określony z tym żądaniem, usługa Batch usunie istniejący obiekt StartTask.
update_properties(pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config)
Parametry
- pool_update_properties_options
- PoolUpdatePropertiesOptions
Dodatkowe parametry operacji
- 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