UserProxy Kelas

Antarmuka untuk berinteraksi dengan pengguna tertentu.

Kelas ini tidak boleh diinstansiasi secara langsung. Sebagai gantinya get_user_client , gunakan metode .

Warisan

builtins.object

UserProxy

Konstruktor

UserProxy(client_connection: CosmosClientConnection, id: str, database_link: str, properties: Dict[str, Any] = None)

Parameter

client_connection

id

database_link

properties

nilai default: None

Metode

create_permission	Buat izin untuk pengguna. Untuk memperbarui atau mengganti izin yang ada, gunakan metode .upsert_permission
delete_permission	Hapus izin yang ditentukan dari pengguna. Jika izin belum ada, pengecualian akan dinaikkan.
get_permission	Dapatkan izin yang diidentifikasi dengan id.
list_permissions	Mencantumkan semua izin untuk pengguna.
query_permissions	Mengembalikan semua izin yang cocok dengan kueri yang diberikan.
read	Membaca properti pengguna.
replace_permission	Menggantikan izin yang ditentukan jika ada untuk pengguna. Jika izin belum ada, pengecualian akan dinaikkan.
upsert_permission	Sisipkan atau perbarui izin yang ditentukan. Jika izin sudah ada dalam kontainer, maka akan diganti. Jika izin tidak ada, izin akan disisipkan.

create_permission

Buat izin untuk pengguna.

Untuk memperbarui atau mengganti izin yang ada, gunakan metode .upsert_permission

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

Parameter

body

Diperlukan

Objek seperti dict yang mewakili izin untuk membuat.

response_hook

Callable

Panggilan yang dipanggil dengan metadata respons.

Mengembalikan

Dict yang mewakili izin baru.

Tipe hasil

dict[str, Any]

Pengecualian

CosmosHttpResponseError

Jika izin yang diberikan tidak dapat dibuat.

delete_permission

Hapus izin yang ditentukan dari pengguna.

Jika izin belum ada, pengecualian akan dinaikkan.

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

Parameter

permission

Diperlukan

ID (nama), dict yang mewakili properti atau Permission instans izin yang akan diganti.

response_hook

Callable

Panggilan yang dipanggil dengan metadata respons.

Tipe hasil

None

Pengecualian

CosmosHttpResponseError

Izin tidak berhasil dihapus.

CosmosResourceNotFoundError

Izin tidak ada untuk pengguna.

get_permission

Dapatkan izin yang diidentifikasi dengan id.

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

Parameter

permission

Diperlukan

ID (nama), dict yang mewakili properti atau Permission instans izin yang akan diambil.

response_hook

Callable

Panggilan yang dipanggil dengan metadata respons.

Mengembalikan

Dict yang mewakili izin yang diambil.

Tipe hasil

dict[str, Any]

Pengecualian

CosmosHttpResponseError

Jika izin yang diberikan tidak dapat diambil.

list_permissions

Mencantumkan semua izin untuk pengguna.

list_permissions(max_item_count: int | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

Parameter

max_item_count

Diperlukan

Jumlah maksimum izin yang akan dikembalikan dalam operasi enumerasi.

response_hook

Callable

Panggilan yang dipanggil dengan metadata respons.

Mengembalikan

Iterable izin (dicts).

Tipe hasil

Iterable[dict[str, Any]]

Pengecualian

CosmosHttpResponseError

Jika izin yang diberikan tidak dapat dibuat.

query_permissions

Mengembalikan semua izin yang cocok dengan kueri yang diberikan.

query_permissions(query: str, parameters: List[str] | None = None, max_item_count: int | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

Parameter

query

Diperlukan

Kueri Azure Cosmos DB SQL untuk dijalankan.

parameters

Diperlukan

Array parameter opsional ke kueri. Diabaikan jika tidak ada kueri yang disediakan.

max_item_count

Diperlukan

Jumlah maksimum izin yang akan dikembalikan dalam operasi enumerasi.

response_hook

Callable

Panggilan yang dipanggil dengan metadata respons.

Mengembalikan

Iterable izin (dicts).

Tipe hasil

Iterable[dict[str, Any]]

Pengecualian

CosmosHttpResponseError

Jika izin yang diberikan tidak dapat dibuat.

read

Membaca properti pengguna.

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

Parameter

response_hook

Callable

Panggilan yang dipanggil dengan metadata respons.

Mengembalikan

Kamus properti pengguna yang diambil.

Tipe hasil

dict[str, Any]

Pengecualian

CosmosHttpResponseError

Jika pengguna yang diberikan tidak dapat diambil.

replace_permission

Menggantikan izin yang ditentukan jika ada untuk pengguna.

Jika izin belum ada, pengecualian akan dinaikkan.

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

Parameter

permission

Diperlukan

ID (nama), dict yang mewakili properti atau Permission instans izin yang akan diganti.

body

Diperlukan

Objek seperti dict yang mewakili izin untuk mengganti.

response_hook

Callable

Panggilan yang dipanggil dengan metadata respons.

Mengembalikan

Dict yang mewakili izin setelah penggantian dilalui.

Tipe hasil

dict[str, Any]

Pengecualian

CosmosHttpResponseError

Jika penggantian gagal atau izin dengan id yang diberikan tidak ada.

upsert_permission

Sisipkan atau perbarui izin yang ditentukan.

Jika izin sudah ada dalam kontainer, maka akan diganti. Jika izin tidak ada, izin akan disisipkan.

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

Parameter

body

Diperlukan

Objek seperti dict yang mewakili izin untuk memperbarui atau menyisipkan.

response_hook

Callable

Diperlukan

Panggilan yang dipanggil dengan metadata respons.

Mengembalikan

Dict yang mewakili izin upserted.

Tipe hasil

dict[str, Any]

Pengecualian

CosmosHttpResponseError

Jika izin yang diberikan tidak dapat di-upsert.