Partager via

UserProxy Classe

  • Référence

Interface permettant d’interagir avec un utilisateur spécifique.

Cette classe ne doit pas être instanciée directement. Utilisez plutôt la <xref:DatabaseProxy.get_user_client> méthode .

Héritage
builtins.object
UserProxy

Constructeur

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

Paramètres

client_connection
id
database_link
properties
valeur par défaut: None

Méthodes

create_permission

Créez une autorisation pour l’utilisateur.

Pour mettre à jour ou remplacer un permision existant, utilisez la upsert_permission méthode .
delete_permission

Supprimez l’autorisation spécifiée de l’utilisateur.

Si l’autorisation n’existe pas encore, une exception est levée.
get_permission

Obtenez l’autorisation identifiée par id.
list_permissions

Répertoriez toutes les autorisations pour l’utilisateur.
query_permissions

Retourne toutes les autorisations correspondant à la requête donnée.
read

Lisez les propriétés utilisateur.
replace_permission

Remplace l’autorisation spécifiée si elle existe pour l’utilisateur.

Si l’autorisation n’existe pas encore, une exception est levée.
upsert_permission

Insérez ou mettez à jour l’autorisation spécifiée.

Si l’autorisation existe déjà dans le conteneur, elle est remplacée. Si l’autorisation n’existe pas, elle est insérée.

create_permission

Créez une autorisation pour l’utilisateur.

Pour mettre à jour ou remplacer un permision existant, utilisez la upsert_permission méthode .

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

Paramètres

body
Obligatoire

Objet de type dict représentant l’autorisation à créer.

response_hook
Callable

Appelable avec les métadonnées de réponse.

Retours

dict représentant la nouvelle autorisation.

Type de retour

dict[str, Any]

Exceptions

CosmosHttpResponseError

Si l’autorisation donnée n’a pas pu être créée.

delete_permission

Supprimez l’autorisation spécifiée de l’utilisateur.

Si l’autorisation n’existe pas encore, une exception est levée.

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

Paramètres

permission
Obligatoire

ID (nom), dict représentant les propriétés ou <xref:azure.cosmos.user.Permission> l’instance de l’autorisation à remplacer.

response_hook
Callable

Appelable avec les métadonnées de réponse.

Type de retour

None

Exceptions

CosmosHttpResponseError

L’autorisation n’a pas été supprimée avec succès.

CosmosResourceNotFoundError

L’autorisation n’existe pas pour l’utilisateur.

get_permission

Obtenez l’autorisation identifiée par id.

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

Paramètres

permission
Obligatoire

ID (nom), dict représentant les propriétés ou <xref:azure.cosmos.user.Permission> l’instance de l’autorisation à récupérer.

response_hook
Callable

Appelable avec les métadonnées de réponse.

Retours

dict représentant l’autorisation récupérée.

Type de retour

dict[str, Any]

Exceptions

CosmosHttpResponseError

Si l’autorisation donnée n’a pas pu être récupérée.

list_permissions

Répertoriez toutes les autorisations pour l’utilisateur.

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

Paramètres

max_item_count
Obligatoire

Nombre maximal d’autorisations à retourner dans l’opération d’énumération.

response_hook
Callable

Appelable avec les métadonnées de réponse.

Retours

Itérable d’autorisations (dicts).

Type de retour

Iterable[dict[str, Any]]

Exceptions

CosmosHttpResponseError

Si l’autorisation donnée n’a pas pu être créée.

query_permissions

Retourne toutes les autorisations correspondant à la requête donnée.

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

Paramètres

query
Obligatoire

Requête SQL Azure Cosmos DB à exécuter.

parameters
Obligatoire

Tableau facultatif de paramètres de la requête. Ignoré si aucune requête n’est fournie.

max_item_count
Obligatoire

Nombre maximal d’autorisations à retourner dans l’opération d’énumération.

response_hook
Callable

Appelable avec les métadonnées de réponse.

Retours

Itérable d’autorisations (dicts).

Type de retour

Iterable[dict[str, Any]]

Exceptions

CosmosHttpResponseError

Si l’autorisation donnée n’a pas pu être créée.

read

Lisez les propriétés utilisateur.

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

Paramètres

response_hook
Callable

Appelable avec les métadonnées de réponse.

Retours

Dictionnaire des propriétés utilisateur récupérées.

Type de retour

dict[str, Any]

Exceptions

CosmosHttpResponseError

Si l’utilisateur donné n’a pas pu être récupéré.

replace_permission

Remplace l’autorisation spécifiée si elle existe pour l’utilisateur.

Si l’autorisation n’existe pas encore, une exception est levée.

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

Paramètres

permission
Obligatoire

ID (nom), dict représentant les propriétés ou <xref:azure.cosmos.user.Permission> l’instance de l’autorisation à remplacer.

body
Obligatoire

Objet de type dict représentant l’autorisation à remplacer.

response_hook
Callable

Appelable avec les métadonnées de réponse.

Retours

Un dict représentant l’autorisation après le remplacement est passé.

Type de retour

dict[str, Any]

Exceptions

CosmosHttpResponseError

Si le remplacement a échoué ou si l’autorisation avec l’ID donné n’existe pas.

upsert_permission

Insérez ou mettez à jour l’autorisation spécifiée.

Si l’autorisation existe déjà dans le conteneur, elle est remplacée. Si l’autorisation n’existe pas, elle est insérée.

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

Paramètres

body
Obligatoire

Objet de type dict représentant l’autorisation de mise à jour ou d’insertion.

response_hook
Callable
Obligatoire

Appelable avec les métadonnées de réponse.

Retours

dict représentant l’autorisation upserted.

Type de retour

dict[str, Any]

Exceptions

CosmosHttpResponseError

Si l’autorisation donnée n’a pas pu être upserted.