ManagementGroupsOperations Klasa
Operacje ManagementGroupsOperations.
Nie należy bezpośrednio utworzyć wystąpienia tej klasy. Zamiast tego należy utworzyć wystąpienie klienta, które tworzy jego wystąpienie i dołącza je jako atrybut.
- Dziedziczenie
-
builtins.objectManagementGroupsOperations
Konstruktor
ManagementGroupsOperations(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
- models
Alias do klas modelu używanych w tej grupie operacji.
Metody
begin_create_or_update |
Utwórz lub zaktualizuj grupę zarządzania. Jeśli grupa zarządzania została już utworzona, a kolejne żądanie utworzenia zostanie wydane z różnymi właściwościami, właściwości grupy zarządzania zostaną zaktualizowane. |
begin_delete |
Usuń grupę zarządzania. Jeśli grupa zarządzania zawiera zasoby podrzędne, żądanie zakończy się niepowodzeniem. |
get |
Uzyskaj szczegółowe informacje o grupie zarządzania. |
get_descendants |
Wyświetl listę wszystkich jednostek, które pochodzą z grupy zarządzania. |
list |
Wyświetlanie listy grup zarządzania dla uwierzytelnioowanego użytkownika. |
update |
Aktualizowanie grupy zarządzania. |
begin_create_or_update
Utwórz lub zaktualizuj grupę zarządzania. Jeśli grupa zarządzania została już utworzona, a kolejne żądanie utworzenia zostanie wydane z różnymi właściwościami, właściwości grupy zarządzania zostaną zaktualizowane.
begin_create_or_update(group_id: str, create_management_group_request: '_models.CreateManagementGroupRequest', cache_control: str | None = 'no-cache', **kwargs: Any) -> LROPoller['_models.ManagementGroup' | '_models.AzureAsyncOperationResults']
Parametry
- create_management_group_request
- CreateManagementGroupRequest
Parametry tworzenia grupy zarządzania.
- cache_control
- str
Wskazuje, czy żądanie powinno korzystać z jakichkolwiek pamięci podręcznych. Wypełnij nagłówek wartością "no-cache", aby pominąć istniejące pamięci podręczne.
- cls
- callable
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
- continuation_token
- str
Token kontynuacji w celu ponownego uruchomienia bazy danych poller ze stanu zapisanego.
- polling
- bool lub PollingMethod
Domyślnie metoda sondowania będzie ARMPolling. Przekaż wartość False dla tej operacji, aby nie sondować lub przekazać własny zainicjowany obiekt sondowania dla osobistej strategii sondowania.
- polling_interval
- int
Domyślny czas oczekiwania między dwoma sondami dla operacji LRO, jeśli nie ma Retry-After nagłówka.
Zwraca
Wystąpienie LROPoller zwracające wartość ManagementGroup lub wynik cls(response)
Typ zwracany
Wyjątki
begin_delete
Usuń grupę zarządzania. Jeśli grupa zarządzania zawiera zasoby podrzędne, żądanie zakończy się niepowodzeniem.
begin_delete(group_id: str, cache_control: str | None = 'no-cache', **kwargs: Any) -> LROPoller['_models.AzureAsyncOperationResults']
Parametry
- cache_control
- str
Wskazuje, czy żądanie powinno korzystać z jakichkolwiek pamięci podręcznych. Wypełnij nagłówek wartością "no-cache", aby pominąć istniejące pamięci podręczne.
- cls
- callable
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
- continuation_token
- str
Token kontynuacji w celu ponownego uruchomienia bazy danych poller ze stanu zapisanego.
- polling
- bool lub PollingMethod
Domyślnie metoda sondowania będzie ARMPolling. Przekaż wartość False dla tej operacji, aby nie sondować lub przekazać własny zainicjowany obiekt sondowania dla osobistej strategii sondowania.
- polling_interval
- int
Domyślny czas oczekiwania między dwoma sondami dla operacji LRO, jeśli nie ma Retry-After nagłówka.
Zwraca
Wystąpienie LROPoller zwracające wartość AzureAsyncOperationResults lub wynik cls(response)
Typ zwracany
Wyjątki
get
Uzyskaj szczegółowe informacje o grupie zarządzania.
get(group_id: str, expand: str | '_models.Enum0' | None = None, recurse: bool | None = None, filter: str | None = None, cache_control: str | None = 'no-cache', **kwargs: Any) -> _models.ManagementGroup
Parametry
Parametr ciągu zapytania $expand=children umożliwia klientom żądanie dołączenia elementów podrzędnych do ładunku odpowiedzi. $expand=ścieżka zawiera ścieżkę z grupy głównej do bieżącej grupy. $expand=ancestors zawiera identyfikatory przodków bieżącej grupy.
- recurse
- bool
Parametr ciągu zapytania $recurse=true umożliwia klientom żądanie dołączenia całej hierarchii do ładunku odpowiedzi. Należy pamiętać, że $expand=elementy podrzędne muszą zostać przekazane, jeśli $recurse jest ustawiona na wartość true.
- filter
- str
Filtr, który umożliwia wykluczenie subskrypcji z wyników (tj. "$filter=children.childType ne Subscription".
- cache_control
- str
Wskazuje, czy żądanie powinno korzystać z jakichkolwiek pamięci podręcznych. Wypełnij nagłówek wartością "no-cache", aby pominąć istniejące pamięci podręczne.
- cls
- callable
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
Zwraca
ManagementGroup lub wynik cls(response)
Typ zwracany
Wyjątki
get_descendants
Wyświetl listę wszystkich jednostek, które pochodzą z grupy zarządzania.
get_descendants(group_id: str, skiptoken: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable['_models.DescendantListResult']
Parametry
- skiptoken
- str
Token kontynuacji strony jest używany tylko wtedy, gdy poprzednia operacja zwróciła częściowy wynik. Jeśli poprzednia odpowiedź zawiera element nextLink, wartość elementu nextLink będzie zawierać parametr tokenu, który określa punkt wyjścia do użycia dla kolejnych wywołań.
- top
- int
Liczba elementów, które mają być zwracane podczas pobierania wyników. Przekazanie tego elementu spowoduje zastąpienie $skipToken.
- cls
- callable
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
Zwraca
Iterator podobny do wystąpienia elementu DescendantListResult lub wyniku cls(response)
Typ zwracany
Wyjątki
list
Wyświetlanie listy grup zarządzania dla uwierzytelnioowanego użytkownika.
list(cache_control: str | None = 'no-cache', skiptoken: str | None = None, **kwargs: Any) -> Iterable['_models.ManagementGroupListResult']
Parametry
- cache_control
- str
Wskazuje, czy żądanie powinno korzystać z jakichkolwiek pamięci podręcznych. Wypełnij nagłówek wartością "no-cache", aby pominąć istniejące pamięci podręczne.
- skiptoken
- str
Token kontynuacji strony jest używany tylko wtedy, gdy poprzednia operacja zwróciła częściowy wynik. Jeśli poprzednia odpowiedź zawiera element nextLink, wartość elementu nextLink będzie zawierać parametr tokenu, który określa punkt wyjścia do użycia dla kolejnych wywołań.
- cls
- callable
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
Zwraca
Iterator podobny do wystąpienia klasy ManagementGroupListResult lub wyniku cls(response)
Typ zwracany
Wyjątki
update
Aktualizowanie grupy zarządzania.
update(group_id: str, patch_group_request: '_models.PatchManagementGroupRequest', cache_control: str | None = 'no-cache', **kwargs: Any) -> _models.ManagementGroup
Parametry
- cache_control
- str
Wskazuje, czy żądanie powinno korzystać z jakichkolwiek pamięci podręcznych. Wypełnij nagłówek wartością "no-cache", aby pominąć istniejące pamięci podręczne.
- cls
- callable
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
Zwraca
ManagementGroup lub wynik cls(response)
Typ zwracany
Wyjątki
Atrybuty
models
models = <module 'azure.mgmt.managementgroups.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\managementgroups\\models\\__init__.py'>
Azure SDK for Python