EntitiesOperations Klasa
EntitiesOperations operacje asynchroniczne.
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.objectEntitiesOperations
Konstruktor
EntitiesOperations(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
list |
Wyświetl listę wszystkich jednostek (grupy zarządzania, subskrypcje itp.) dla uwierzytelnioowanego użytkownika. |
list
Wyświetl listę wszystkich jednostek (grupy zarządzania, subskrypcje itp.) dla uwierzytelnioowanego użytkownika.
list(skiptoken: str | None = None, skip: int | None = None, top: int | None = None, select: str | None = None, search: str | Enum2 | None = None, filter: str | None = None, view: str | Enum3 | None = None, group_name: str | None = None, cache_control: str | None = 'no-cache', **kwargs: Any) -> AsyncIterable[EntityListResult]
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ń.
- skip
- int
Liczba jednostek do pominięcia podczas pobierania wyników. Przekazanie tego elementu spowoduje zastąpienie $skipToken.
- top
- int
Liczba elementów, które mają być zwracane podczas pobierania wyników. Przekazanie tego elementu spowoduje zastąpienie $skipToken.
- select
- str
Ten parametr określa pola do uwzględnienia w odpowiedzi. Może zawierać dowolną kombinację wartości Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, np. "$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain". Po określeniu parametru $select można zastąpić wybór w $skipToken.
Parametr $search jest używany w połączeniu z parametrem $filter, aby zwrócić trzy różne dane wyjściowe w zależności od przekazanego parametru. W przypadku $search=AllowedParents interfejs API zwróci informacje o jednostce wszystkich grup, do których żądana jednostka będzie mogła wykonać reparent zgodnie z uprawnieniami użytkownika. W przypadku $search=AllowedChildren interfejs API zwróci informacje o jednostce wszystkich jednostek, które można dodać jako elementy podrzędne żądanej jednostki. W przypadku $search=ParentAndFirstLevelChildren interfejs API zwróci element nadrzędny i pierwszy poziom elementów podrzędnych, do których użytkownik ma bezpośredni dostęp lub dostęp pośredni za pośrednictwem jednego z elementów potomnych. W przypadku $search=ParentOnly interfejs API zwróci tylko grupę, jeśli użytkownik ma dostęp do co najmniej jednego elementu podrzędnego grupy. W przypadku $search=ChildrenOnly interfejs API zwróci tylko pierwszy poziom elementów podrzędnych informacji o jednostce grupy określonych w $filter. Użytkownik musi mieć bezpośredni dostęp do jednostek podrzędnych lub jednego z elementów podrzędnych, aby był widoczny w wynikach.
- filter
- str
Parametr filtru umożliwia filtrowanie pól nazwy lub nazwy wyświetlanej. Możesz sprawdzić równość w polu nazwy (np. name eq "{entityName}") i sprawdzić podciąg w polach nazwy lub nazwy wyświetlanej (np. contains(name, "{substringToSearch}"), contains(displayName, "{substringToSearch")). Należy pamiętać, że pola "{entityName}" i "{substringToSearch}" są sprawdzane bez uwzględniania wielkości liter.
Parametr widoku umożliwia klientom filtrowanie typu danych zwracanych przez wywołanie getEntities.
- group_name
- str
Filtr, który pozwala wywołać jednostki get, aby skupić się na określonej grupie (tj. "$filter=name eq 'groupName'").
- 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
Iterator, taki jak wystąpienie elementu EntityListResult 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