Partilhar via


SearchIndexerDataSourceConnection Classe

Representa uma definição de ligação de origem de dados, que pode ser utilizada para configurar um indexador.

Todos os parâmetros necessários têm de ser preenchidos para enviar para o Azure.

Herança
azure.search.documents.indexes._generated._serialization.Model
SearchIndexerDataSourceConnection

Construtor

SearchIndexerDataSourceConnection(**kwargs)

Variáveis

Name Description
name
str

Obrigatório. O nome da ligação da origem de dados.

description
str

A descrição da ligação da origem de dados.

type

Obrigatório. O tipo de ligação da origem de dados. Os valores possíveis incluem: "azuresql", "cosmosdb", "azureblob", "azuretable", "mysql", "adlsgen2".

connection_string
str

O cadeia de ligação para a ligação da origem de dados.

container

Obrigatório. O contentor de dados para a ligação da origem de dados.

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

A política de deteção de alteração de dados para a ligação da origem de dados.

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

A política de deteção de eliminação de dados para a ligação da origem de dados.

e_tag
str

A ETag da origem de dados.

encryption_key

Uma descrição de uma chave de encriptação que cria no Azure Key Vault. Esta chave é utilizada para fornecer um nível adicional de encriptação inativa para a definição da sua origem de dados quando quiser ter a garantia total de que ninguém, nem mesmo a Microsoft, pode desencriptar a definição da origem de dados no Azure Cognitive Search. Depois de encriptar a definição da origem de dados, esta permanecerá sempre encriptada. Azure Cognitive Search ignorará as tentativas de definir esta propriedade como nula. Pode alterar esta propriedade conforme necessário se quiser rodar a chave de encriptação; A definição da origem de dados não será afetada. A encriptação com chaves geridas pelo cliente não está disponível para serviços de pesquisa gratuita e só está disponível para serviços pagos criados a partir de 1 de janeiro de 2019 ou depois de 1 de janeiro de 2019.

Métodos

as_dict

Devolver um ditado que pode ser serializado com json.dump.

Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro:

A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente, contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. O valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict de resultado hierárquico.

Veja os três exemplos neste ficheiro:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

deserialize

Analise um str com a sintaxe RestAPI e devolva um modelo.

enable_additional_properties_sending
from_dict

Analisar um ditado com um determinado extrator de chaves devolve um modelo.

Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

Devolver o JSON que seria enviado para o servidor a partir deste modelo.

Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso).

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

as_dict

Devolver um ditado que pode ser serializado com json.dump.

Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro:

A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente, contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. O valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict de resultado hierárquico.

Veja os três exemplos neste ficheiro:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se quiser serialização XML, pode transmitir os 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]

Parâmetros

Name Description
key_transformer
<xref:function>

Uma função de transformador de chaves.

keep_readonly
valor predefinido: True

Devoluções

Tipo Description

Um objeto compatível com JSON de ditado

deserialize

Analise um str com a sintaxe RestAPI e devolva um modelo.

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

Parâmetros

Name Description
data
Necessário
str

Um str com a estrutura RestAPI. JSON por predefinição.

content_type
str

JSON por predefinição, defina application/xml se XML.

valor predefinido: None

Devoluções

Tipo Description

Uma instância deste modelo

Exceções

Tipo Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analisar um ditado com um determinado extrator de chaves devolve um modelo.

Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e 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

Parâmetros

Name Description
data
Necessário

Um ditado com a estrutura restAPI

content_type
str

JSON por predefinição, defina application/xml se XML.

valor predefinido: None
key_extractors
valor predefinido: None

Devoluções

Tipo Description

Uma instância deste modelo

Exceções

Tipo Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Devolver o JSON que seria enviado para o servidor a partir deste modelo.

Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso).

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

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

Parâmetros

Name Description
keep_readonly

Se quiser serializar os atributos só de leitura

valor predefinido: False

Devoluções

Tipo Description

Um objeto compatível com JSON de ditado