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

ID로 식별된 권한을 가져옵니다.
list_permissions

사용자에 대한 모든 권한을 나열합니다.
query_permissions

지정된 쿼리와 일치하는 모든 권한을 반환 합니다.
read

사용자 속성을 읽습니다.
replace_permission

사용자에 대해 지정된 권한이 있는 경우 를 바꿉니다.

사용 권한이 아직 없으면 예외가 발생합니다.
upsert_permission

지정된 권한을 삽입하거나 업데이트합니다.

컨테이너에 사용 권한이 이미 있는 경우 해당 권한이 대체됩니다. 권한이 없으면 삽입됩니다.

create_permission

사용자에 대한 권한을 만듭니다.

기존 허용을 업데이트하거나 바꾸려면 메서드를 upsert_permission 사용합니다.

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

매개 변수

body
필수

만들 수 있는 권한을 나타내는 dict와 유사한 개체입니다.

response_hook
Callable

응답 메타데이터를 사용하여 호출된 호출 가능한 입니다.

반환

새 권한을 나타내는 받아쓰기입니다.

반환 형식

dict[str, Any]

예외

CosmosHttpResponseError

지정된 권한을 만들 수 없는 경우

delete_permission

사용자로부터 지정된 권한을 삭제합니다.

사용 권한이 아직 없으면 예외가 발생합니다.

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

매개 변수

permission
필수

바꿀 권한의 속성 또는 Permission 인스턴스를 나타내는 ID(이름), 받아쓰기입니다.

response_hook
Callable

응답 메타데이터를 사용하여 호출된 호출 가능한 입니다.

반환 형식

None

예외

CosmosHttpResponseError

권한이 성공적으로 삭제되지 않았습니다.

CosmosResourceNotFoundError

사용자에 대한 권한이 없습니다.

get_permission

ID로 식별된 권한을 가져옵니다.

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

매개 변수

permission
필수

검색할 권한의 속성 또는 Permission 인스턴스를 나타내는 ID(이름) 받아쓰기입니다.

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
필수

실행할 Azure Cosmos DB SQL 쿼리입니다.

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 인스턴스를 나타내는 ID(이름), 받아쓰기입니다.

body
필수

바꿀 권한을 나타내는 dict와 유사한 개체입니다.

response_hook
Callable

응답 메타데이터를 사용하여 호출된 호출 가능한 입니다.

반환

바꾸기를 통과한 후 사용 권한을 나타내는 받아쓰기입니다.

반환 형식

dict[str, Any]

예외

CosmosHttpResponseError

바꾸기에 실패했거나 지정된 ID를 가진 권한이 없는 경우.

upsert_permission

지정된 권한을 삽입하거나 업데이트합니다.

컨테이너에 사용 권한이 이미 있는 경우 해당 권한이 대체됩니다. 권한이 없으면 삽입됩니다.

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

매개 변수

body
필수

업데이트 또는 삽입 권한을 나타내는 dict와 유사한 개체입니다.

response_hook
Callable
필수

응답 메타데이터를 사용하여 호출된 호출 가능한 입니다.

반환

upserted 권한을 나타내는 받아쓰기입니다.

반환 형식

dict[str, Any]

예외

CosmosHttpResponseError

지정된 권한을 업서트할 수 없는 경우