UserProxy Classe

  • Referência

Uma interface para interagir com um usuário específico.

Essa classe não deve ser instanciada diretamente. Em vez disso, use 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 padrão: None

Métodos

create_permission

Crie uma permissão para o usuário.

Para atualizar ou substituir uma permisão existente, use o upsert_permission método .
delete_permission

Exclua a permissão especificada do usuário.

Se a permissão ainda não existir, uma exceção será gerada.
get_permission

Obtenha a permissão identificada pela ID.
list_permissions

Listar todas as permissões para o usuário.
query_permissions

Retornar todas as permissões correspondentes à consulta fornecida.
read

Ler as propriedades do usuário.
replace_permission

Substitui a permissão especificada se ela existir para o usuário.

Se a permissão ainda não existir, uma exceção será gerada.
upsert_permission

Insira ou atualize a permissão especificada.

Se a permissão já existir no contêiner, ela será substituída. Se a permissão não existir, ela será inserida.

create_permission

Crie uma permissão para o usuário.

Para atualizar ou substituir uma permisão existente, use o upsert_permission método .

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

Parâmetros

body
Obrigatório

Um objeto semelhante a um dict que representa a permissão a ser criada.

response_hook
Callable

Um callable invocado com os metadados de resposta.

Retornos

Um ditado que representa a nova permissão.

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se a permissão fornecida não puder ser criada.

delete_permission

Exclua a permissão especificada do usuário.

Se a permissão ainda não existir, uma exceção será gerada.

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

Parâmetros

permission
Obrigatório

A ID (nome), dict que representa as propriedades ou Permission a instância da permissão a ser substituída.

response_hook
Callable

Um callable invocado com os metadados de resposta.

Tipo de retorno

None

Exceções

CosmosHttpResponseError

A permissão não foi excluída com êxito.

CosmosResourceNotFoundError

A permissão não existe para o usuário.

get_permission

Obtenha a permissão identificada pela ID.

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

Parâmetros

permission
Obrigatório

A ID (nome), dict que representa as propriedades ou Permission a instância da permissão a ser recuperada.

response_hook
Callable

Um callable invocado com os metadados de resposta.

Retornos

Um dict que representa a permissão recuperada.

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se a permissão fornecida não puder ser recuperada.

list_permissions

Listar todas as permissões para o usuário.

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

Parâmetros

max_item_count
Obrigatório

Número máximo de permissões a serem retornadas na operação de enumeração.

response_hook
Callable

Um callable invocado com os metadados de resposta.

Retornos

Uma iterável de permissões (dicts).

Tipo de retorno

Iterable[dict[str, Any]]

Exceções

CosmosHttpResponseError

Se a permissão fornecida não puder ser criada.

query_permissions

Retornar todas as permissões correspondentes à consulta fornecida.

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

Parâmetros

query
Obrigatório

A consulta SQL do Azure Cosmos DB a ser executada.

parameters
Obrigatório

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

max_item_count
Obrigatório

Número máximo de permissões a serem retornadas na operação de enumeração.

response_hook
Callable

Um callable invocado com os metadados de resposta.

Retornos

Uma iterável de permissões (dicts).

Tipo de retorno

Iterable[dict[str, Any]]

Exceções

CosmosHttpResponseError

Se a permissão fornecida não puder ser criada.

read

Ler as propriedades do usuário.

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

Parâmetros

response_hook
Callable

Um callable invocado com os metadados de resposta.

Retornos

Um dicionário das propriedades de usuário recuperadas.

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se o usuário determinado não pôde ser recuperado.

replace_permission

Substitui a permissão especificada se ela existir para o usuário.

Se a permissão ainda não existir, uma exceção será gerada.

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

Parâmetros

permission
Obrigatório

A ID (nome), dict que representa as propriedades ou Permission a instância da permissão a ser substituída.

body
Obrigatório

Um objeto semelhante a um dict que representa a permissão a ser substituída.

response_hook
Callable

Um callable invocado com os metadados de resposta.

Retornos

Um dict que representa a permissão após a substituição.

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se a substituição falhou ou a permissão com a ID fornecida não existir.

upsert_permission

Insira ou atualize a permissão especificada.

Se a permissão já existir no contêiner, ela será substituída. Se a permissão não existir, ela será inserida.

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

Parâmetros

body
Obrigatório

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

response_hook
Callable
Obrigatório

Um callable invocado com os metadados de resposta.

Retornos

Um ditado que representa a permissão upserted.

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se a permissão fornecida não puder ser upserted.