UserProxy Classe
Uma interface para interagir com um utilizador específico.
Esta aula não deve ser instantânea diretamente. Em vez disso, use o 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 permissão existente, utilize o upsert_permission método. |
delete_permission |
Elimine a permissão especificada do utilizador. Se a permissão já não existir, é levantada uma exceção. |
get_permission |
Obter a permissão identificada por identificação. |
list_permissions |
Enuda todas as permissões para o utilizador. |
query_permissions |
Devolva todas as permissões correspondentes à consulta dada. |
read |
Leia as propriedades do utilizador. |
replace_permission |
Substitui a permissão especificada se existir para o utilizador. Se a permissão já não existir, é levantada uma exceção. |
upsert_permission |
Insira ou atualize a permissão especificada. Se a autorização já existir no recipiente, é substituída. Se a permissão não existir, é inserida. |
create_permission
Crie uma permissão para o utilizador.
Para atualizar ou substituir uma permissão existente, utilize o upsert_permission método.
async create_permission(body: Dict[str, Any], **kwargs: Any) -> Permission
Parâmetros
Um objeto semelhante a um dict que representa a permissão para criar.
Uma chamada invocada com os metadados de resposta.
Devoluções
Um objeto de permissão que representa a nova permissão.
Tipo de retorno
Exceções
Se a permissão dada não pudesse ser criada.
delete_permission
Elimine a permissão especificada do utilizador.
Se a permissão já não existir, é levantada uma exceção.
async delete_permission(permission: str | Dict[str, Any] | Permission, **kwargs: Any) -> None
Parâmetros
O ID (nome), dict que representa as propriedades ou <xref:azure.cosmos.aio.Permission> instância da permissão a ser eliminada.
Uma chamada invocada com os metadados de resposta.
Tipo de retorno
Exceções
A permissão não foi apagada com sucesso.
A permissão não existe para o utilizador.
get_permission
Obter a permissão identificada por identificação.
async get_permission(permission: str | Dict[str, Any] | Permission, **kwargs: Any) -> Permission
Parâmetros
O ID (nome), dict que representa as propriedades ou <xref:azure.cosmos.aio.Permission> instância da permissão a ser recuperada.
Uma chamada invocada com os metadados de resposta.
Devoluções
O objeto de permissão recuperado.
Tipo de retorno
Exceções
Se a permissão dada não pudesse ser recuperada.
list_permissions
Enuda todas as permissões para o utilizador.
list_permissions(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
Parâmetros
- max_item_count
- int
Número máximo de permissões a serem devolvidas na operação de enumeração.
Uma chamada invocada com os metadados de resposta.
Devoluções
Um AsyncItemPaged de permissões (dicts).
Tipo de retorno
Exceções
Se a permissão dada não pudesse ser criada.
query_permissions
Devolva todas as permissões correspondentes à consulta dada.
query_permissions(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
Parâmetros
Matriz opcional de parâmetros para a consulta. Ignorado se não for fornecida qualquer consulta.
- max_item_count
- int
Número máximo de permissões a serem devolvidas na operação de enumeração.
Uma chamada invocada com os metadados de resposta.
Devoluções
Um AsyncItemPaged de permissões (dicts).
Tipo de retorno
Exceções
Se a permissão dada não pudesse ser criada.
read
Leia as propriedades do utilizador.
async read(**kwargs: Any) -> Dict[str, Any]
Parâmetros
Uma chamada invocada com os metadados de resposta.
Devoluções
Um dicionário das propriedades do utilizador recuperadas.
Tipo de retorno
Exceções
Se o utilizador não puder ser recuperado.
replace_permission
Substitui a permissão especificada se existir para o utilizador.
Se a permissão já não existir, é levantada uma exceção.
async replace_permission(permission: str | Dict[str, Any] | Permission, body: Dict[str, Any], **kwargs: Any) -> Permission
Parâmetros
O ID (nome), dict que representa as propriedades ou <xref:azure.cosmos.aio.Permission> instância da permissão a substituir.
Um objeto semelhante a um dict que representa a permissão para substituir.
Uma chamada invocada com os metadados de resposta.
Devoluções
Um objeto de permissão que representa a permissão após a substituição.
Tipo de retorno
Exceções
Se a substituição falhar ou a permissão com identificação dada não existir.
upsert_permission
Insira ou atualize a permissão especificada.
Se a autorização já existir no recipiente, é substituída. Se a permissão não existir, é inserida.
async upsert_permission(body: Dict[str, Any], **kwargs: Any) -> Permission
Parâmetros
Um objeto semelhante a um dict que representa a permissão para atualizar ou inserir.
Uma chamada invocada com os metadados de resposta.
Devoluções
Um dict que representa a permissão.
Tipo de retorno
Exceções
Se a permissão dada não pudesse ser aumentada.
Azure SDK for Python