UserProxy Klass

Ett gränssnitt för att interagera med en specifik användare.

Den här klassen ska inte instansieras direkt. Använd get_user_client i stället metoden .

Arv

builtins.object

UserProxy

Konstruktor

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

Parametrar

client_connection

id

database_link

properties

standardvärde: None

Metoder

create_permission	Skapa en behörighet för användaren. Om du vill uppdatera eller ersätta en befintlig permision använder du upsert_permission metoden .
delete_permission	Ta bort den angivna behörigheten från användaren. Om behörigheten inte redan finns utlöses ett undantag.
get_permission	Hämta behörigheten som identifieras av ID.
list_permissions	Visa en lista över alla behörigheter för användaren.
query_permissions	Returnera alla behörigheter som matchar den angivna frågan.
read	Läs användaregenskaper.
replace_permission	Ersätter den angivna behörigheten om den finns för användaren. Om behörigheten inte redan finns utlöses ett undantag.
upsert_permission	Infoga eller uppdatera den angivna behörigheten. Om behörigheten redan finns i containern ersätts den. Om behörigheten inte finns infogas den.

create_permission

Skapa en behörighet för användaren.

Om du vill uppdatera eller ersätta en befintlig permision använder du upsert_permission metoden .

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

Parametrar

body

Obligatorisk

Ett diktaliknande objekt som representerar behörigheten att skapa.

response_hook

Callable

En anropsbar anropad med svarsmetadata.

Returer

En diktamen som representerar den nya behörigheten.

Returtyp

dict[str, Any]

Undantag

CosmosHttpResponseError

Om den angivna behörigheten inte kunde skapas.

delete_permission

Ta bort den angivna behörigheten från användaren.

Om behörigheten inte redan finns utlöses ett undantag.

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

Parametrar

permission

Obligatorisk

ID:t (namn), diktat som representerar egenskaperna eller Permission instansen av behörigheten som ska ersättas.

response_hook

Callable

En anropsbar anropad med svarsmetadata.

Returtyp

None

Undantag

CosmosHttpResponseError

Behörigheten har inte tagits bort.

CosmosResourceNotFoundError

Behörigheten finns inte för användaren.

get_permission

Hämta behörigheten som identifieras av ID.

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

Parametrar

permission

Obligatorisk

ID:t (namn), diktat som representerar egenskaperna eller Permission instansen av behörigheten som ska hämtas.

response_hook

Callable

En anropsbar anropad med svarsmetadata.

Returer

En diktamen som representerar den hämtade behörigheten.

Returtyp

dict[str, Any]

Undantag

CosmosHttpResponseError

Om den angivna behörigheten inte kunde hämtas.

list_permissions

Visa en lista över alla behörigheter för användaren.

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

Parametrar

max_item_count

Obligatorisk

Maximalt antal behörigheter som ska returneras i uppräkningsåtgärden.

response_hook

Callable

En anropsbar anropad med svarsmetadata.

Returer

En iterabel behörighet (dikta).

Returtyp

Iterable[dict[str, Any]]

Undantag

CosmosHttpResponseError

Om den angivna behörigheten inte kunde skapas.

query_permissions

Returnera alla behörigheter som matchar den angivna frågan.

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

Parametrar

query

Obligatorisk

Azure Cosmos DB SQL-frågan som ska köras.

parameters

Obligatorisk

Valfri matris med parametrar i frågan. Ignoreras om ingen fråga har angetts.

max_item_count

Obligatorisk

Maximalt antal behörigheter som ska returneras i uppräkningsåtgärden.

response_hook

Callable

En anropsbar anropad med svarsmetadata.

Returer

En iterabel behörighet (dikta).

Returtyp

Iterable[dict[str, Any]]

Undantag

CosmosHttpResponseError

Om den angivna behörigheten inte kunde skapas.

read

Läs användaregenskaper.

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

Parametrar

response_hook

Callable

En anropsbar anropad med svarsmetadata.

Returer

En ordlista över de hämtade användaregenskaperna.

Returtyp

dict[str, Any]

Undantag

CosmosHttpResponseError

Om den angivna användaren inte kunde hämtas.

replace_permission

Ersätter den angivna behörigheten om den finns för användaren.

Om behörigheten inte redan finns utlöses ett undantag.

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

Parametrar

permission

Obligatorisk

ID:t (namn), diktat som representerar egenskaperna eller Permission instansen av behörigheten som ska ersättas.

body

Obligatorisk

Ett diktaliknande objekt som representerar behörigheten att ersätta.

response_hook

Callable

En anropsbar anropad med svarsmetadata.

Returer

En diktamen som representerar behörigheten efter ersättningen gick igenom.

Returtyp

dict[str, Any]

Undantag

CosmosHttpResponseError

Om ersättningen misslyckades eller om behörigheten med det angivna ID:t inte finns.

upsert_permission

Infoga eller uppdatera den angivna behörigheten.

Om behörigheten redan finns i containern ersätts den. Om behörigheten inte finns infogas den.

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

Parametrar

body

Obligatorisk

Ett diktaliknande objekt som representerar behörigheten att uppdatera eller infoga.

response_hook

Callable

Obligatorisk

En anropsbar anropad med svarsmetadata.

Returer

En diktamen som representerar upserted-behörigheten.

Returtyp

dict[str, Any]

Undantag

CosmosHttpResponseError

Om den angivna behörigheten inte kunde upserted.