UserProxy Sınıf

Belirli bir kullanıcıyla etkileşime geçmek için bir arabirim.

Bu sınıf doğrudan örneklenmemelidir. Bunun yerine yöntemini kullanın <xref:DatabaseProxy.get_user_client> .

Devralma

builtins.object

UserProxy

Oluşturucu

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

Parametreler

client_connection

id

database_link

properties

varsayılan değer: None

Yöntemler

create_permission	Kullanıcı için bir izin oluşturun. Mevcut bir izin güncelleştirmek veya değiştirmek için yöntemini kullanın upsert_permission .
delete_permission	Belirtilen izni kullanıcıdan silin. İzin henüz yoksa, bir özel durum oluşturulur.
get_permission	Kimlikle tanımlanan izni alın.
list_permissions	Kullanıcının tüm izinlerini listeleyin.
query_permissions	Verilen sorguyla eşleşen tüm izinleri döndürür.
read	Kullanıcı özelliklerini okuma.
replace_permission	Kullanıcı için varsa belirtilen izni değiştirir. İzin henüz yoksa, bir özel durum oluşturulur.
upsert_permission	Belirtilen izni ekleyin veya güncelleştirin. İzin kapsayıcıda zaten varsa, değiştirilir. İzin yoksa eklenir.

create_permission

Kullanıcı için bir izin oluşturun.

Mevcut bir izin güncelleştirmek veya değiştirmek için yöntemini kullanın upsert_permission .

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

Parametreler

body

Gerekli

Oluşturma iznini temsil eden dikte benzeri bir nesne.

response_hook

Callable

Yanıt meta verileriyle çağrılabilir bir çağrılabilir.

Döndürülenler

Yeni izni temsil eden bir dikte.

Dönüş türü

dict[str, Any]

Özel durumlar

CosmosHttpResponseError

Verilen izin oluşturulamadıysa.

delete_permission

Belirtilen izni kullanıcıdan silin.

İzin henüz yoksa, bir özel durum oluşturulur.

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

Parametreler

permission

Gerekli

Değiştirilecek iznin özelliklerini veya <xref:azure.cosmos.user.Permission> örneğini temsil eden kimlik (ad).

response_hook

Callable

Yanıt meta verileriyle çağrılabilir bir çağrılabilir.

Dönüş türü

None

Özel durumlar

CosmosHttpResponseError

İzin başarıyla silinemedi.

CosmosResourceNotFoundError

kullanıcı için izin yok.

get_permission

Kimlikle tanımlanan izni alın.

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

Parametreler

permission

Gerekli

Alınacak iznin özelliklerini veya <xref:azure.cosmos.user.Permission> örneğini temsil eden kimlik (ad).

response_hook

Callable

Yanıt meta verileriyle çağrılabilir bir çağrılabilir.

Döndürülenler

Alınan izni temsil eden bir dikte.

Dönüş türü

dict[str, Any]

Özel durumlar

CosmosHttpResponseError

Verilen izin alınamadıysa.

list_permissions

Kullanıcının tüm izinlerini listeleyin.

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

Parametreler

max_item_count

Gerekli

Numaralandırma işleminde döndürülecek en fazla izin sayısı.

response_hook

Callable

Yanıt meta verileriyle çağrılabilir bir çağrılabilir.

Döndürülenler

İzinlerin yinelenebilir bir örneği (dikteler).

Dönüş türü

Iterable[dict[str, Any]]

Özel durumlar

CosmosHttpResponseError

Verilen izin oluşturulamadıysa.

query_permissions

Verilen sorguyla eşleşen tüm izinleri döndürür.

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

Parametreler

query

Gerekli

Yürütülecek Azure Cosmos DB SQL sorgusu.

parameters

Gerekli

Sorguya isteğe bağlı parametre dizisi. Sorgu sağlanmazsa yoksayılır.

max_item_count

Gerekli

Numaralandırma işleminde döndürülecek en fazla izin sayısı.

response_hook

Callable

Yanıt meta verileriyle çağrılabilir bir çağrılabilir.

Döndürülenler

İzinlerin yinelenebilir bir örneği (dikteler).

Dönüş türü

Iterable[dict[str, Any]]

Özel durumlar

CosmosHttpResponseError

Verilen izin oluşturulamadıysa.

read

Kullanıcı özelliklerini okuma.

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

Parametreler

response_hook

Callable

Yanıt meta verileriyle çağrılabilir bir çağrılabilir.

Döndürülenler

Alınan kullanıcı özelliklerinin sözlüğü.

Dönüş türü

dict[str, Any]

Özel durumlar

CosmosHttpResponseError

Verilen kullanıcı alınamadıysa.

replace_permission

Kullanıcı için varsa belirtilen izni değiştirir.

İzin henüz yoksa, bir özel durum oluşturulur.

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

Parametreler

permission

Gerekli

Değiştirilecek iznin özelliklerini veya <xref:azure.cosmos.user.Permission> örneğini temsil eden kimlik (ad).

body

Gerekli

Değiştirme iznini temsil eden dikte benzeri bir nesne.

response_hook

Callable

Yanıt meta verileriyle çağrılabilir bir çağrılabilir.

Döndürülenler

Değiştirme işleminden sonra izni temsil eden bir dikte geçirildi.

Dönüş türü

dict[str, Any]

Özel durumlar

CosmosHttpResponseError

Değiştirme başarısız olduysa veya verilen kimlikle izin yoksa.

upsert_permission

Belirtilen izni ekleyin veya güncelleştirin.

İzin kapsayıcıda zaten varsa, değiştirilir. İzin yoksa eklenir.

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

Parametreler

body

Gerekli

Güncelleştirme veya ekleme iznini temsil eden dikte benzeri bir nesne.

response_hook

Callable

Gerekli

Yanıt meta verileriyle çağrılabilir bir çağrılabilir.

Döndürülenler

Upserted iznini temsil eden bir dikte.

Dönüş türü

dict[str, Any]

Özel durumlar

CosmosHttpResponseError

Verilen izin kaldırılamadıysa.