Data Sources - Get

Serviço:: Search Service

Versão da API:: 2026-05-01-preview

Recupera uma definição de fonte de dados.

GET {endpoint}/datasources('{dataSourceName}')?api-version=2026-05-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
dataSourceName	path	True	string	O nome da fonte de dados.
endpoint	path	True	string (uri)	A URL do ponto de extremidade do serviço de pesquisa.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Respostas

Nome	Tipo	Description
200 OK	SearchIndexerDataSource	A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

Nome	Description
https://search.azure.com/.default

Exemplos

SearchServiceGetDataSource

Solicitação de exemplo

HTTP

GET https://previewexampleservice.search.windows.net/datasources('mydocdbdatasource')?api-version=2026-05-01-preview

Resposta de exemplo

Código de status:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "mydocdbdatasource",
  "description": "My Azure Adls Gen2 data source with ACLs.",
  "type": "adlsgen2",
  "indexerPermissionOptions": [
    "userIds",
    "groupIds",
    "rbacScope"
  ],
  "credentials": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net "
  },
  "container": {
    "name": "adls-gen2-doc-extraction-acl",
    "query": "folder_has_final_acl"
  },
  "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
Accept	O cabeçalho Aceitar.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
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.
IndexerPermissionOption	Opções com vários tipos de dados de permissão para indexar.
NativeBlobSoftDeleteDeletionDetectionPolicy	Define uma política de detecção de exclusão de dados utilizando o recurso de exclusão reversível nativo do Armazenamento de Blobs do Azure para detecção de exclusão.
SearchIndexerDataContainer	Representa informações sobre a entidade (como a tabela SQL do Azure ou a coleção cosmosDB) que serão indexadas.
SearchIndexerDataNoneIdentity	Limpa a propriedade de identidade de uma fonte de dados.
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.
SearchIndexerDataUserAssignedIdentity	Especifica a identidade de uma fonte de dados a ser usada.
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 designada como "exclusão reversível".
SqlIntegratedChangeTrackingPolicy	Define uma política de detecção de alteração de dados que captura alterações usando o recurso controle de alterações integrado do Banco de Dados SQL do Azure.

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objeto

Informações adicionais sobre o erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	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 alvo do erro.

ErrorResponse

Objeto

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).

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	O discriminador para tipos derivados.
highWaterMarkColumnName	string	O nome da coluna de marca de água alta.

IndexerPermissionOption

Enumeração

Opções com vários tipos de dados de permissão para indexar.

Valor	Description
userIds	Indexador para assimilar userIds da ACL da fonte de dados para o índice.
groupIds	Indexador para ingerir groupIds da ACL da fonte de dados para o índice.
rbacScope	Indexador para ingerir o escopo do RBAC do Azure da fonte de dados para o índice.

NativeBlobSoftDeleteDeletionDetectionPolicy

Objeto

Define uma política de detecção de exclusão de dados utilizando o recurso de exclusão reversível nativo do Armazenamento de Blobs do Azure para detecção de exclusão.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy	O discriminador para tipos derivados.

SearchIndexerDataContainer

Objeto

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

Nome	Tipo	Description
name	string	O nome da tabela ou exibição (para fonte de dados SQL do Azure) ou coleção (para fonte de dados do CosmosDB) que será indexada.
query	string	Uma consulta que é aplicada a esse contêiner de dados. A sintaxe e o significado desse parâmetro são específicos da fonte de dados. Não há suporte para fontes de dados SQL do Azure.

SearchIndexerDataNoneIdentity

Objeto

Limpa a propriedade de identidade de uma fonte de dados.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Um fragmento de URI especificando o tipo de identidade.

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 para a fonte de dados.
credentials.connectionString	string	A cadeia de conexão para a fonte de dados. 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.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	A política de detecção de alteração de dados para a fonte de dados.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: NativeBlobSoftDeleteDeletionDetectionPolicy 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 a definição da 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 em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Uma identidade gerenciada explícita a ser usada para essa fonte de dados. Se não for especificado e a cadeia de conexão for uma identidade gerenciada, a identidade gerenciada atribuída pelo sistema será usada. Se não for especificado, o valor permanecerá inalterado. Se "nenhum" for especificado, o valor dessa propriedade será limpo.
indexerPermissionOptions	IndexerPermissionOption[]	Opções de ingestão com vários tipos de dados de permissão.
name	string	O nome da fonte de dados.
subType	string	Um tipo específico da fonte de dados, caso o recurso seja capaz de diferentes modalidades. Por exemplo, 'MongoDb' para determinadas contas 'cosmosDb'.
type	SearchIndexerDataSourceType	O tipo da fonte de dados.

SearchIndexerDataSourceType

Enumeração

Define o tipo de uma fonte de dados.

Valor	Description
azuresql	Indica uma fonte de dados SQL do Azure.
cosmosdb	Indica uma fonte de dados do CosmosDB.
azureblob	Indica uma fonte de dados de Blob do Azure.
azuretable	Indica uma fonte de dados de Tabela do Azure.
mysql	Indica uma fonte de dados MySql.
adlsgen2	Indica uma fonte de dados do ADLS Gen2.
onelake	Indica uma fonte de dados do Microsoft Fabric OneLake.
sharepoint	Indica uma fonte de dados do SharePoint.

SearchIndexerDataUserAssignedIdentity

Objeto

Especifica a identidade de uma fonte de dados a ser usada.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Um fragmento de URI especificando o tipo de identidade.
federatedIdentityClientId	string	Suporte a Identidade Gerenciada User-Assigned Multi-Inquilino: O ID do cliente do aplicativo multi-tentante que foi configurado para federar com a identidade gerenciada atribuída pelo usuário.
userAssignedIdentity	string	A ID de recurso do Azure totalmente qualificada de uma identidade gerenciada atribuída pelo usuário normalmente no formato "/subscriptions/12345678-1234-1234-12334-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que deveria ter sido atribuída ao serviço de pesquisa.

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	Valor padrão	Description
accessCredentials.applicationId	string		Uma ID de aplicativo do AAD que recebeu as permissões de acesso necessárias para o Azure Key Vault que deve ser usada ao criptografar seus dados em repouso. A ID do aplicativo não deve ser confundida com a ID do objeto para seu aplicativo do AAD.
accessCredentials.applicationSecret	string		A chave de autenticação do aplicativo AAD especificado.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Uma identidade gerenciada explícita a ser usada para essa chave de criptografia. Se não for especificado e a propriedade de credenciais de acesso for nula, a identidade gerenciada atribuída pelo sistema será usada. Ao atualizar para o recurso, se a identidade explícita não for especificada, ela permanecerá inalterada. Se "nenhum" for especificado, o valor dessa propriedade será limpo.
isServiceLevelKey	boolean	False	Um valor opcional indicando se essa chave é uma chave de nível de serviço. O padrão é false.
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 URI de exemplo 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 designada como "exclusão reversível".

Nome	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	O discriminador para tipos derivados.
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ção 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	O discriminador para tipos derivados.