Data Sources - Create Or Update

Service:: Search Service

API-versie:: 2025-09-01

Hiermee maakt u een nieuwe gegevensbron of werkt u een gegevensbron bij als deze al bestaat.

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

URI-parameters

Name	In	Vereist	Type	Description
dataSourceName	path	True	string	De naam van de gegevensbron die moet worden gemaakt of bijgewerkt.
endpoint	path	True	string	De eindpunt-URL van de zoekservice.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string (uuid)	De tracking-ID die is verzonden met het verzoek om te helpen bij het opsporen.
If-Match		string	Hiermee definieert u de voorwaarde If-Match. De bewerking wordt alleen uitgevoerd als de ETag op de server overeenkomt met deze waarde.
If-None-Match		string	Definieert de voorwaarde 'Als-None-Match. De bewerking wordt alleen uitgevoerd als de ETag op de server niet overeenkomt met deze waarde.
Prefer	True	string	Voor HTTP PUT-aanvragen geeft u de service de opdracht om de gemaakte/bijgewerkte resource te retourneren als deze is geslaagd.

Aanvraagbody

Name	Vereist	Type	Description
container	True	SearchIndexerDataContainer	De gegevenscontainer voor de gegevensbron.
credentials	True	DataSourceCredentials	Referenties voor de gegevensbron.
name	True	string	De naam van de gegevensbron.
type	True	SearchIndexerDataSourceType	Het type gegevensbron.
@odata.etag		string	De ETag van de gegevensbron.
dataChangeDetectionPolicy		DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Het beleid voor het detecteren van gegevenswijzigingen voor de gegevensbron.
dataDeletionDetectionPolicy		DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	Het detectiebeleid voor het verwijderen van gegevens voor de gegevensbron.
description		string	De beschrijving van de gegevensbron.
encryptionKey		SearchResourceEncryptionKey	Een beschrijving van een versleutelingssleutel die u maakt in Azure Key Vault. Deze sleutel wordt gebruikt om een extra niveau van versleuteling-at-rest te bieden voor uw gegevensbrondefinitie wanneer u volledige zekerheid wilt dat niemand, zelfs Microsoft niet, uw gegevensbrondefinitie kan ontcijferen. Nadat u de definitie van uw gegevensbron hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. U kunt deze eigenschap naar wens wijzigen als u uw coderingssleutel wilt roteren; Dit heeft geen invloed op de definitie van uw gegevensbron. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die op of na 1 januari 2019 zijn gemaakt.

Antwoorden

Name	Type	Description
200 OK	SearchIndexerDataSource
201 Created	SearchIndexerDataSource
Other Status Codes	ErrorResponse	Foutreactie.

Voorbeelden

SearchServiceCreateOrUpdateDataSource

Voorbeeldaanvraag

HTTP

PUT https://stableexampleservice.search.windows.net/datasources('tempdatasource')?api-version=2025-09-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"
  },
  "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"
}

Voorbeeldrespons

Statuscode:: 200

{
  "@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"
  }
}

Statuscode:: 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"
  }
}

Definities

Name	Description
AzureActiveDirectoryApplicationCredentials	Referenties van een geregistreerde toepassing die is gemaakt voor uw zoekservice en die worden gebruikt voor geverifieerde toegang tot de versleutelingssleutels die zijn opgeslagen in Azure Key Vault.
DataSourceCredentials	Vertegenwoordigt referenties die kunnen worden gebruikt om verbinding te maken met een gegevensbron.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
HighWaterMarkChangeDetectionPolicy	Definieert een beleid voor het detecteren van gegevenswijzigingen waarmee wijzigingen worden vastgelegd op basis van de waarde van een kolom met een hoge watermarkering.
SearchIndexerDataContainer	Vertegenwoordigt informatie over de entiteit (zoals Azure SQL-tabel of CosmosDB-verzameling) die wordt geïndexeerd.
SearchIndexerDataSource	Vertegenwoordigt een gegevensbrondefinitie, die kan worden gebruikt om een indexeerfunctie te configureren.
SearchIndexerDataSourceType	Definieert het type gegevensbron.
SearchResourceEncryptionKey	Een door de klant beheerde versleutelingssleutel in Azure Key Vault. Sleutels die u maakt en beheert, kunnen worden gebruikt om inactieve gegevens, zoals indexen en synoniementoewijzingen, te versleutelen of te ontsleutelen.
SoftDeleteColumnDeletionDetectionPolicy	Definieert een beleid voor het detecteren van gegevensverwijdering waarmee een strategie voor zachte verwijdering wordt geïmplementeerd. Het bepaalt of een item moet worden verwijderd op basis van de waarde van een aangewezen kolom 'voorlopig verwijderen'.
SqlIntegratedChangeTrackingPolicy	Definieert een beleid voor het detecteren van gegevenswijzigingen waarmee wijzigingen worden vastgelegd met behulp van de functie Geïntegreerde wijziging bijhouden van Azure SQL Database.

