UserProxy 類別
與特定使用者互動的介面。
此類別不應直接具現化。 請改用 <xref:DatabaseProxy.get_user_client> 方法。
- 繼承
-
builtins.objectUserProxy
建構函式
UserProxy(client_connection: CosmosClientConnection, id: str, database_link: str, properties: Dict[str, Any] = None)參數
- client_connection
- id
- database_link
- properties
方法
| 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
使用回應中繼資料叫用的可呼叫專案。
傳回
表示新許可權的聽寫。
傳回類型
例外狀況
如果無法建立指定的許可權。
delete_permission
從使用者刪除指定的許可權。
如果許可權不存在，則會引發例外狀況。
delete_permission(permission: str, **kwargs: Any) -> None參數
- permission
識別碼 (名稱) ，表示要取代之許可權的屬性或 <xref:azure.cosmos.user.Permission> 實例的聽寫。
- response_hook
- Callable
使用回應中繼資料叫用的可呼叫專案。
傳回類型
例外狀況
許可權未成功刪除。
使用者的許可權不存在。
get_permission
取得以 識別碼識別的許可權。
get_permission(permission: str, **kwargs: Any) -> Permission參數
- permission
識別碼 (名稱) ，表示要擷取之許可權的屬性或 <xref:azure.cosmos.user.Permission> 實例。
- response_hook
- Callable
使用回應中繼資料叫用的可呼叫專案。
傳回
表示擷取許可權的聽寫。
傳回類型
例外狀況
如果無法擷取指定的許可權。
list_permissions
列出使用者的擁有權限。
list_permissions(max_item_count: int | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]參數
- max_item_count
列舉作業中要傳回的許可權數目上限。
- response_hook
- Callable
使用回應中繼資料叫用的可呼叫專案。
傳回
可重複 (聽寫的許可權) 。
傳回類型
例外狀況
如果無法建立指定的許可權。
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
使用回應中繼資料叫用的可呼叫專案。
傳回
可重複 (聽寫的許可權) 。
傳回類型
例外狀況
如果無法建立指定的許可權。
read
讀取使用者屬性。
read(**kwargs: Any) -> Dict[str, Any]參數
- response_hook
- Callable
使用回應中繼資料叫用的可呼叫專案。
傳回
擷取之使用者屬性的字典。
傳回類型
例外狀況
如果無法擷取指定的使用者。
replace_permission
如果使用者存在指定的許可權，則會取代指定的許可權。
如果許可權不存在，則會引發例外狀況。
replace_permission(permission: str, body: Dict[str, Any], **kwargs: Any) -> Permission參數
- permission
識別碼 (名稱) ，表示要取代之許可權的屬性或 <xref:azure.cosmos.user.Permission> 實例的聽寫。
- body
類似聽寫的物件，表示要取代的許可權。
- response_hook
- Callable
使用回應中繼資料叫用的可呼叫專案。
傳回
表示取代之後許可權的聽寫。
傳回類型
例外狀況
如果取代失敗，或具有指定識別碼的許可權不存在。
upsert_permission
插入或更新指定的許可權。
如果許可權已存在於容器中，則會加以取代。 如果許可權不存在，則會插入該許可權。
upsert_permission(body: Dict[str, Any], **kwargs: Any) -> Permission參數
- body
類似聽寫的物件，表示更新或插入的許可權。
傳回
表示 upserted 許可權的聽寫。
傳回類型
例外狀況
如果無法向上插入指定的許可權，則為 。
