UserProxy Класс

Интерфейс для взаимодействия с конкретным пользователем.

Экземпляр этого класса не следует создавать напрямую. Вместо этого используйте get_user_client метод .

Наследование

builtins.object

UserProxy

Конструктор

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

Параметры

client_connection

id

database_link

properties

значение по умолчанию: None

Методы

create_permission	Создайте разрешение для пользователя. Чтобы обновить или заменить существующее исключение, используйте upsert_permission метод .
delete_permission	Удалите указанное разрешение у пользователя. Если разрешение еще не существует, возникает исключение.
get_permission	Получите разрешение, определенное по идентификатору.
list_permissions	Вывод списка всех разрешений для пользователя.
query_permissions	Возвращает все разрешения, соответствующие заданному запросу.
read	Чтение свойств пользователя.
replace_permission	Заменяет указанное разрешение, если оно существует для пользователя. Если разрешение еще не существует, возникает исключение.
upsert_permission	Вставьте или обновите указанное разрешение. Если разрешение уже существует в контейнере, оно заменяется. Если разрешение не существует, оно вставляется.

create_permission

Создайте разрешение для пользователя.

Чтобы обновить или заменить существующее исключение, используйте upsert_permission метод .

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

Параметры

body

Обязательно

Объект, похожий на диктовку, представляющий разрешение на создание.

response_hook

Callable

Вызываемый объект , вызываемый с метаданными ответа.

Возвращаемое значение

Дикт, представляющий новое разрешение.

Возвращаемый тип

dict[str, Any]

Исключения

CosmosHttpResponseError

Если не удалось создать заданное разрешение.

delete_permission

Удалите указанное разрешение у пользователя.

Если разрешение еще не существует, возникает исключение.

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

Параметры

permission

Обязательно

Идентификатор (имя), дикт, представляющий свойства или Permission экземпляр разрешения для замены.

response_hook

Callable

Вызываемый объект , вызываемый с метаданными ответа.

Возвращаемый тип

None

Исключения

CosmosHttpResponseError

Разрешение не было успешно удалено.

CosmosResourceNotFoundError

Разрешение не существует для пользователя.

get_permission

Получите разрешение, определенное по идентификатору.

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

Параметры

permission

Обязательно

Идентификатор (имя), представляющий свойства или Permission экземпляр извлекаемого разрешения.

response_hook

Callable

Вызываемый объект , вызываемый с метаданными ответа.

Возвращаемое значение

Дикт, представляющий полученное разрешение.

Возвращаемый тип

dict[str, Any]

Исключения

CosmosHttpResponseError

Если не удалось получить заданное разрешение.

list_permissions

Вывод списка всех разрешений для пользователя.

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

Параметры

max_item_count

Обязательно

Максимальное число разрешений, возвращаемых в операции перечисления.

response_hook

Callable

Вызываемый объект , вызываемый с метаданными ответа.

Возвращаемое значение

Итератор разрешений (диктов).

Возвращаемый тип

Iterable[dict[str, Any]]

Исключения

CosmosHttpResponseError

Если не удалось создать заданное разрешение.

query_permissions

Возвращает все разрешения, соответствующие заданному запросу.

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

Параметры

query

Обязательно

Выполняемый SQL-запрос Azure Cosmos DB.

parameters

Обязательно

Необязательный массив параметров для запроса. Игнорируется, если запрос не предоставлен.

max_item_count

Обязательно

Максимальное число разрешений, возвращаемых в операции перечисления.

response_hook

Callable

Вызываемый объект , вызываемый с метаданными ответа.

Возвращаемое значение

Итератор разрешений (диктов).

Возвращаемый тип

Iterable[dict[str, Any]]

Исключения

CosmosHttpResponseError

Если не удалось создать заданное разрешение.

read

Чтение свойств пользователя.

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

Параметры

response_hook

Callable

Вызываемый объект , вызываемый с метаданными ответа.

Возвращаемое значение

Словарь извлеченных свойств пользователя.

Возвращаемый тип

dict[str, Any]

Исключения

CosmosHttpResponseError

Если не удалось получить заданного пользователя.

replace_permission

Заменяет указанное разрешение, если оно существует для пользователя.

Если разрешение еще не существует, возникает исключение.

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

Параметры

permission

Обязательно

Идентификатор (имя), дикт, представляющий свойства или Permission экземпляр разрешения для замены.

body

Обязательно

Объект, похожий на диктовку, представляющий разрешение на замену.

response_hook

Callable

Вызываемый объект , вызываемый с метаданными ответа.

Возвращаемое значение

Дикт, представляющий разрешение после выполнения замены.

Возвращаемый тип

dict[str, Any]

Исключения

CosmosHttpResponseError

Если замена завершилась сбоем или разрешение с заданным идентификатором не существует.

upsert_permission

Вставьте или обновите указанное разрешение.

Если разрешение уже существует в контейнере, оно заменяется. Если разрешение не существует, оно вставляется.

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

Параметры

body

Обязательно

Объект, похожий на диктовку, представляющий разрешение на обновление или вставку.

response_hook

Callable

Обязательно

Вызываемый объект , вызываемый с метаданными ответа.

Возвращаемое значение

Дикт, представляющий upserted разрешение.

Возвращаемый тип

dict[str, Any]

Исключения

CosmosHttpResponseError

Значение , если данное разрешение не может быть upserted.