Data Sources - Create

Hiermee maakt u een nieuwe gegevensbron.

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

URI-parameters

Name In Vereist Type Description
endpoint
path True

string (uri)

De eindpunt-URL van de zoekservice.

api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name Vereist Type Description
Accept

Accept

De Accepteer kop.

x-ms-client-request-id

string (uuid)

Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Aanvraagbody

Name Vereist Type Description
container True

SearchIndexerDataContainer

De gegevenscontainer 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.

credentials.connectionString

string

De verbindingsreeks voor de gegevensbron. 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 verbindingsreeks uit de gegevensbron wilt verwijderen.

dataChangeDetectionPolicy DataChangeDetectionPolicy:

Het detectiebeleid voor gegevenswijziging voor de gegevensbron.

dataDeletionDetectionPolicy DataDeletionDetectionPolicy:

Het detectiebeleid voor gegevensverwijdering voor de gegevensbron.

description

string

De beschrijving van de gegevensbron.

encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. 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. Zodra 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 indien nodig wijzigen als u uw versleutelingssleutel wilt draaien; De definitie van uw gegevensbron wordt niet beïnvloed. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

identity SearchIndexerDataIdentity:

Een expliciete beheerde identiteit die moet worden gebruikt voor deze gegevensbron. Als deze niet is opgegeven en de verbindingsreeks een beheerde identiteit is, wordt de door het systeem toegewezen beheerde identiteit gebruikt. Als deze niet is opgegeven, blijft de waarde ongewijzigd. Als 'geen' is opgegeven, wordt de waarde van deze eigenschap gewist.

Antwoorden

Name Type Description
201 Created

SearchIndexerDataSource

De aanvraag is geslaagd en er is een nieuwe resource gemaakt.

Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Beveiliging

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

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

Voorbeelden

SearchServiceCreateDataSource

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
Accept

De Accepteer kop.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

HighWaterMarkChangeDetectionPolicy

Hiermee definieert u een beleid voor gegevenswijzigingsdetectie waarmee wijzigingen worden vastgelegd op basis van de waarde van een kolom met hoge watermarkeringen.

NativeBlobSoftDeleteDeletionDetectionPolicy

Definieert een beleid voor detectie van gegevensverwijdering met behulp van de systeemeigen functie voor voorlopig verwijderen van Azure Blob Storage voor verwijderingsdetectie.

SearchIndexerDataContainer

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

SearchIndexerDataNoneIdentity

Hiermee wist u de identiteitseigenschap van een gegevensbron.

SearchIndexerDataSource

Vertegenwoordigt een definitie van een gegevensbron, die kan worden gebruikt om een indexeerfunctie te configureren.

SearchIndexerDataSourceType

Definieert het type gegevensbron.

SearchIndexerDataUserAssignedIdentity

Hiermee geeft u de identiteit op voor een gegevensbron die moet worden gebruikt.

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 voorlopig verwijderen wordt geïmplementeerd. Hiermee wordt bepaald of een item moet worden verwijderd op basis van de waarde van een aangewezen kolom voor voorlopig verwijderen.

SqlIntegratedChangeTrackingPolicy

Hiermee definieert u een beleid voor gegevenswijzigingsdetectie waarmee wijzigingen worden vastgelegd met behulp van de geïntegreerde functie Wijzigingen bijhouden van Azure SQL Database.

Accept

De Accepteer kop.

Waarde Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

De aanvullende informatie.

type

string

Het extra informatietype.

ErrorDetail

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 foutdoelwit.

ErrorResponse

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name Type Description
error

ErrorDetail

Het foutobject.

HighWaterMarkChangeDetectionPolicy

Hiermee definieert u een beleid voor gegevenswijzigingsdetectie waarmee wijzigingen worden vastgelegd op basis van de waarde van een kolom met hoge watermarkeringen.

Name Type Description
@odata.type string:

#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy

De discriminator voor afgeleide typen.

highWaterMarkColumnName

string

De naam van de kolom met hoge watermarkeringen.

NativeBlobSoftDeleteDeletionDetectionPolicy

Definieert een beleid voor detectie van gegevensverwijdering met behulp van de systeemeigen functie voor voorlopig verwijderen van Azure Blob Storage voor verwijderingsdetectie.

Name Type Description
@odata.type string:

#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy

De discriminator voor afgeleide typen.

SearchIndexerDataContainer

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) of verzameling (voor CosmosDB-gegevensbron) die wordt geïndexeerd.

query

string

Een query die wordt toegepast op deze gegevenscontainer. De syntaxis en betekenis van deze parameter is specifiek voor de gegevensbron. Niet ondersteund door Azure SQL-gegevensbronnen.