AzureActiveDirectoryApplicationCredentials

Object

Referenties van een geregistreerde toepassing die is gemaakt voor uw zoekservice en die worden gebruikt voor geverifieerde toegang tot de versleutelingssleutels die zijn opgeslagen in Azure Key Vault.

Name	Type	Description
applicationId	string	Een AAD-toepassings-id waaraan de vereiste toegangsmachtigingen zijn verleend voor de Azure Key Vault die moet worden gebruikt bij het versleutelen van uw gegevens in rust. De applicatie-ID mag niet worden verward met de object-ID voor uw AAD-applicatie.
applicationSecret	string	De authenticatiesleutel van de opgegeven AAD-toepassing.

DataSourceCredentials

Object

Vertegenwoordigt referenties die kunnen worden gebruikt om verbinding te maken met een gegevensbron.

Name	Type	Description
connectionString	string	De verbindingsreeks voor de gegevensbron. Voor Azure SQL, Azure Blob, ADLS Gen 2 en Azure Table is dit de verbindingsreeks of resource-id als u een beheerde identiteit gebruikt. Voor CosmosDB is dit een opgemaakte verbindingsreeks die ApiKind of resource-ID voor beheerde identiteit opgeeft. Voor Onelake-bestanden is de verbindingsreeks de werkruimte-guid of de FQDN van de werkruimte; Onelake ondersteunt alleen beheerde identiteitsverbindingen. Stel in op `<unchanged>` (met haakjes) als u niet wilt dat de verbindingsreeks wordt bijgewerkt. Stel deze optie in op `<redacted>` als u de waarde van de connection string uit de gegevensbron wilt verwijderen.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

HighWaterMarkChangeDetectionPolicy

Object

Definieert een beleid voor het detecteren van gegevenswijzigingen waarmee wijzigingen worden vastgelegd op basis van de waarde van een kolom met een hoge watermarkering.

Name	Type	Description
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	Een URI-fragment dat het type beleid voor het detecteren van gegevenswijzigingen specificeert.
highWaterMarkColumnName	string	De naam van de hoogwatermerkkolom.

SearchIndexerDataContainer

Object

Vertegenwoordigt informatie over de entiteit (zoals Azure SQL-tabel of CosmosDB-verzameling) die wordt geïndexeerd.

Name	Type	Description
name	string	De naam van de tabel of weergave (voor Azure SQL-gegevensbron), verzameling (voor CosmosDB-gegevensbron), container (voor Azure Blob en ADLS Gen 2-gegevensbronnen), Azure Table (voor Azure Table-gegevensbron) of lakehouse (voor Onelake-gegevensbron) die wordt geïndexeerd.
query	string	Een query die wordt toegepast op deze gegevenscontainer. Voor CosmosDB datasource query kan gegevens afvlakken en filteren. Voor Azure Blob en ADLS kan Gen 2-query filteren op mappen. Voor Azure Table kan query filteren op rijgegevens. Voor Onelake kan de query filteren op map of snelkoppeling. Wordt niet ondersteund door Azure SQL-gegevensbronnen.

SearchIndexerDataSource

Object

Vertegenwoordigt een gegevensbrondefinitie, die kan worden gebruikt om een indexeerfunctie te configureren.

Name	Type	Description
@odata.etag	string	De ETag van de gegevensbron.
container	SearchIndexerDataContainer	De gegevenscontainer voor de gegevensbron.
credentials	DataSourceCredentials	Referenties voor de gegevensbron.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Het beleid voor het detecteren van gegevenswijzigingen voor de gegevensbron.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	Het detectiebeleid voor het verwijderen van gegevens voor de gegevensbron.
description	string	De beschrijving van de gegevensbron.
encryptionKey	SearchResourceEncryptionKey	Een beschrijving van een versleutelingssleutel die u maakt in Azure Key Vault. Deze sleutel wordt gebruikt om een extra niveau van versleuteling-at-rest te bieden voor uw gegevensbrondefinitie wanneer u volledige zekerheid wilt dat niemand, zelfs Microsoft niet, uw gegevensbrondefinitie kan ontcijferen. Nadat u de definitie van uw gegevensbron hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. U kunt deze eigenschap naar wens wijzigen als u uw coderingssleutel wilt roteren; Dit heeft geen invloed op de definitie van uw gegevensbron. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die op of na 1 januari 2019 zijn gemaakt.
name	string	De naam van de gegevensbron.
type	SearchIndexerDataSourceType	Het type gegevensbron.

SearchIndexerDataSourceType

Inventarisatie

Definieert het type gegevensbron.

