Condividi tramite


UserProxy Classe

Interfaccia per interagire con un utente specifico.

Questa classe non deve essere creata direttamente. Usare invece il get_user_client metodo .

Ereditarietà
builtins.object
UserProxy

Costruttore

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

Parametri

client_connection
id
database_link
properties
valore predefinito: None

Metodi

create_permission

Creare un'autorizzazione per l'utente.

Per aggiornare o sostituire una permisione esistente, usare il upsert_permission metodo .

delete_permission

Eliminare l'autorizzazione specificata dall'utente.

Se l'autorizzazione non esiste già, viene generata un'eccezione.

get_permission

Ottenere l'autorizzazione identificata dall'ID.

list_permissions

Elencare tutte le autorizzazioni per l'utente.

query_permissions

Restituisce tutte le autorizzazioni corrispondenti alla query specificata.

read

Leggere le proprietà dell'utente.

replace_permission

Sostituisce l'autorizzazione specificata, se presente per l'utente.

Se l'autorizzazione non esiste già, viene generata un'eccezione.

upsert_permission

Inserire o aggiornare l'autorizzazione specificata.

Se l'autorizzazione esiste già nel contenitore, viene sostituita. Se l'autorizzazione non esiste, viene inserita.

create_permission

Creare un'autorizzazione per l'utente.

Per aggiornare o sostituire una permisione esistente, usare il upsert_permission metodo .

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

Parametri

body
Necessario

Oggetto simile a dict che rappresenta l'autorizzazione da creare.

response_hook
Callable

Oggetto chiamabile richiamato con i metadati della risposta.

Restituisce

Oggetto dict che rappresenta la nuova autorizzazione.

Tipo restituito

Eccezioni

Se non è stato possibile creare l'autorizzazione specificata.

delete_permission

Eliminare l'autorizzazione specificata dall'utente.

Se l'autorizzazione non esiste già, viene generata un'eccezione.

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

Parametri

permission
Necessario

ID (nome), che rappresenta le proprietà o Permission l'istanza dell'autorizzazione da sostituire.

response_hook
Callable

Oggetto chiamabile richiamato con i metadati della risposta.

Tipo restituito

Eccezioni

L'autorizzazione non è stata eliminata correttamente.

L'autorizzazione non esiste per l'utente.

get_permission

Ottenere l'autorizzazione identificata dall'ID.

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

Parametri

permission
Necessario

ID (nome), che rappresenta le proprietà o Permission l'istanza dell'autorizzazione da recuperare.

response_hook
Callable

Oggetto chiamabile richiamato con i metadati della risposta.

Restituisce

Oggetto dict che rappresenta l'autorizzazione recuperata.

Tipo restituito

Eccezioni

Se non è stato possibile recuperare l'autorizzazione specificata.

list_permissions

Elencare tutte le autorizzazioni per l'utente.

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

Parametri

max_item_count
Necessario

Numero massimo di autorizzazioni da restituire nell'operazione di enumerazione.

response_hook
Callable

Oggetto chiamabile richiamato con i metadati della risposta.

Restituisce

Iterabile di autorizzazioni (dict).

Tipo restituito

Eccezioni

Se non è stato possibile creare l'autorizzazione specificata.

query_permissions

Restituisce tutte le autorizzazioni corrispondenti alla query specificata.

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

Parametri

query
Necessario

Query SQL di Azure Cosmos DB da eseguire.

parameters
Necessario

Matrice facoltativa di parametri per la query. Ignorato se non viene specificata alcuna query.

max_item_count
Necessario

Numero massimo di autorizzazioni da restituire nell'operazione di enumerazione.

response_hook
Callable

Oggetto chiamabile richiamato con i metadati della risposta.

Restituisce

Iterabile di autorizzazioni (dict).

Tipo restituito

Eccezioni

Se non è stato possibile creare l'autorizzazione specificata.

read

Leggere le proprietà dell'utente.

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

Parametri

response_hook
Callable

Oggetto chiamabile richiamato con i metadati della risposta.

Restituisce

Dizionario delle proprietà utente recuperate.

Tipo restituito

Eccezioni

Se non è stato possibile recuperare l'utente specificato.

replace_permission

Sostituisce l'autorizzazione specificata, se presente per l'utente.

Se l'autorizzazione non esiste già, viene generata un'eccezione.

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

Parametri

permission
Necessario

ID (nome), che rappresenta le proprietà o Permission l'istanza dell'autorizzazione da sostituire.

body
Necessario

Oggetto dict-like che rappresenta l'autorizzazione da sostituire.

response_hook
Callable

Oggetto chiamabile richiamato con i metadati della risposta.

Restituisce

Dict che rappresenta l'autorizzazione dopo che è stata sostituita.

Tipo restituito

Eccezioni

Se la sostituzione non è riuscita o l'autorizzazione con id specificato non esiste.

upsert_permission

Inserire o aggiornare l'autorizzazione specificata.

Se l'autorizzazione esiste già nel contenitore, viene sostituita. Se l'autorizzazione non esiste, viene inserita.

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

Parametri

body
Necessario

Oggetto simile a ct che rappresenta l'autorizzazione per aggiornare o inserire.

response_hook
Callable
Necessario

Oggetto chiamabile richiamato con i metadati della risposta.

Restituisce

Oggetto dict che rappresenta l'autorizzazione con upserted.

Tipo restituito

Eccezioni

Se l'autorizzazione specificata non è stata aggiornata.