UserProxy Klasa

Interfejs umożliwiający interakcję z określonym użytkownikiem.

Nie należy bezpośrednio utworzyć wystąpienia tej klasy. Zamiast tego użyj get_user_client metody .

Dziedziczenie

builtins.object

UserProxy

Konstruktor

UserProxy(client_connection: CosmosClientConnection, id: str, database_link: str, properties: Dict[str, Any] = None)

Parametry

client_connection

id

database_link

properties

wartość domyślna: None

Metody

create_permission	Utwórz uprawnienie dla użytkownika. Aby zaktualizować lub zastąpić istniejącą permisję upsert_permission , użyj metody .
delete_permission	Usuń określone uprawnienie od użytkownika. Jeśli uprawnienie jeszcze nie istnieje, zostanie zgłoszony wyjątek.
get_permission	Pobierz uprawnienie zidentyfikowane przez identyfikator.
list_permissions	Wyświetl listę wszystkich uprawnień dla użytkownika.
query_permissions	Zwróć wszystkie uprawnienia pasujące do danego zapytania.
read	Odczytywanie właściwości użytkownika.
replace_permission	Zastępuje określone uprawnienie, jeśli istnieje dla użytkownika. Jeśli uprawnienie jeszcze nie istnieje, zostanie zgłoszony wyjątek.
upsert_permission	Wstaw lub zaktualizuj określone uprawnienie. Jeśli uprawnienie już istnieje w kontenerze, zostanie zastąpione. Jeśli uprawnienie nie istnieje, zostanie wstawione.

create_permission

Utwórz uprawnienie dla użytkownika.

Aby zaktualizować lub zastąpić istniejącą permisję upsert_permission , użyj metody .

create_permission(body: Dict[str, Any], **kwargs: Any) -> Permission

Parametry

body

Wymagane

Obiekt przypominający dykt reprezentujący uprawnienie do utworzenia.

response_hook

Callable

Wywoływany element z metadanymi odpowiedzi.

Zwraca

Dykt reprezentujący nowe uprawnienie.

Typ zwracany

dict[str, Any]

Wyjątki

CosmosHttpResponseError

Jeśli nie można utworzyć podanego uprawnienia.

delete_permission

Usuń określone uprawnienie od użytkownika.

Jeśli uprawnienie jeszcze nie istnieje, zostanie zgłoszony wyjątek.

delete_permission(permission: str, **kwargs: Any) -> None

Parametry

permission

Wymagane

Identyfikator (nazwa), dykt reprezentujący właściwości lub Permission wystąpienie uprawnienia do zastąpienia.

response_hook

Callable

Wywoływany element z metadanymi odpowiedzi.

Typ zwracany

None

Wyjątki

CosmosHttpResponseError

Uprawnienie nie zostało pomyślnie usunięte.

CosmosResourceNotFoundError

Uprawnienie nie istnieje dla użytkownika.

get_permission

Pobierz uprawnienie zidentyfikowane przez identyfikator.

get_permission(permission: str, **kwargs: Any) -> Permission

Parametry

permission

Wymagane

Identyfikator (nazwa), dykt reprezentujący właściwości lub Permission wystąpienie uprawnienia do pobrania.

response_hook

Callable

Wywoływany element z metadanymi odpowiedzi.

Zwraca

Dykt reprezentujący pobrane uprawnienie.

Typ zwracany

dict[str, Any]

Wyjątki

CosmosHttpResponseError

Jeśli nie można pobrać podanego uprawnienia.

list_permissions

Wyświetl listę wszystkich uprawnień dla użytkownika.

list_permissions(max_item_count: int | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

Parametry

max_item_count

Wymagane

Maksymalna liczba uprawnień do zwrócenia w operacji wyliczania.

response_hook

Callable

Wywoływany element z metadanymi odpowiedzi.

Zwraca

Iterable uprawnień (dykt).

Typ zwracany

Iterable[dict[str, Any]]

Wyjątki

CosmosHttpResponseError

Jeśli nie można utworzyć podanego uprawnienia.

query_permissions

Zwróć wszystkie uprawnienia pasujące do danego zapytania.

query_permissions(query: str, parameters: List[str] | None = None, max_item_count: int | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

Parametry

query

Wymagane

Zapytanie SQL usługi Azure Cosmos DB do wykonania.

parameters

Wymagane

Opcjonalna tablica parametrów zapytania. Ignorowane, jeśli nie podano kwerendy.

max_item_count

Wymagane

Maksymalna liczba uprawnień do zwrócenia w operacji wyliczania.

response_hook

Callable

Wywoływany element z metadanymi odpowiedzi.

Zwraca

Iterable uprawnień (dykt).

Typ zwracany

Iterable[dict[str, Any]]

Wyjątki

CosmosHttpResponseError

Jeśli nie można utworzyć podanego uprawnienia.

read

Odczytywanie właściwości użytkownika.

read(**kwargs: Any) -> Dict[str, Any]

Parametry

response_hook

Callable

Wywoływany element z metadanymi odpowiedzi.

Zwraca

Słownik właściwości pobranego użytkownika.

Typ zwracany

dict[str, Any]

Wyjątki

CosmosHttpResponseError

Jeśli nie można pobrać danego użytkownika.

replace_permission

Zastępuje określone uprawnienie, jeśli istnieje dla użytkownika.

Jeśli uprawnienie jeszcze nie istnieje, zostanie zgłoszony wyjątek.

replace_permission(permission: str, body: Dict[str, Any], **kwargs: Any) -> Permission

Parametry

permission

Wymagane

Identyfikator (nazwa), dykt reprezentujący właściwości lub Permission wystąpienie uprawnienia do zastąpienia.

body

Wymagane

Obiekt przypominający dykt reprezentujący uprawnienie do zamiany.

response_hook

Callable

Wywoływany element z metadanymi odpowiedzi.

Zwraca

Dykt reprezentujący uprawnienie po zastąpieniu przeszedł.

Typ zwracany

dict[str, Any]

Wyjątki

CosmosHttpResponseError

Jeśli zamiana nie powiodła się lub uprawnienie o danym identyfikatorze nie istnieje.

upsert_permission

Wstaw lub zaktualizuj określone uprawnienie.

Jeśli uprawnienie już istnieje w kontenerze, zostanie zastąpione. Jeśli uprawnienie nie istnieje, zostanie wstawione.

upsert_permission(body: Dict[str, Any], **kwargs: Any) -> Permission

Parametry

body

Wymagane

Obiekt przypominający dykt reprezentujący uprawnienie do aktualizowania lub wstawiania.

response_hook

Callable

Wymagane

Wywoływany element z metadanymi odpowiedzi.

Zwraca

Dykt reprezentujący uprawnienie upserted.

Typ zwracany

dict[str, Any]

Wyjątki

CosmosHttpResponseError

Jeśli podane uprawnienie nie może zostać wyzwolone.