UserProxy Osztály

Egy adott felhasználóval való interakcióra szolgáló felület.

Ezt az osztályt nem szabad közvetlenül példányosítani. Ehelyett használja a metódust get_user_client .

Öröklődés

builtins.object

UserProxy

Konstruktor

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

Paraméterek

client_connection

id

database_link

properties

alapértelmezett érték: None

Metódusok

create_permission	Hozzon létre egy engedélyt a felhasználó számára. Meglévő permision frissítéséhez vagy cseréjéhez használja a metódust upsert_permission .
delete_permission	Törölje a megadott engedélyt a felhasználótól. Ha az engedély még nem létezik, kivétel keletkezik.
get_permission	Kérje le az azonosító alapján azonosított engedélyt.
list_permissions	A felhasználó összes engedélyének listázása.
query_permissions	Adja vissza az adott lekérdezésnek megfelelő összes engedélyt.
read	Felhasználói tulajdonságok olvasása.
replace_permission	Lecseréli a megadott engedélyt, ha létezik a felhasználó számára. Ha az engedély még nem létezik, kivétel keletkezik.
upsert_permission	A megadott engedély beszúrása vagy frissítése. Ha az engedély már létezik a tárolóban, a rendszer lecseréli. Ha az engedély nem létezik, akkor be lesz szúrva.

create_permission

Hozzon létre egy engedélyt a felhasználó számára.

Meglévő permision frissítéséhez vagy cseréjéhez használja a metódust upsert_permission .

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

Paraméterek

body

Kötelező

A létrehozási engedélyt jelképező diktálásszerű objektum.

response_hook

Callable

Meghívható a válasz metaadataival.

Válaszok

Az új engedélyt jelképező diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Ha a megadott engedély nem hozható létre.

delete_permission

Törölje a megadott engedélyt a felhasználótól.

Ha az engedély még nem létezik, kivétel keletkezik.

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

Paraméterek

permission

Kötelező

A lecserélni kívánt engedély tulajdonságait vagy Permission példányát jelölő azonosító (név).

response_hook

Callable

Meghívható a válasz metaadataival.

Visszatérési típus

None

Kivételek

CosmosHttpResponseError

Az engedély törlése nem sikerült.

CosmosResourceNotFoundError

Az engedély nem létezik a felhasználó számára.

get_permission

Kérje le az azonosító alapján azonosított engedélyt.

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

Paraméterek

permission

Kötelező

A lekérni kívánt engedély tulajdonságait vagy Permission példányát jelölő azonosító (név).

response_hook

Callable

Meghívható a válasz metaadataival.

Válaszok

A beolvasott engedélyt jelölő diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Ha a megadott engedélyt nem sikerült lekérni.

list_permissions

A felhasználó összes engedélyének listázása.

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

Paraméterek

max_item_count

Kötelező

Az enumerálási műveletben visszaadandó engedélyek maximális száma.

response_hook

Callable

Meghívható a válasz metaadataival.

Válaszok

Az engedélyek iterable (diktálások) listája.

Visszatérési típus

Iterable[dict[str, Any]]

Kivételek

CosmosHttpResponseError

Ha a megadott engedély nem hozható létre.

query_permissions

Adja vissza az adott lekérdezésnek megfelelő összes engedélyt.

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

Paraméterek

query

Kötelező

A végrehajtandó Azure Cosmos DB SQL-lekérdezés.

parameters

Kötelező

Nem kötelező paramétertömb a lekérdezéshez. Figyelmen kívül hagyja, ha nincs megadva lekérdezés.

max_item_count

Kötelező

Az enumerálási műveletben visszaadandó engedélyek maximális száma.

response_hook

Callable

Meghívható a válasz metaadataival.

Válaszok

Az engedélyek iterable (diktálások) listája.

Visszatérési típus

Iterable[dict[str, Any]]

Kivételek

CosmosHttpResponseError

Ha a megadott engedély nem hozható létre.

read

Felhasználói tulajdonságok olvasása.

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

Paraméterek

response_hook

Callable

Meghívható a válasz metaadataival.

Válaszok

A beolvasott felhasználói tulajdonságok szótára.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Ha az adott felhasználót nem sikerült lekérni.

replace_permission

Lecseréli a megadott engedélyt, ha létezik a felhasználó számára.

Ha az engedély még nem létezik, kivétel keletkezik.

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

Paraméterek

permission

Kötelező

A lecserélni kívánt engedély tulajdonságait vagy Permission példányát jelölő azonosító (név).

body

Kötelező

Egy dict-szerű objektum, amely a csere engedélyét jelképezi.

response_hook

Callable

Meghívható a válasz metaadataival.

Válaszok

A csere után az engedélyt jelölő diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Ha a csere sikertelen volt, vagy az engedély a megadott azonosítóval nem létezik.

upsert_permission

A megadott engedély beszúrása vagy frissítése.

Ha az engedély már létezik a tárolóban, a rendszer lecseréli. Ha az engedély nem létezik, akkor be lesz szúrva.

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

Paraméterek

body

Kötelező

Egy diktálásszerű objektum, amely a frissítési vagy beszúrási engedélyt jelképezi.

response_hook

Callable

Kötelező

Meghívható a válasz metaadataival.

Válaszok

A beszúrt engedélyt jelölő diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Ha a megadott engedélyt nem sikerült beszúrni.