SearchIndexerDataNoneIdentity

Hiermee wist u de identiteitseigenschap van een gegevensbron.

Name Type Description
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

Een URI-fragment dat het type identiteit specificeert.

SearchIndexerDataSource

Vertegenwoordigt een definitie van een gegevensbron, 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.connectionString

string

De verbindingsreeks voor de gegevensbron. 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 verbindingsreeks uit de gegevensbron wilt verwijderen.

dataChangeDetectionPolicy DataChangeDetectionPolicy:

Het detectiebeleid voor gegevenswijziging voor de gegevensbron.

dataDeletionDetectionPolicy DataDeletionDetectionPolicy:

Het detectiebeleid voor gegevensverwijdering voor de gegevensbron.

description

string

De beschrijving van de gegevensbron.

encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. 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. Zodra 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 indien nodig wijzigen als u uw versleutelingssleutel wilt draaien; De definitie van uw gegevensbron wordt niet beïnvloed. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

identity SearchIndexerDataIdentity:

Een expliciete beheerde identiteit die moet worden gebruikt voor deze gegevensbron. Als deze niet is opgegeven en de verbindingsreeks een beheerde identiteit is, wordt de door het systeem toegewezen beheerde identiteit gebruikt. Als deze niet is opgegeven, blijft de waarde ongewijzigd. Als 'geen' is opgegeven, wordt de waarde van deze eigenschap gewist.

name

string

De naam van de gegevensbron.

type

SearchIndexerDataSourceType

Het type gegevensbron.

SearchIndexerDataSourceType

Definieert het type gegevensbron.

Waarde Description
azuresql

Geeft een Azure SQL-gegevensbron aan.

cosmosdb

Geeft een CosmosDB-gegevensbron aan.

azureblob

Geeft een Azure Blob-gegevensbron aan.

azuretable

Geeft een Azure Table-gegevensbron aan.

mysql

Geeft een MySql-gegevensbron aan.

adlsgen2

Geeft een ADLS Gen2-gegevensbron aan.

onelake

Geeft een Microsoft Fabric OneLake-gegevensbron aan.

sharepoint

Geeft een SharePoint-gegevensbron aan.

SearchIndexerDataUserAssignedIdentity

Hiermee geeft u de identiteit op voor een gegevensbron die moet worden gebruikt.

Name Type Description
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

Een URI-fragment dat het type identiteit specificeert.

userAssignedIdentity

string

De volledig gekwalificeerde Azure-resource-id van een door de gebruiker toegewezen beheerde identiteit, meestal in de vorm '/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId' die aan de zoekservice moet zijn toegewezen.

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.

Name Type Description
accessCredentials.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 data-at-rest. De toepassings-id mag niet worden verward met de object-id voor uw AAD-toepassing.

accessCredentials.applicationSecret

string

De verificatiesleutel van de opgegeven AAD-toepassing.

identity SearchIndexerDataIdentity:

Een expliciete beheerde identiteit die moet worden gebruikt voor deze versleutelingssleutel. Als dit niet is opgegeven en de eigenschap toegangsreferenties null is, wordt de door het systeem toegewezen beheerde identiteit gebruikt. Bij het bijwerken van de resource, als de expliciete identiteit niet is opgegeven, blijft deze ongewijzigd. Als 'geen' is opgegeven, wordt de waarde van deze eigenschap gewist.

keyVaultKeyName

string

De naam van uw Azure Key Vault-sleutel die moet worden gebruikt om uw data-at-rest te versleutelen.

keyVaultKeyVersion

string

De versie van uw Azure Key Vault-sleutel die moet worden gebruikt om uw data-at-rest te versleutelen.

keyVaultUri

string

De URI van uw Azure Key Vault, ook wel DNS-naam genoemd, die de sleutel bevat die moet worden gebruikt voor het versleutelen van uw data-at-rest. Een voorbeeld van een URI kan https://my-keyvault-name.vault.azure.netzijn.

SoftDeleteColumnDeletionDetectionPolicy

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

Name Type Description
@odata.type string:

#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy

De discriminator voor afgeleide typen.

softDeleteColumnName

string

De naam van de kolom die moet worden gebruikt voor detectie van voorlopig verwijderen.

softDeleteMarkerValue

string

De markeringswaarde waarmee een item wordt geïdentificeerd als verwijderd.

SqlIntegratedChangeTrackingPolicy

Hiermee definieert u een beleid voor gegevenswijzigingsdetectie waarmee wijzigingen worden vastgelegd met behulp van de geïntegreerde functie Wijzigingen bijhouden van Azure SQL Database.

Name Type Description
@odata.type string:

#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy

De discriminator voor afgeleide typen.