Data Sources - Get

Serviço:: Search Service

Versão da API:: 2025-09-01

Recupera uma definição de fonte de dados.

GET {endpoint}/datasources('{dataSourceName}')?api-version=2025-09-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
dataSourceName	path	True	string	O nome da fonte de dados a ser recuperada.
endpoint	path	True	string	A URL do ponto de extremidade do serviço de pesquisa.
api-version	query	True	string	Versão da API do cliente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string (uuid)	O ID de rastreamento enviado com a solicitação para ajudar na depuração.

Respostas

Nome	Tipo	Description
200 OK	SearchIndexerDataSource
Other Status Codes	ErrorResponse	Resposta de erro.

Exemplos

SearchServiceGetDataSource

Solicitação de exemplo

HTTP

GET https://stableexampleservice.search.windows.net/datasources('mydocdbdatasource')?api-version=2025-09-01

Resposta de exemplo

Código de status:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "mydocdbdatasource",
  "description": "My Azure Blob data source.",
  "type": "azureblob",
  "credentials": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net "
  },
  "container": {
    "name": "doc-extraction-skillset",
    "query": "E2E_Dsat"
  },
  "dataChangeDetectionPolicy": {
    "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy",
    "highWaterMarkColumnName": "metadata_storage_last_modified"
  },
  "dataDeletionDetectionPolicy": {
    "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy",
    "softDeleteColumnName": "isDeleted",
    "softDeleteMarkerValue": "true"
  }
}

Definições

Nome	Description
AzureActiveDirectoryApplicationCredentials	Credenciais de um aplicativo registrado criado para o serviço de pesquisa, usado para acesso autenticado às chaves de criptografia armazenadas no Azure Key Vault.
DataSourceCredentials	Representa credenciais que podem ser usadas para se conectar a uma fonte de dados.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
HighWaterMarkChangeDetectionPolicy	Define uma política de detecção de alteração de dados que captura alterações com base no valor de uma coluna de marca d'água alta.
SearchIndexerDataContainer	Representa informações sobre a entidade (como a tabela SQL do Azure ou a coleção do CosmosDB) que será indexada.
SearchIndexerDataSource	Representa uma definição de fonte de dados, que pode ser usada para configurar um indexador.
SearchIndexerDataSourceType	Define o tipo de uma fonte de dados.
SearchResourceEncryptionKey	Uma chave de criptografia gerenciada pelo cliente no Azure Key Vault. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso, como índices e mapas de sinônimos.
SoftDeleteColumnDeletionDetectionPolicy	Define uma política de detecção de exclusão de dados que implementa uma estratégia de exclusão reversível. Ele determina se um item deve ser excluído com base no valor de uma coluna de 'exclusão reversível' designada.
SqlIntegratedChangeTrackingPolicy	Define uma política de detecção de alterações de dados que captura alterações usando o recurso Controle de Alterações Integrado do Banco de Dados SQL do Azure.

AzureActiveDirectoryApplicationCredentials

Objeto

Credenciais de um aplicativo registrado criado para o serviço de pesquisa, usado para acesso autenticado às chaves de criptografia armazenadas no Azure Key Vault.

Nome	Tipo	Description
applicationId	string	Uma ID de Aplicativo do AAD que recebeu as permissões de acesso necessárias ao Azure Key Vault que deve ser usado ao criptografar seus dados em repouso. A ID do Aplicativo não deve ser confundida com a ID do Objeto do Aplicativo AAD.
applicationSecret	string	A chave de autenticação do aplicativo AAD especificado.

DataSourceCredentials

Objeto

Representa credenciais que podem ser usadas para se conectar a uma fonte de dados.

Nome	Tipo	Description
connectionString	string	A cadeia de conexão para a fonte de dados. Para SQL do Azure, Blob do Azure, ADLS Gen 2 e Tabela do Azure, essa seria a cadeia de conexão ou a ID do recurso se estiver usando a identidade gerenciada. Para o CosmosDB, essa seria uma cadeia de conexão formatada especificando ApiKind ou ID de recurso para identidade gerenciada. Para arquivos Onelake, a cadeia de conexão seria o guid do workspace ou o FQDN do workspace; O Onelake só dá suporte a conexões de identidade gerenciadas. Defina como `<unchanged>` (com colchetes) se não quiser que a cadeia de conexão seja atualizada. Defina como `<redacted>` se quiser remover o valor da cadeia de conexão da fonte de dados.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

HighWaterMarkChangeDetectionPolicy

Objeto

Define uma política de detecção de alteração de dados que captura alterações com base no valor de uma coluna de marca d'água alta.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	Um fragmento de URI que especifica o tipo de política de detecção de alteração de dados.
highWaterMarkColumnName	string	O nome da coluna de marca d'água alta.

SearchIndexerDataContainer

Objeto

Representa informações sobre a entidade (como a tabela SQL do Azure ou a coleção do CosmosDB) que será indexada.

Nome	Tipo	Description
name	string	O nome da tabela ou exibição (para fonte de dados SQL do Azure), coleção (para fonte de dados do CosmosDB), contêiner (para fontes de dados do Blob do Azure e ADLS Gen 2), Tabela do Azure (para fonte de dados da Tabela do Azure) ou lakehouse (para fonte de dados do Onelake) que será indexada.
query	string	Uma consulta aplicada a esse contêiner de dados. Para o CosmosDB, a consulta de fonte de dados pode nivelar e filtrar dados. Para o Blob do Azure e o ADLS Gen 2, a consulta pode filtrar por pastas. Para a consulta Tabela do Azure, pode filtrar por dados de linha. Para Onelake, a consulta pode filtrar por pasta ou atalho. Não há suporte para fontes de dados SQL do Azure.

