次の方法で共有

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。

の戻り値の型 :

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
必須

応答メタデータを使用して呼び出される呼び出し可能。

戻り値

アップサートされたアクセス許可を表す dict。

の戻り値の型 :

dict[str, Any]

例外

CosmosHttpResponseError

指定されたアクセス許可をアップサートできなかった場合。