UserProxy Klasse

Eine Schnittstelle für die Interaktion mit einem bestimmten Benutzer.

Diese Klasse sollte nicht direkt instanziiert werden. Verwenden Sie stattdessen die get_user_client -Methode.

Vererbung

builtins.object

UserProxy

Konstruktor

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

Parameter

client_connection

id

database_link

properties

Standardwert: None

Methoden

create_permission	Erstellen Sie eine Berechtigung für den Benutzer. Verwenden Sie die upsert_permission -Methode, um eine vorhandene Permision zu aktualisieren oder zu ersetzen.
delete_permission	Löschen Sie die angegebene Berechtigung vom Benutzer. Wenn die Berechtigung noch nicht vorhanden ist, wird eine Ausnahme ausgelöst.
get_permission	Rufen Sie die durch die ID identifizierte Berechtigung ab.
list_permissions	Listet alle Berechtigungen für den Benutzer auf.
query_permissions	Gibt alle Berechtigungen zurück, die der angegebenen Abfrage entsprechen.
read	Benutzereigenschaften lesen.
replace_permission	Ersetzt die angegebene Berechtigung, wenn sie für den Benutzer vorhanden ist. Wenn die Berechtigung noch nicht vorhanden ist, wird eine Ausnahme ausgelöst.
upsert_permission	Fügen Sie die angegebene Berechtigung ein, oder aktualisieren Sie sie. Wenn die Berechtigung bereits im Container vorhanden ist, wird sie ersetzt. Wenn die Berechtigung nicht vorhanden ist, wird sie eingefügt.

create_permission

Erstellen Sie eine Berechtigung für den Benutzer.

Verwenden Sie die upsert_permission -Methode, um eine vorhandene Permision zu aktualisieren oder zu ersetzen.

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

Parameter

body

Erforderlich

Ein dict-ähnliches Objekt, das die Berechtigung zum Erstellen darstellt.

response_hook

Callable

Ein aufrufbarer Aufruf, der mit den Antwortmetadaten aufgerufen wird.

Gibt zurück

Ein Diktat, das die neue Berechtigung darstellt.

Rückgabetyp

dict[str, Any]

Ausnahmen

CosmosHttpResponseError

Wenn die angegebene Berechtigung nicht erstellt werden konnte.

delete_permission

Löschen Sie die angegebene Berechtigung vom Benutzer.

Wenn die Berechtigung noch nicht vorhanden ist, wird eine Ausnahme ausgelöst.

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

Parameter

permission

Erforderlich

Die ID (Name), ein Diktat, das die Eigenschaften oder Permission Instanzen der zu ersetzenden Berechtigung darstellt.

response_hook

Callable

Ein aufrufbarer Aufruf, der mit den Antwortmetadaten aufgerufen wird.

Rückgabetyp

None

Ausnahmen

CosmosHttpResponseError

Die Berechtigung wurde nicht erfolgreich gelöscht.

CosmosResourceNotFoundError

Die Berechtigung ist für den Benutzer nicht vorhanden.

get_permission

Rufen Sie die durch die ID identifizierte Berechtigung ab.

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

Parameter

permission

Erforderlich

Die ID (Name), ein Diktat, das die Eigenschaften oder Permission Instanzen der abzurufenden Berechtigung darstellt.

response_hook

Callable

Ein aufrufbarer Aufruf, der mit den Antwortmetadaten aufgerufen wird.

Gibt zurück

Ein Diktat, das die abgerufene Berechtigung darstellt.

Rückgabetyp

dict[str, Any]

Ausnahmen

CosmosHttpResponseError

Wenn die angegebene Berechtigung nicht abgerufen werden konnte.

list_permissions

Listet alle Berechtigungen für den Benutzer auf.

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

Parameter

max_item_count

Erforderlich

Maximale Anzahl von Berechtigungen, die im Enumerationsvorgang zurückgegeben werden sollen.

response_hook

Callable

Ein aufrufbarer Aufruf, der mit den Antwortmetadaten aufgerufen wird.

Gibt zurück

Eine Iterable von Berechtigungen (Diktate).

Rückgabetyp

Iterable[dict[str, Any]]

Ausnahmen

CosmosHttpResponseError

Wenn die angegebene Berechtigung nicht erstellt werden konnte.

query_permissions

Gibt alle Berechtigungen zurück, die der angegebenen Abfrage entsprechen.

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

Parameter

query

Erforderlich

Die auszuführende Azure Cosmos DB-SQL-Abfrage.

parameters

Erforderlich

Optionales Array von Parametern für die Abfrage. Wird ignoriert, wenn keine Abfrage bereitgestellt wird.

max_item_count

Erforderlich

Maximale Anzahl von Berechtigungen, die im Enumerationsvorgang zurückgegeben werden sollen.

response_hook

Callable

Ein aufrufbarer Aufruf, der mit den Antwortmetadaten aufgerufen wird.

Gibt zurück

Eine Iterable von Berechtigungen (Diktate).

Rückgabetyp

Iterable[dict[str, Any]]

Ausnahmen

CosmosHttpResponseError

Wenn die angegebene Berechtigung nicht erstellt werden konnte.

read

Benutzereigenschaften lesen.

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

Parameter

response_hook

Callable

Ein aufrufbarer Aufruf, der mit den Antwortmetadaten aufgerufen wird.

Gibt zurück

Ein Wörterbuch der abgerufenen Benutzereigenschaften.

Rückgabetyp

dict[str, Any]

Ausnahmen

CosmosHttpResponseError

Wenn der angegebene Benutzer nicht abgerufen werden konnte.

replace_permission

Ersetzt die angegebene Berechtigung, wenn sie für den Benutzer vorhanden ist.

Wenn die Berechtigung noch nicht vorhanden ist, wird eine Ausnahme ausgelöst.

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

Parameter

permission

Erforderlich

Die ID (Name), ein Diktat, das die Eigenschaften oder Permission Instanzen der zu ersetzenden Berechtigung darstellt.

body

Erforderlich

Ein dict-ähnliches Objekt, das die zu ersetzende Berechtigung darstellt.

response_hook

Callable

Ein aufrufbarer Aufruf, der mit den Antwortmetadaten aufgerufen wird.

Gibt zurück

Ein Diktat, das die Berechtigung nach dem Ersetzen darstellt, wurde durchlaufen.

Rückgabetyp

dict[str, Any]

Ausnahmen

CosmosHttpResponseError

Wenn beim Ersetzen ein Fehler aufgetreten ist oder die Berechtigung mit der angegebenen ID nicht vorhanden ist.

upsert_permission

Fügen Sie die angegebene Berechtigung ein, oder aktualisieren Sie sie.

Wenn die Berechtigung bereits im Container vorhanden ist, wird sie ersetzt. Wenn die Berechtigung nicht vorhanden ist, wird sie eingefügt.

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

Parameter

body

Erforderlich

Ein dict-ähnliches Objekt, das die Berechtigung zum Aktualisieren oder Einfügen darstellt.

response_hook

Callable

Erforderlich

Ein aufrufbarer Aufruf, der mit den Antwortmetadaten aufgerufen wird.

Gibt zurück

Ein Dict, das die upsertierte Berechtigung darstellt.

Rückgabetyp

dict[str, Any]

Ausnahmen

CosmosHttpResponseError

Wenn die angegebene Berechtigung nicht aktiviert werden konnte.