SearchIndexerDataSource

Objeto

Representa uma definição de fonte de dados, que pode ser usada para configurar um indexador.

Nome	Tipo	Description
@odata.etag	string	A ETag da fonte de dados.
container	SearchIndexerDataContainer	O contêiner de dados da fonte de dados.
credentials	DataSourceCredentials	Credenciais para a fonte de dados.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	A política de detecção de alteração de dados para a fonte de dados.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	A política de detecção de exclusão de dados para a fonte de dados.
description	string	A descrição da fonte de dados.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para sua definição de fonte de dados quando você deseja garantia total de que ninguém, nem mesmo a Microsoft, pode descriptografar sua definição de fonte de dados. Depois de criptografar sua definição de fonte de dados, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de dados não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados a partir de 1º de janeiro de 2019.
name	string	O nome da fonte de dados.
type	SearchIndexerDataSourceType	O tipo da fonte de dados.

SearchIndexerDataSourceType

Enumeração

Define o tipo de uma fonte de dados.

Valor	Description
azuresql	Definição de uma fonte de dados SQL do Azure cujas credenciais podem ser uma cadeia de conexão SQL padrão ou o ResourceId do recurso SQL. A propriedade container refere-se à tabela ou exibição a ser indexada. Não há suporte para esse parâmetro de consulta para essa fonte de dados.
cosmosdb	Definição de uma fonte de dados do CosmosDB cujas credenciais podem ser uma cadeia de conexão formatada contendo detalhes para AccountEndpoint, AccountKey e Database para uma conexão baseada em chave ou detalhes para ResourceID e ApiKind para conexão sem chave. A propriedade container refere-se à coleção cosmosdb a ser indexada e a propriedade de consulta opcional refere-se a uma consulta SQL na coleção.
azureblob	Definição de uma fonte de dados de Blob do Azure cujas credenciais podem ser uma cadeia de conexão de armazenamento ou o ResourceId da conta de armazenamento. A propriedade container refere-se ao contêiner de blob a ser indexado e a propriedade query opcional refere-se a uma subpasta específica no contêiner.
azuretable	Definição de uma fonte de dados de Tabela do Azure cujas credenciais podem ser uma cadeia de conexão de tabela ou o ResourceId da conta de armazenamento. A propriedade container refere-se ao contêiner de blob a ser indexado e a propriedade de consulta opcional pode ser usada para filtrar linhas.
mysql	Definição de uma fonte de dados SQL do Azure cujas credenciais podem ser uma cadeia de conexão SQL padrão ADO.NET formatada ou o ResourceId do recurso SQL. A propriedade container refere-se à tabela ou exibição a ser indexada. Não há suporte para esse parâmetro de consulta para essa fonte de dados.
adlsgen2	Definição de uma fonte de dados do Azure ADLS Gen 2 cujas credenciais podem ser uma cadeia de conexão de armazenamento ou o ResourceId da conta de armazenamento. A propriedade container refere-se ao contêiner de blob a ser indexado e a propriedade query opcional refere-se a uma subpasta específica no contêiner.
onelake	Definição de uma fonte de dados do Microsoft Fabric Onelake cujas credenciais podem ser o GUID do espaço de trabalho do Fabric ou um FQDN do espaço de trabalho. A propriedade container refere-se ao GUID do lakehouse e a propriedade de consulta opcional refere-se a pastas ou atalhos no lakehouse.

SearchResourceEncryptionKey

Objeto

Uma chave de criptografia gerenciada pelo cliente no Azure Key Vault. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso, como índices e mapas de sinônimos.

Nome	Tipo	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Credenciais opcionais do Azure Active Directory usadas para acessar o Azure Key Vault. Não é necessário se estiver usando a identidade gerenciada.
keyVaultKeyName	string	O nome da chave do Azure Key Vault a ser usada para criptografar seus dados em repouso.
keyVaultKeyVersion	string	A versão da chave do Azure Key Vault a ser usada para criptografar seus dados em repouso.
keyVaultUri	string	O URI do Azure Key Vault, também conhecido como nome DNS, que contém a chave a ser usada para criptografar seus dados em repouso. Um exemplo de URI pode ser `https://my-keyvault-name.vault.azure.net`.

SoftDeleteColumnDeletionDetectionPolicy

Objeto

Define uma política de detecção de exclusão de dados que implementa uma estratégia de exclusão reversível. Ele determina se um item deve ser excluído com base no valor de uma coluna de 'exclusão reversível' designada.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	Um fragmento de URI que especifica o tipo de política de detecção de exclusão de dados.
softDeleteColumnName	string	O nome da coluna a ser usada para detecção de exclusão reversível.
softDeleteMarkerValue	string	O valor do marcador que identifica um item como excluído.

SqlIntegratedChangeTrackingPolicy

Objeto

Define uma política de detecção de alterações de dados que captura alterações usando o recurso Controle de Alterações Integrado do Banco de Dados SQL do Azure.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	Um fragmento de URI que especifica o tipo de política de detecção de alteração de dados.

Compartilhar via

Data Sources - Get

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Exemplos

SearchServiceGetDataSource

Solicitação de exemplo

Resposta de exemplo

Definições

AzureActiveDirectoryApplicationCredentials

DataSourceCredentials

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HighWaterMarkChangeDetectionPolicy

SearchIndexerDataContainer

SearchIndexerDataSource

SearchIndexerDataSourceType

SearchResourceEncryptionKey

SoftDeleteColumnDeletionDetectionPolicy

SqlIntegratedChangeTrackingPolicy