UserProxy Clase

Interfaz para interactuar con un usuario específico.

Esta clase no se debe crear una instancia directamente. En su lugar, use el get_user_client método .

Herencia

builtins.object

UserProxy

Constructor

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

Parámetros

client_connection

id

database_link

properties

valor predeterminado: None

Métodos

create_permission	Cree un permiso para el usuario. Para actualizar o reemplazar una permision existente, use el upsert_permission método .
delete_permission	Elimine el permiso especificado del usuario. Si el permiso aún no existe, se genera una excepción.
get_permission	Obtenga el permiso identificado por id.
list_permissions	Enumere todos los permisos para el usuario.
query_permissions	Devuelve todos los permisos que coinciden con la consulta especificada.
read	Lee las propiedades del usuario.
replace_permission	Reemplaza el permiso especificado si existe para el usuario. Si el permiso aún no existe, se genera una excepción.
upsert_permission	Inserte o actualice el permiso especificado. Si el permiso ya existe en el contenedor, se reemplaza. Si el permiso no existe, se inserta.

create_permission

Cree un permiso para el usuario.

Para actualizar o reemplazar una permision existente, use el upsert_permission método .

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

Parámetros

body

Requerido

Objeto de tipo dict que representa el permiso para crear.

response_hook

Callable

Un invocable invocable con los metadatos de respuesta.

Devoluciones

Un dict que representa el nuevo permiso.

Tipo de valor devuelto

dict[str, Any]

Excepciones

CosmosHttpResponseError

Si no se pudo crear el permiso especificado.

delete_permission

Elimine el permiso especificado del usuario.

Si el permiso aún no existe, se genera una excepción.

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

Parámetros

permission

Requerido

Identificador (nombre), que representa las propiedades o Permission la instancia del permiso que se va a reemplazar.

response_hook

Callable

Un invocable invocable con los metadatos de respuesta.

Tipo de valor devuelto

None

Excepciones

CosmosHttpResponseError

El permiso no se eliminó correctamente.

CosmosResourceNotFoundError

El permiso no existe para el usuario.

get_permission

Obtenga el permiso identificado por id.

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

Parámetros

permission

Requerido

Identificador (nombre), que representa las propiedades o Permission la instancia del permiso que se va a recuperar.

response_hook

Callable

Un invocable invocable con los metadatos de respuesta.

Devoluciones

Un dict que representa el permiso recuperado.

Tipo de valor devuelto

dict[str, Any]

Excepciones

CosmosHttpResponseError

Si no se pudo recuperar el permiso especificado.

list_permissions

Enumere todos los permisos para el usuario.

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

Parámetros

max_item_count

Requerido

Número máximo de permisos que se van a devolver en la operación de enumeración.

response_hook

Callable

Un invocable invocable con los metadatos de respuesta.

Devoluciones

Iterable de permisos (dicts).

Tipo de valor devuelto

Iterable[dict[str, Any]]

Excepciones

CosmosHttpResponseError

Si no se pudo crear el permiso especificado.

query_permissions

Devuelve todos los permisos que coinciden con la consulta especificada.

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

Parámetros

query

Requerido

Consulta SQL de Azure Cosmos DB que se va a ejecutar.

parameters

Requerido

Matriz opcional de parámetros para la consulta. Se omite si no se proporciona ninguna consulta.

max_item_count

Requerido

Número máximo de permisos que se van a devolver en la operación de enumeración.

response_hook

Callable

Un invocable invocable con los metadatos de respuesta.

Devoluciones

Iterable de permisos (dicts).

Tipo de valor devuelto

Iterable[dict[str, Any]]

Excepciones

CosmosHttpResponseError

Si no se pudo crear el permiso especificado.

read

Lee las propiedades del usuario.

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

Parámetros

response_hook

Callable

Un invocable invocable con los metadatos de respuesta.

Devoluciones

Diccionario de las propiedades de usuario recuperadas.

Tipo de valor devuelto

dict[str, Any]

Excepciones

CosmosHttpResponseError

Si el usuario especificado no se pudo recuperar.

replace_permission

Reemplaza el permiso especificado si existe para el usuario.

Si el permiso aún no existe, se genera una excepción.

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

Parámetros

permission

Requerido

Identificador (nombre), que representa las propiedades o Permission la instancia del permiso que se va a reemplazar.

body

Requerido

Objeto de tipo dict que representa el permiso que se va a reemplazar.

response_hook

Callable

Un invocable invocable con los metadatos de respuesta.

Devoluciones

Un dict que representa el permiso después de pasar por el reemplazo.

Tipo de valor devuelto

dict[str, Any]

Excepciones

CosmosHttpResponseError

Si no se pudo reemplazar o no existe el permiso con el identificador especificado.

upsert_permission

Inserte o actualice el permiso especificado.

Si el permiso ya existe en el contenedor, se reemplaza. Si el permiso no existe, se inserta.

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

Parámetros

body

Requerido

Objeto de tipo dict que representa el permiso para actualizar o insertar.

response_hook

Callable

Requerido

Un invocable invocable con los metadatos de respuesta.

Devoluciones

Objeto dict que representa el permiso upserted.

Tipo de valor devuelto

dict[str, Any]

Excepciones

CosmosHttpResponseError

Si no se pudo subir el permiso especificado.