SearchIndexerDataSourceConnection 類別
表示可用來設定索引子的資料來源連接定義。
必須填入所有必要的參數,才能傳送至 Azure。
- 繼承
-
azure.search.documents.indexes._generated._serialization.ModelSearchIndexerDataSourceConnection
建構函式
SearchIndexerDataSourceConnection(**kwargs)
變數
名稱 | Description |
---|---|
name
|
必要。 資料來源連接的名稱。 |
description
|
資料來源連接的描述。 |
type
|
必要。 資料來源連接的型別。 可能的值包括:「azuresql」、「cosmosdb」、「azureblob」、「azuretable」、「mysql」、「adlsgen2」。 |
connection_string
|
資料來源連接的連接字串。 |
container
|
必要。 資料來源連接的資料容器。 |
data_change_detection_policy
|
<xref:azure.search.documents.models.DataChangeDetectionPolicy>
資料來源連線的資料變更偵測原則。 |
data_deletion_detection_policy
|
<xref:azure.search.documents.models.DataDeletionDetectionPolicy>
資料來源連線的資料刪除偵測原則。 |
e_tag
|
資料來源的 ETag。 |
encryption_key
|
您在 Azure 金鑰保存庫中建立的加密金鑰描述。 當您想要完整保證任何一個甚至 Microsoft 都無法在Azure 認知搜尋中解密資料來源定義時,此金鑰可用來為數據源定義提供額外的待用加密層級。 一旦您加密資料源定義,它一律會保持加密狀態。 Azure 認知搜尋會忽略將此屬性設定為 null 的嘗試。 如果您想要輪替加密金鑰,您可以視需要變更此屬性;您的資料來源定義將不會受到影響。 使用客戶管理的金鑰加密不適用於免費搜尋服務,而且僅適用于在 2019 年 1 月 1 日或之後建立的付費服務。 |
方法
as_dict |
傳回可使用 json.dump 序列化的聽寫。 進階用法可以選擇性地使用回呼作為參數: 索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type',以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。 傳回的字串將用來序列化索引鍵。 如果傳回類型是清單,則會將此視為階層式結果聽寫。 請參閱此檔案中的三個範例:
如果您想要 XML 序列化,您可以傳遞 kwargs is_xml=True。 |
deserialize |
使用 RestAPI 語法剖析 str 並傳回模型。 |
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是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type',以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。
傳回的字串將用來序列化索引鍵。 如果傳回類型是清單,則會將此視為階層式結果聽寫。
請參閱此檔案中的三個範例:
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]
參數
名稱 | Description |
---|---|
key_transformer
|
<xref:function>
金鑰轉換器函式。 |
keep_readonly
|
預設值: True
|
傳回
類型 | Description |
---|---|
與聽寫 JSON 相容的物件 |
deserialize
使用 RestAPI 語法剖析 str 並傳回模型。
deserialize(data: Any, content_type: str | None = None) -> ModelType
參數
名稱 | Description |
---|---|
data
必要
|
使用 RestAPI 結構的 str。 JSON 預設為 。 |
content_type
|
JSON 預設會設定 application/xml if XML。 預設值: None
|
傳回
類型 | Description |
---|---|
此模型的實例 |
例外狀況
類型 | Description |
---|---|
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
參數
名稱 | Description |
---|---|
data
必要
|
使用 RestAPI 結構的聽寫 |
content_type
|
JSON 預設會設定 application/xml if XML。 預設值: None
|
key_extractors
|
預設值: None
|
傳回
類型 | Description |
---|---|
此模型的實例 |
例外狀況
類型 | Description |
---|---|
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]
參數
名稱 | Description |
---|---|
keep_readonly
|
如果您想要序列化唯讀屬性 預設值: False
|
傳回
類型 | Description |
---|---|
與聽寫 JSON 相容的物件 |
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應