SearchResourceEncryptionKey الفصل

مفتاح تشفير يديره العميل في Azure Key Vault. يمكن استخدام المفاتيح التي تقوم بإنشائها وإدارتها لتشفير البيانات الثابتة أو فك تشفيرها في Azure Cognitive Search، مثل الفهارس وخرائط المرادفات.

يجب ملء جميع المعلمات المطلوبة لإرسالها إلى Azure.

توريث
azure.search.documents.indexes._generated._serialization.Model
SearchResourceEncryptionKey

الدالمنشئ

SearchResourceEncryptionKey(**kwargs)

المتغيرات

الاسم الوصف
key_name
str

مطلوب اسم مفتاح Azure Key Vault الذي سيتم استخدامه لتشفير بياناتك الثابتة.

key_version
str

مطلوب إصدار مفتاح Azure Key Vault الخاص بك لاستخدامه لتشفير بياناتك الثابتة.

vault_uri
str

مطلوب عنوان URI الخاص ب Azure Key Vault، ويشار إليه أيضا باسم DNS، الذي يحتوي على المفتاح الذي سيتم استخدامه لتشفير بياناتك الثابتة. قد يكون https://myعنوان URI المثال - keyvault-name.vault.azure.net.

application_id
str

مطلوب معرف تطبيق AAD الذي تم منحه أذونات الوصول المطلوبة إلى Key Vault Azure التي سيتم استخدامها عند تشفير بياناتك الثابتة. يجب عدم الخلط بين معرف التطبيق ومعرف الكائن لتطبيق AAD الخاص بك.

application_secret
str

مفتاح المصادقة لتطبيق AAD المحدد.

الأساليب

as_dict

إرجاع إملاء يمكن تسلسله باستخدام json.dump.

قد يستخدم الاستخدام المتقدم رد اتصال كمعلمة اختياريا:

المفتاح هو اسم السمة المستخدم في Python. Attr_desc هو قالب من بيانات التعريف. يحتوي حاليا على "type" مع نوع msrest و"المفتاح" مع المفتاح المشفرة RestAPI. القيمة هي القيمة الحالية في هذا الكائن.

سيتم استخدام السلسلة التي تم إرجاعها لتسلسل المفتاح. إذا كان نوع الإرجاع عبارة عن قائمة، يعتبر هذا إملاءا للنتيجة الهرمية.

راجع الأمثلة الثلاثة في هذا الملف:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

إذا كنت تريد تسلسل XML، يمكنك تمرير kwargs is_xml=True.

deserialize

تحليل سلسلة باستخدام بناء جملة RestAPI وإرجاع نموذج.

enable_additional_properties_sending
from_dict

تحليل الإملاء باستخدام مستخرج مفتاح معين يرجع نموذجا.

بشكل افتراضي، ضع في اعتبارك المستخرجات الرئيسية (rest_key_case_insensitive_extractor attribute_key_case_insensitive_extractor last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

إرجاع JSON الذي سيتم إرساله إلى الخادم من هذا النموذج.

هذا اسم مستعار as_dict(full_restapi_key_transformer, keep_readonly=False).

إذا كنت تريد تسلسل XML، يمكنك تمرير kwargs is_xml=True.

as_dict

إرجاع إملاء يمكن تسلسله باستخدام json.dump.

قد يستخدم الاستخدام المتقدم رد اتصال كمعلمة اختياريا:

المفتاح هو اسم السمة المستخدم في Python. Attr_desc هو قالب من بيانات التعريف. يحتوي حاليا على "type" مع نوع msrest و"المفتاح" مع المفتاح المشفرة RestAPI. القيمة هي القيمة الحالية في هذا الكائن.

سيتم استخدام السلسلة التي تم إرجاعها لتسلسل المفتاح. إذا كان نوع الإرجاع عبارة عن قائمة، يعتبر هذا إملاءا للنتيجة الهرمية.

راجع الأمثلة الثلاثة في هذا الملف:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

إذا كنت تريد تسلسل XML، يمكنك تمرير kwargs is_xml=True.

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

المعلمات

الاسم الوصف
key_transformer
<xref:function>

دالة محول مفاتيح.

keep_readonly
القيمة الافتراضية: True

المرتجعات

النوع الوصف

كائن متوافق مع JSON

deserialize

تحليل سلسلة باستخدام بناء جملة RestAPI وإرجاع نموذج.

deserialize(data: Any, content_type: str | None = None) -> ModelType

المعلمات

الاسم الوصف
data
مطلوب
str

سلسلة باستخدام بنية RestAPI. JSON بشكل افتراضي.

content_type
str

JSON بشكل افتراضي، قم بتعيين application/xml إذا XML.

القيمة الافتراضية: None

المرتجعات

النوع الوصف

مثيل لهذا النموذج

استثناءات

النوع الوصف
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

تحليل الإملاء باستخدام مستخرج مفتاح معين يرجع نموذجا.

بشكل افتراضي، ضع في اعتبارك المستخرجات الرئيسية (rest_key_case_insensitive_extractor attribute_key_case_insensitive_extractor last_rest_key_case_insensitive_extractor)

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

المعلمات

الاسم الوصف
data
مطلوب

إملاء باستخدام بنية RestAPI

content_type
str

JSON بشكل افتراضي، قم بتعيين application/xml إذا XML.

القيمة الافتراضية: None
key_extractors
القيمة الافتراضية: None

المرتجعات

النوع الوصف

مثيل لهذا النموذج

استثناءات

النوع الوصف
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

إرجاع JSON الذي سيتم إرساله إلى الخادم من هذا النموذج.

هذا اسم مستعار as_dict(full_restapi_key_transformer, keep_readonly=False).

إذا كنت تريد تسلسل XML، يمكنك تمرير kwargs is_xml=True.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

المعلمات

الاسم الوصف
keep_readonly

إذا كنت تريد تسلسل السمات للقراءة فقط

القيمة الافتراضية: False

المرتجعات

النوع الوصف

كائن متوافق مع JSON