UserProxy Classe
Uma interface para interagir com um utilizador específico.
Esta classe não deve ser instanciada diretamente. Em vez disso, utilize o <xref:DatabaseProxy.get_user_client> método .
- Herança
-
builtins.objectUserProxy
Construtor
UserProxy(client_connection: CosmosClientConnection, id: str, database_link: str, properties: Dict[str, Any] = None)
Parâmetros
- client_connection
- id
- database_link
- properties
Métodos
create_permission |
Crie uma permissão para o utilizador. Para atualizar ou substituir uma permisão existente, utilize o upsert_permission método . |
delete_permission |
Elimine a permissão especificada do utilizador. Se a permissão ainda não existir, é gerada uma exceção. |
get_permission |
Obtenha a permissão identificada pelo ID. |
list_permissions |
Liste todas as permissões para o utilizador. |
query_permissions |
Devolver todas as permissões correspondentes à consulta especificada. |
read |
Leia as propriedades do utilizador. |
replace_permission |
Substitui a permissão especificada se existir para o utilizador. Se a permissão ainda não existir, é gerada uma exceção. |
upsert_permission |
Insira ou atualize a permissão especificada. Se a permissão já existir no contentor, será substituída. Se a permissão não existir, é inserida. |
create_permission
Crie uma permissão para o utilizador.
Para atualizar ou substituir uma permisão existente, utilize o upsert_permission método .
create_permission(body: Dict[str, Any], **kwargs: Any) -> Permission
Parâmetros
- body
Um objeto semelhante a um ditado que representa a permissão de criação.
- response_hook
- Callable
Um callable invocado com os metadados de resposta.
Devoluções
Um ditado que representa a nova permissão.
Tipo de retorno
Exceções
Se não for possível criar a permissão dada.
delete_permission
Elimine a permissão especificada do utilizador.
Se a permissão ainda não existir, é gerada uma exceção.
delete_permission(permission: str, **kwargs: Any) -> None
Parâmetros
- permission
O ID (nome), o ditado que representa as propriedades ou <xref:azure.cosmos.user.Permission> instâncias da permissão a substituir.
- response_hook
- Callable
Um callable invocado com os metadados de resposta.
Tipo de retorno
Exceções
A permissão não foi eliminada com êxito.
A permissão não existe para o utilizador.
get_permission
Obtenha a permissão identificada pelo ID.
get_permission(permission: str, **kwargs: Any) -> Permission
Parâmetros
- permission
O ID (nome), o ditado que representa as propriedades ou <xref:azure.cosmos.user.Permission> instâncias da permissão a obter.
- response_hook
- Callable
Um callable invocado com os metadados de resposta.
Devoluções
Um ditado que representa a permissão obtida.
Tipo de retorno
Exceções
Se não for possível obter a permissão dada.
list_permissions
Liste todas as permissões para o utilizador.
list_permissions(max_item_count: int | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]
Parâmetros
- max_item_count
Número máximo de permissões a devolver na operação de enumeração.
- response_hook
- Callable
Um callable invocado com os metadados de resposta.
Devoluções
Uma Iterável de permissões (dicts).
Tipo de retorno
Exceções
Se não for possível criar a permissão dada.
query_permissions
Devolver todas as permissões correspondentes à 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
A consulta SQL do Azure Cosmos DB a executar.
- parameters
Matriz opcional de parâmetros para a consulta. Ignorado se não for fornecida nenhuma consulta.
- max_item_count
Número máximo de permissões a devolver na operação de enumeração.
- response_hook
- Callable
Um callable invocado com os metadados de resposta.
Devoluções
Uma Iterável de permissões (dicts).
Tipo de retorno
Exceções
Se não for possível criar a permissão dada.
read
Leia as propriedades do utilizador.
read(**kwargs: Any) -> Dict[str, Any]
Parâmetros
- response_hook
- Callable
Um callable invocado com os metadados de resposta.
Devoluções
Um dicionário das propriedades de utilizador obtidas.
Tipo de retorno
Exceções
Se não foi possível obter o utilizador especificado.
replace_permission
Substitui a permissão especificada se existir para o utilizador.
Se a permissão ainda não existir, é gerada uma exceção.
replace_permission(permission: str, body: Dict[str, Any], **kwargs: Any) -> Permission
Parâmetros
- permission
O ID (nome), o ditado que representa as propriedades ou <xref:azure.cosmos.user.Permission> instâncias da permissão a substituir.
- body
Um objeto semelhante a um ditado que representa a permissão para substituir.
- response_hook
- Callable
Um callable invocado com os metadados de resposta.
Devoluções
Um ditado que representa a permissão após a substituição.
Tipo de retorno
Exceções
Se a substituição tiver falhado ou a permissão com o ID especificado não existir.
upsert_permission
Insira ou atualize a permissão especificada.
Se a permissão já existir no contentor, será substituída. Se a permissão não existir, é inserida.
upsert_permission(body: Dict[str, Any], **kwargs: Any) -> Permission
Parâmetros
- body
Um objeto semelhante a um ditado que representa a permissão para atualizar ou inserir.
Devoluções
Um ditado que representa a permissão upserted.
Tipo de retorno
Exceções
Se não for possível atualizar a permissão dada.
Azure SDK for Python