UserProxy Třída

Rozhraní pro interakci s konkrétním uživatelem.

Tato třída by neměla být vytvořena přímo. Místo toho použijte metodu <xref:DatabaseProxy.get_user_client> .

Dědičnost

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

výchozí hodnota: None

Metody

create_permission	Vytvořte oprávnění pro uživatele. Pokud chcete aktualizovat nebo nahradit existující oprávnění, použijte metodu upsert_permission .
delete_permission	Odstraňte zadané oprávnění od uživatele. Pokud oprávnění ještě neexistuje, vyvolá se výjimka.
get_permission	Získejte oprávnění identifikovaná id.
list_permissions	Vypíše všechna oprávnění pro uživatele.
query_permissions	Vrátí všechna oprávnění odpovídající danému dotazu.
read	Přečtěte si vlastnosti uživatele.
replace_permission	Nahradí zadané oprávnění, pokud pro uživatele existuje. Pokud oprávnění ještě neexistuje, vyvolá se výjimka.
upsert_permission	Vložte nebo aktualizujte zadané oprávnění. Pokud už oprávnění v kontejneru existuje, nahradí se. Pokud oprávnění neexistuje, vloží se.

create_permission

Vytvořte oprávnění pro uživatele.

Pokud chcete aktualizovat nebo nahradit existující oprávnění, použijte metodu upsert_permission .

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

Parametry

body

Vyžadováno

Objekt podobný diktování představující oprávnění k vytvoření.

response_hook

Callable

Volatelné vyvolání s metadaty odpovědi.

Návraty

Dikt představující nové oprávnění

Návratový typ

dict[str, Any]

Výjimky

CosmosHttpResponseError

Pokud se dané oprávnění nepodařilo vytvořit.

delete_permission

Odstraňte zadané oprávnění od uživatele.

Pokud oprávnění ještě neexistuje, vyvolá se výjimka.

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

Parametry

permission

Vyžadováno

ID (název) – dikt představující vlastnosti nebo <xref:azure.cosmos.user.Permission> instanci oprávnění, které se má nahradit.

response_hook

Callable

Volatelné vyvolání s metadaty odpovědi.

Návratový typ

None

Výjimky

CosmosHttpResponseError

Oprávnění nebylo úspěšně odstraněno.

CosmosResourceNotFoundError

Oprávnění pro uživatele neexistuje.

get_permission

Získejte oprávnění identifikovaná id.

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

Parametry

permission

Vyžadováno

ID (název) – dikt představující vlastnosti nebo <xref:azure.cosmos.user.Permission> instanci oprávnění, které se má načíst.

response_hook

Callable

Volatelné vyvolání s metadaty odpovědi.

Návraty

Dikt představující načtené oprávnění.

Návratový typ

dict[str, Any]

Výjimky

CosmosHttpResponseError

Pokud se dané oprávnění nepodařilo načíst.

list_permissions

Vypíše všechna oprávnění pro uživatele.

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

Parametry

max_item_count

Vyžadováno

Maximální počet oprávnění, která se mají vrátit v operaci výčtu.

response_hook

Callable

Volatelné vyvolání s metadaty odpovědi.

Návraty

Iterable of permissions (dicts).

Návratový typ

Iterable[dict[str, Any]]

Výjimky

CosmosHttpResponseError

Pokud se dané oprávnění nepodařilo vytvořit.

query_permissions

Vrátí všechna oprávnění odpovídající danému dotazu.

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

Parametry

query

Vyžadováno

Dotaz SQL služby Azure Cosmos DB, který se má spustit.

parameters

Vyžadováno

Volitelné pole parametrů dotazu. Ignorováno, pokud není zadaný žádný dotaz.

max_item_count

Vyžadováno

Maximální počet oprávnění, která se mají vrátit v operaci výčtu.

response_hook

Callable

Volatelné vyvolání s metadaty odpovědi.

Návraty

Iterable of permissions (dicts).

Návratový typ

Iterable[dict[str, Any]]

Výjimky

CosmosHttpResponseError

Pokud se dané oprávnění nepodařilo vytvořit.

read

Přečtěte si vlastnosti uživatele.

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

Parametry

response_hook

Callable

Volatelné vyvolání s metadaty odpovědi.

Návraty

Slovník načtených vlastností uživatele.

Návratový typ

dict[str, Any]

Výjimky

CosmosHttpResponseError

Pokud se danému uživateli nepodařilo načíst.

replace_permission

Nahradí zadané oprávnění, pokud pro uživatele existuje.

Pokud oprávnění ještě neexistuje, vyvolá se výjimka.

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

Parametry

permission

Vyžadováno

ID (název) – dikt představující vlastnosti nebo <xref:azure.cosmos.user.Permission> instanci oprávnění, které se má nahradit.

body

Vyžadováno

Objekt podobný diktování představující oprávnění k nahrazení.

response_hook

Callable

Volatelné vyvolání s metadaty odpovědi.

Návraty

Dikt představující oprávnění po dokončení nahrazení

Návratový typ

dict[str, Any]

Výjimky

CosmosHttpResponseError

Pokud nahrazení selhalo nebo neexistuje oprávnění s daným ID.

upsert_permission

Vložte nebo aktualizujte zadané oprávnění.

Pokud už oprávnění v kontejneru existuje, nahradí se. Pokud oprávnění neexistuje, vloží se.

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

Parametry

body

Vyžadováno

Objekt podobný diktování představující oprávnění k aktualizaci nebo vložení.

response_hook

Callable

Vyžadováno

Volatelné vyvolání s metadaty odpovědi.

Návraty

Dikt představující oprávnění upserted.

Návratový typ

dict[str, Any]

Výjimky

CosmosHttpResponseError

Pokud se dané oprávnění nepodařilo přenést.