Data Sources - Create

Serviço:: Search Service

Versão da API:: 2026-04-01

Cria uma nova fonte de dados.

POST {endpoint}/datasources?api-version=2026-04-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
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 utilizar para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de string opaco, globalmente único e gerado pelo cliente para o pedido.

Corpo do Pedido

Name	Necessário	Tipo	Description
container	True	SearchIndexerDataContainer	O contêiner de dados para a fonte de dados.
name	True	string	O nome da fonte de dados.
type	True	SearchIndexerDataSourceType	O tipo da fonte de dados.
@odata.etag		string	O ETag da 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 deteção de alteração de dados para a fonte de dados.
dataDeletionDetectionPolicy		DataDeletionDetectionPolicy: NativeBlobSoftDeleteDeletionDetectionPolicy SoftDeleteColumnDeletionDetectionPolicy	A política de deteçã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 Cofre de Chaves do Azure. 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 null. 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 ou após 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 ao sistema será usada. Se não for especificado, o valor permanecerá inalterado. Se "nenhum" for especificado, o valor dessa propriedade será limpo.

Respostas

Name	Tipo	Description
201 Created	SearchIndexerDataSource	O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

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

Âmbitos

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

Exemplos

SearchServiceCreateDataSource

Pedido de amostra

HTTP

POST https://exampleservice.search.windows.net/datasources?api-version=2026-04-01


{
  "name": "tempdatasource",
  "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"
  },
  "identity": {
    "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
  },
  "dataChangeDetectionPolicy": {
    "highWaterMarkColumnName": "metadata_storage_last_modified",
    "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy"
  },
  "dataDeletionDetectionPolicy": {
    "softDeleteColumnName": "isDeleted",
    "softDeleteMarkerValue": "true",
    "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy"
  },
  "@odata.etag": "0x1234568AE7E58A1"
}

Resposta da amostra

Código de estado:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "tempdatasource",
  "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"
  },
  "identity": {
    "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
  }
}

Definições

Name	Description
Accept	O cabeçalho Aceitar.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)
HighWaterMarkChangeDetectionPolicy	Define uma política de deteção de alteração de dados que captura as alterações com base no valor de uma coluna de marca d'água alta.
NativeBlobSoftDeleteDeletionDetectionPolicy	Define uma política de deteção de exclusão de dados utilizando o recurso nativo de exclusão suave do Armazenamento de Blob do Azure para deteção de exclusão.
SearchIndexerDataContainer	Representa informações sobre a entidade (como a tabela SQL do Azure ou a coleção CosmosDB) que será indexada.
SearchIndexerDataNoneIdentity	Limpa a propriedade identity 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 a ser usada por uma fonte de dados.
SearchResourceEncryptionKey	Uma chave de criptografia gerenciada pelo cliente no Cofre de Chaves do Azure. 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 deteção de exclusão de dados que implementa uma estratégia de exclusão suave. Determina se um item deve ser excluído com base no valor de uma coluna designada de 'exclusão suave'.
SqlIntegratedChangeTrackingPolicy	Define uma política de deteção de alterações de dados que captura alterações usando o recurso Controle Integrado de Alterações do Banco de Dados SQL do Azure.

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

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

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

HighWaterMarkChangeDetectionPolicy

Object

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

Name	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	O discriminador para tipos derivados.
highWaterMarkColumnName	string	O nome da coluna da marca d'água alta.

NativeBlobSoftDeleteDeletionDetectionPolicy

Object

Define uma política de deteção de exclusão de dados utilizando o recurso nativo de exclusão suave do Armazenamento de Blob do Azure para deteção de exclusão.

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

SearchIndexerDataContainer

Object

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

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

SearchIndexerDataNoneIdentity

Object

Limpa a propriedade identity de uma fonte de dados.

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

SearchIndexerDataSource

Object

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

Name	Tipo	Description
@odata.etag	string	O 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 deteção de alteração de dados para a fonte de dados.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: NativeBlobSoftDeleteDeletionDetectionPolicy SoftDeleteColumnDeletionDetectionPolicy	A política de deteçã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 Cofre de Chaves do Azure. 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 null. 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 ou após 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 ao sistema será usada. Se não for especificado, o valor permanecerá inalterado. Se "nenhum" for especificado, o valor dessa propriedade será limpo.
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	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 da Tabela do Azure.
mysql	Indica uma fonte de dados MySql.
adlsgen2	Indica uma fonte de dados ADLS Gen2.
onelake	Indica uma fonte de dados do Microsoft Fabric OneLake.
sharepoint	Indica uma fonte de dados do SharePoint.

SearchIndexerDataUserAssignedIdentity

Object

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

Name	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Um fragmento de URI especificando o tipo de identidade.
userAssignedIdentity	string	A ID de recurso do Azure totalmente qualificada de uma identidade gerenciada atribuída ao usuário normalmente no formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que deveria ter sido atribuída ao serviço de pesquisa.

SearchResourceEncryptionKey

Object

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

Name	Tipo	Description
accessCredentials.applicationId	string	Uma ID de Aplicativo AAD que recebeu as permissões de acesso necessárias ao Cofre da Chave do Azure que deve ser usada ao criptografar seus dados em repouso. A ID do aplicativo não deve ser confundida com a ID do objeto do seu aplicativo 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 ao sistema será usada. Na atualização do recurso, se a identidade explícita não for especificada, ela permanecerá inalterada. Se "nenhum" for especificado, o valor dessa propriedade será limpo.
keyVaultKeyName	string	O nome da sua chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso.
keyVaultKeyVersion	string	A versão da chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso.
keyVaultUri	string	O URI do seu Cofre da Chave do Azure, 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

Object

Define uma política de deteção de exclusão de dados que implementa uma estratégia de exclusão suave. Determina se um item deve ser excluído com base no valor de uma coluna designada de 'exclusão suave'.

Name	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	O discriminador para tipos derivados.
softDeleteColumnName	string	O nome da coluna a ser usada para deteção de exclusão suave.
softDeleteMarkerValue	string	O valor do marcador que identifica um item como excluído.

SqlIntegratedChangeTrackingPolicy

Object

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

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