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 。

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

パラメーター

body
Dict[str, Any]
必須

作成するアクセス許可を表す dict に似たオブジェクト。

response_hook
Callable[[Dict[str, str], Dict[str, Any]], None]

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

戻り値

新しいアクセス許可を表すアクセス許可オブジェクト。

の戻り値の型 :

Permission

例外

CosmosHttpResponseError

指定されたアクセス許可を作成できなかった場合。

delete_permission

指定したアクセス許可をユーザーから削除します。

アクセス許可がまだ存在しない場合は、例外が発生します。

async delete_permission(permission: str | Dict[str, Any] | Permission, **kwargs: Any) -> None

パラメーター

permission
Union[str, Dict[str, Any], Permission]
必須

削除するアクセス許可のプロパティまたは <xref:azure.cosmos.aio.Permission> インスタンスを表す ID (名前)。

response_hook
Callable[[Dict[str, str], None], None]

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

の戻り値の型 :

None

例外

CosmosHttpResponseError

アクセス許可が正常に削除されませんでした。

CosmosResourceNotFoundError

ユーザーのアクセス許可が存在しません。

get_permission

ID で識別されるアクセス許可を取得します。

async get_permission(permission: str | Dict[str, Any] | Permission, **kwargs: Any) -> Permission

パラメーター

permission
Union[str, Dict[str, Any], Permission]
必須

取得するアクセス許可のプロパティまたは <xref:azure.cosmos.aio.Permission> インスタンスを表す ID (名前)。

response_hook
Callable[[Dict[str, str], Dict[str, Any]], None]

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

戻り値

取得したアクセス許可オブジェクト。

の戻り値の型 :

Permission

例外

CosmosHttpResponseError

指定されたアクセス許可を取得できなかった場合。

list_permissions

ユーザーのすべてのアクセス許可を一覧表示します。

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

パラメーター

max_item_count
int

列挙操作で返されるアクセス許可の最大数。

response_hook
Callable[[Dict[str, str], <xref:AsyncItemPaged>[Dict[str, Any]], None]

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

戻り値

アクセス許可の AsyncItemPaged (dicts)。

の戻り値の型 :

<xref:AsyncItemPaged>[Dict[str, Any]]

例外

CosmosHttpResponseError

指定されたアクセス許可を作成できなかった場合。

query_permissions

指定されたクエリに一致するすべてのアクセス許可を返 します。

query_permissions(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

パラメーター

query
Union[str, Dict[str, Any]]
必須

実行する Azure Cosmos DB SQL クエリ。

parameters
Optional[List[Dict[str, Any]]]

クエリに対するパラメーターの省略可能な配列。 クエリが指定されていない場合は無視されます。

max_item_count
int

列挙操作で返されるアクセス許可の最大数。

response_hook
Callable[[Dict[str, str], <xref:AsyncItemPaged>[Dict[str, Any]]], None]

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

戻り値

アクセス許可の AsyncItemPaged (dicts)。

の戻り値の型 :

<xref:AsyncItemPaged>[Dict[str, Any]]

例外

CosmosHttpResponseError

指定されたアクセス許可を作成できなかった場合。

read

ユーザー プロパティを読み取る。

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

パラメーター

response_hook
Callable[[Dict[str, str], Dict[str, Any]], None]

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

戻り値

取得したユーザー プロパティのディクショナリ。

の戻り値の型 :

Dict[str, Any]

例外

CosmosHttpResponseError

指定されたユーザーを取得できなかった場合。

replace_permission

指定したアクセス許可がユーザーに対して存在する場合は置き換えます。

アクセス許可がまだ存在しない場合は、例外が発生します。

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

パラメーター

permission
Union[str, Dict[str, Any], Permission]
必須

置き換えられるアクセス許可のプロパティまたは <xref:azure.cosmos.aio.Permission> インスタンスを表す ID (名前)。

body
Dict[str, Any]
必須

置換するアクセス許可を表す dict に似たオブジェクト。

response_hook
Callable[[Dict[str, str], Dict[str, Any]], None]

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

戻り値

置換が完了した後のアクセス許可を表すアクセス許可オブジェクト。

の戻り値の型 :

Permission

例外

CosmosHttpResponseError

置換に失敗した場合、または指定された ID を持つアクセス許可が存在しない場合。

upsert_permission

指定したアクセス許可を挿入または更新します。

コンテナーにアクセス許可が既に存在する場合は、置き換えられます。 アクセス許可が存在しない場合は、挿入されます。

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

パラメーター

body
Dict[str, Any]
必須

更新または挿入するアクセス許可を表す dict に似たオブジェクト。

response_hook
Callable[[Dict[str, str], Dict[str, Any]], None]

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

戻り値

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

の戻り値の型 :

Permission

例外

CosmosHttpResponseError

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