Waarde	Description
azuresql	Definitie van een Azure SQL-gegevensbron waarvan de referenties een standaard SQL-verbindingsreeks of de ResourceId van de SQL-resource kunnen zijn. De containereigenschap verwijst naar de tabel of weergave die moet worden geïndexeerd. Queryparameter wordt niet ondersteund voor deze gegevensbron.
cosmosdb	Definitie van een CosmosDB-gegevensbron waarvan de referenties een opgemaakte verbindingsreeks kunnen zijn met details voor AccountEndpoint, AccountKey en Database voor een op sleutels gebaseerde verbinding of details voor ResourceID en ApiKind voor sleutelloze verbinding. De eigenschap container verwijst naar de cosmosdb-verzameling die moet worden geïndexeerd en de optionele query-eigenschap verwijst naar een SQL-query op de verzameling.
azureblob	Definitie van een Azure Blob-gegevensbron waarvan de referenties een opslagverbindingsreeks of de ResourceId van het opslagaccount kunnen zijn. De eigenschap container verwijst naar de blobcontainer die moet worden geïndexeerd en de optionele query-eigenschap verwijst naar een specifieke submap in de container.
azuretable	Definitie van een Azure Table-gegevensbron waarvan de referenties een tabelverbindingsreeks of de ResourceId van het opslagaccount kunnen zijn. De containereigenschap verwijst naar de blobcontainer die moet worden geïndexeerd en de optionele query-eigenschap kan worden gebruikt om rijen te filteren.
mysql	Definitie van een Azure SQL-gegevensbron waarvan de referenties een standaard ADO.NET geformatteerde SQL-verbindingsreeks of de ResourceId van de SQL-resource kunnen zijn. De containereigenschap verwijst naar de tabel of weergave die moet worden geïndexeerd. Queryparameter wordt niet ondersteund voor deze gegevensbron.
adlsgen2	Definitie van een Azure ADLS Gen 2-gegevensbron waarvan de referenties een opslagverbindingsreeks of de ResourceId van het opslagaccount kunnen zijn. De eigenschap container verwijst naar de blobcontainer die moet worden geïndexeerd en de optionele query-eigenschap verwijst naar een specifieke submap in de container.
onelake	Definitie van een Microsoft Fabric Onelake-gegevensbron waarvan de referenties de GUID van de Fabric-werkruimte of een FQDN van de werkruimte kunnen zijn. De containereigenschap verwijst naar de GUID van het lakehouse en de optionele query-eigenschap verwijst naar mappen of snelkoppelingen in het lakehouse.

SearchResourceEncryptionKey

Object

Een door de klant beheerde versleutelingssleutel in Azure Key Vault. Sleutels die u maakt en beheert, kunnen worden gebruikt om inactieve gegevens, zoals indexen en synoniementoewijzingen, te versleutelen of te ontsleutelen.

Name	Type	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Optionele Azure Active Directory-referenties die worden gebruikt voor toegang tot uw Azure Key Vault. Niet vereist als u in plaats daarvan beheerde identiteit gebruikt.
keyVaultKeyName	string	De naam van uw Azure Key Vault-sleutel die moet worden gebruikt om uw gegevens in rust te versleutelen.
keyVaultKeyVersion	string	De versie van uw Azure Key Vault-sleutel die moet worden gebruikt om uw gegevens in rust te versleutelen.
keyVaultUri	string	De URI van uw Azure Key Vault, ook wel DNS-naam genoemd, die de sleutel bevat die moet worden gebruikt om uw gegevens in rust te versleutelen. Een voorbeeld van een URI zou kunnen zijn `https://my-keyvault-name.vault.azure.net`.

SoftDeleteColumnDeletionDetectionPolicy

Object

Definieert een beleid voor het detecteren van gegevensverwijdering waarmee een strategie voor zachte verwijdering wordt geïmplementeerd. Het bepaalt of een item moet worden verwijderd op basis van de waarde van een aangewezen kolom 'voorlopig verwijderen'.

Name	Type	Description
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	Een URI-fragment dat het type detectiebeleid voor gegevensverwijdering specificeert.
softDeleteColumnName	string	De naam van de kolom die moet worden gebruikt voor detectie van zachte verwijdering.
softDeleteMarkerValue	string	De markeringswaarde die aangeeft dat een item is verwijderd.

SqlIntegratedChangeTrackingPolicy

Object

Definieert een beleid voor het detecteren van gegevenswijzigingen waarmee wijzigingen worden vastgelegd met behulp van de functie Geïntegreerde wijziging bijhouden van Azure SQL Database.

Name	Type	Description
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	Een URI-fragment dat het type beleid voor het detecteren van gegevenswijzigingen specificeert.

Delen via

Data Sources - Create Or Update

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Voorbeelden

SearchServiceCreateOrUpdateDataSource

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AzureActiveDirectoryApplicationCredentials

DataSourceCredentials

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HighWaterMarkChangeDetectionPolicy

SearchIndexerDataContainer

SearchIndexerDataSource

SearchIndexerDataSourceType

SearchResourceEncryptionKey

SoftDeleteColumnDeletionDetectionPolicy

SqlIntegratedChangeTrackingPolicy