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

مطلوب

استعلام 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 مثيل الإذن المراد استبداله.

body

مطلوب

كائن يشبه الإملاء يمثل الإذن لاستبداله.

response_hook

Callable

استدعاء مع بيانات تعريف الاستجابة.

المرتجعات

تم إدخال إملاء يمثل الإذن بعد استبداله.

نوع الإرجاع

dict[str, Any]

استثناءات

CosmosHttpResponseError

إذا فشل استبدال أو لم يكن الإذن بمعرف معين موجودا.

upsert_permission

إدراج الإذن المحدد أو تحديثه.

إذا كان الإذن موجودا بالفعل في الحاوية، يتم استبداله. إذا لم يكن الإذن موجودا، يتم إدراجه.

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

المعلمات

body

مطلوب

كائن يشبه الإملاء يمثل الإذن للتحديث أو الإدراج.

response_hook

Callable

مطلوب

استدعاء مع بيانات تعريف الاستجابة.

المرتجعات

إملاء يمثل الإذن الذي تمت إعادة إدراجه.

نوع الإرجاع

dict[str, Any]

استثناءات

CosmosHttpResponseError

إذا تعذر رفع الإذن المحدد.