SearchIndexerDataSourceConnection Klasa

Reprezentuje definicję połączenia ze źródłem danych, która może służyć do konfigurowania indeksatora.

Wszystkie wymagane parametry muszą zostać wypełnione w celu wysłania ich na platformę Azure.

Dziedziczenie
azure.search.documents.indexes._generated._serialization.Model
SearchIndexerDataSourceConnection

Konstruktor

SearchIndexerDataSourceConnection(**kwargs)

Zmienne

Nazwa Opis
name
str

Wymagane. Nazwa połączenia ze źródłem danych.

description
str

Opis połączenia ze źródłem danych.

type

Wymagane. Typ połączenia ze źródłem danych. Możliwe wartości to: "azuresql", "cosmosdb", "azureblob", "azuretable", "mysql", "adlsgen2".

connection_string
str

Parametry połączenia dla połączenia ze źródłem danych.

container

Wymagane. Kontener danych dla połączenia ze źródłem danych.

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

Zasady wykrywania zmian danych dla połączenia ze źródłem danych.

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

Zasady wykrywania usuwania danych dla połączenia ze źródłem danych.

e_tag
str

Element ETag źródła danych.

encryption_key

Opis klucza szyfrowania tworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania magazynowanych dla definicji źródła danych, gdy chcesz mieć pełną pewność, że nikt, nawet firma Microsoft, nie może odszyfrować definicję źródła danych w Azure Cognitive Search. Po zaszyfrowaniu definicji źródła danych zawsze pozostanie ona zaszyfrowana. Azure Cognitive Search zignoruje próby ustawienia tej właściwości na wartość null. Tę właściwość można zmienić w razie potrzeby, jeśli chcesz obrócić klucz szyfrowania; Definicja źródła danych nie będzie miała wpływu. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych 1 stycznia 2019 r. lub później.

Metody

as_dict

Zwróć dykt, który można serializować przy użyciu pliku json.dump.

Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru:

Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym za pomocą interfejsu RESTAPI. Wartość jest bieżącą wartością w tym obiekcie.

Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uznawane za hierarchiczny dykt wyniku.

Zobacz trzy przykłady w tym pliku:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

deserialize

Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.

enable_additional_properties_sending
from_dict

Przeanalizuj dykt przy użyciu danego modułu wyodrębniającego klucz, który zwraca model.

Domyślnie należy rozważyć wyodrębnianie kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

Zwróć kod JSON, który zostanie wysłany do serwera z tego modelu.

Jest to alias as_dict (full_restapi_key_transformer, keep_readonly=False).

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

as_dict

Zwróć dykt, który można serializować przy użyciu pliku json.dump.

Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru:

Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym za pomocą interfejsu RESTAPI. Wartość jest bieżącą wartością w tym obiekcie.

Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uznawane za hierarchiczny dykt wyniku.

Zobacz trzy przykłady w tym pliku:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Jeśli chcesz serializacji XML, możesz przekazać 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]

Parametry

Nazwa Opis
key_transformer
<xref:function>

Funkcja transformatora klucza.

keep_readonly
wartość domyślna: True

Zwraca

Typ Opis

Obiekt zgodny z dyktacją JSON

deserialize

Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.

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

Parametry

Nazwa Opis
data
Wymagane
str

Str używający struktury RestAPI. Domyślnie dane JSON.

content_type
str

Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML.

wartość domyślna: None

Zwraca

Typ Opis

Wystąpienie tego modelu

Wyjątki

Typ Opis
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Przeanalizuj dykt przy użyciu danego modułu wyodrębniającego klucz, który zwraca model.

Domyślnie należy rozważyć wyodrębnianie kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i 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

Parametry

Nazwa Opis
data
Wymagane

Dykt używający struktury RestAPI

content_type
str

Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML.

wartość domyślna: None
key_extractors
wartość domyślna: None

Zwraca

Typ Opis

Wystąpienie tego modelu

Wyjątki

Typ Opis
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Zwróć kod JSON, który zostanie wysłany do serwera z tego modelu.

Jest to alias as_dict (full_restapi_key_transformer, keep_readonly=False).

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

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

Parametry

Nazwa Opis
keep_readonly

Jeśli chcesz serializować atrybuty tylko do odczytu

wartość domyślna: False

Zwraca

Typ Opis

Obiekt zgodny z dyktacją JSON