次の方法で共有


SearchIndexerDataSourceConnection クラス

インデクサーの構成に使用できるデータソース接続定義を表します。

Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。

継承
azure.search.documents.indexes._generated._serialization.Model
SearchIndexerDataSourceConnection

コンストラクター

SearchIndexerDataSourceConnection(**kwargs)

変数

名前 説明
name
str

必須。 データソース接続の名前。

description
str

データソース接続の説明。

type

必須。 データソース接続の種類。 使用できる値は、"azuresql"、"cosmosdb"、"azureblob"、"azuretable"、"mysql"、"adlsgen2" です。

connection_string
str

データソース接続の接続文字列。

container

必須。 データソース接続のデータ コンテナー。

data_change_detection_policy
<xref:azure.search.documents.models.DataChangeDetectionPolicy>

データソース接続のデータ変更検出ポリシー。

data_deletion_detection_policy
<xref:azure.search.documents.models.DataDeletionDetectionPolicy>

データソース接続のデータ削除検出ポリシー。

e_tag
str

データ ソースの ETag。

encryption_key

Azure Key Vaultで作成する暗号化キーの説明。 このキーは、Microsoft 以外のユーザーがAzure Cognitive Searchでデータ ソース定義の暗号化を解除できないという完全な保証が必要な場合に、データソース定義に保存時の暗号化レベルを追加するために使用されます。 データ ソース定義を暗号化すると、常に暗号化されたままになります。 Azure Cognitive Searchは、このプロパティを null に設定する試行を無視します。 暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。データソース定義は影響を受けません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

メソッド

as_dict

json.dump を使用してシリアル化できる dict を返します。

高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。

キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。

このファイルの 3 つの例を参照してください。

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

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 を使用してシリアル化できる dict を返します。

高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。

キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。

このファイルの 3 つの例を参照してください。

  • 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

戻り値

説明

dict JSON 互換オブジェクト

deserialize

RestAPI 構文を使用して str を解析し、モデルを返します。

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

パラメーター

名前 説明
data
必須
str

RestAPI 構造体を使用する str。 既定では JSON。

content_type
str

JSON は既定で、application/xml if 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 if 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

readonly 属性をシリアル化する場合

既定値: False

戻り値

説明

dict JSON 互換オブジェクト