Partilhar via

UserProxy Classe

  • Referência

Uma interface para interagir com um utilizador específico.

Esta classe não deve ser instanciada diretamente. Em vez disso, utilize o get_user_client método .

Herança
builtins.object
UserProxy

Construtor

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

Parâmetros

client_connection
id
database_link
properties
valor predefinido: None

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
Necessário

Um objeto tipo dict que representa a permissão para criar.

response_hook
Callable

Um callable invocado com os metadados de resposta.

Devoluções

Um ditado que representa a nova permissão.

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se não foi possível criar a permissão especificada.

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
Necessário

O ID (nome), o ditado que representa as propriedades ou Permission a instância da permissão a substituir.

response_hook
Callable

Um callable invocado com os metadados de resposta.

Tipo de retorno

None

Exceções

CosmosHttpResponseError

A permissão não foi eliminada com êxito.

CosmosResourceNotFoundError

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
Necessário

O ID (nome), o ditado que representa as propriedades ou Permission a instância 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

dict[str, Any]

Exceções

CosmosHttpResponseError

Se não foi possível obter a permissão especificada.

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
Necessário

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

Iterable[dict[str, Any]]

Exceções

CosmosHttpResponseError

Se não foi possível criar a permissão especificada.

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
Necessário

A consulta SQL do Azure Cosmos DB a executar.

parameters
Necessário

Matriz opcional de parâmetros para a consulta. Ignorado se não for fornecida nenhuma consulta.

max_item_count
Necessário

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

Iterable[dict[str, Any]]

Exceções

CosmosHttpResponseError

Se não foi possível criar a permissão especificada.

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 do utilizador obtidas.

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

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
Necessário

O ID (nome), o ditado que representa as propriedades ou Permission a instância da permissão a substituir.

body
Necessário

Um objeto tipo dict 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

dict[str, Any]

Exceções

CosmosHttpResponseError

Se a substituição tiver falhado ou a permissão por um determinado ID 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
Necessário

Um objeto tipo dict que representa a permissão para atualizar ou inserir.

response_hook
Callable
Necessário

Um callable invocado com os metadados de resposta.

Devoluções

Um ditado que representa a permissão de upserted.

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se não for possível inserir a permissão especificada.