Data Sources - Create Or Update
Hiermee maakt u een nieuwe gegevensbron of werkt u een gegevensbron bij als deze al bestaat.
PUT {endpoint}/datasources('{dataSourceName}')?api-version=2025-08-01-preview
PUT {endpoint}/datasources('{dataSourceName}')?api-version=2025-08-01-preview&ignoreResetRequirements={ignoreResetRequirements}
URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
data
|
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. |
|
ignore
|
query |
boolean |
Negeert de vereisten voor het opnieuw instellen van de cache. |
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 |
De gegevenscontainer voor de gegevensbron. |
|
| credentials | True |
Referenties voor de gegevensbron. |
|
| name | True |
string |
De naam van de gegevensbron. |
| type | True |
Het type gegevensbron. |
|
| @odata.etag |
string |
De ETag van de gegevensbron. |
|
| dataChangeDetectionPolicy | DataChangeDetectionPolicy: |
Het beleid voor het detecteren van gegevenswijzigingen voor de gegevensbron. |
|
| dataDeletionDetectionPolicy | DataDeletionDetectionPolicy: |
Het detectiebeleid voor het verwijderen van gegevens voor de gegevensbron. |
|
| description |
string |
De beschrijving van de gegevensbron. |
|
| encryptionKey |
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. |
||
| identity | SearchIndexerDataIdentity: |
Een expliciete beheerde identiteit die u voor deze gegevensbron kunt gebruiken. Als deze niet is opgegeven en de verbindingsreeks een beheerde identiteit is, wordt de door het systeem toegewezen beheerde identiteit gebruikt. Als dit niet is opgegeven, blijft de waarde ongewijzigd. Als "geen" is opgegeven, wordt de waarde van deze eigenschap gewist. |
|
| indexerPermissionOptions |
Opnameopties met verschillende soorten machtigingsgegevens. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 201 Created | ||
| Other Status Codes |
Foutreactie. |
Voorbeelden
SearchServiceCreateOrUpdateDataSource
Voorbeeldaanvraag
PUT https://previewexampleservice.search.windows.net/datasources('tempdatasource')?api-version=2025-08-01-preview&ignoreResetRequirements=
{
"name": "tempdatasource",
"description": "My Azure Adls Gen2 data source with ACLs.",
"type": "adlsgen2",
"credentials": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net "
},
"container": {
"name": "adls-gen2-doc-extraction-acl",
"query": "folder_has_final_acl"
},
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
},
"indexerPermissionOptions": [
"userIds",
"groupIds",
"rbacScope"
],
"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 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"
},
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
}
}
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "tempdatasource",
"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"
},
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
}
}
Definities
| Name | Description |
|---|---|
|
Azure |
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. |
|
Data |
Vertegenwoordigt referenties die kunnen worden gebruikt om verbinding te maken met een gegevensbron. |
|
Error |
Aanvullende informatie over de resourcebeheerfout. |
|
Error |
De foutdetails. |
|
Error |
Foutreactie |
|
High |
Definieert een beleid voor het detecteren van gegevenswijzigingen waarmee wijzigingen worden vastgelegd op basis van de waarde van een kolom met een hoge watermarkering. |
|
Indexer |
Opties met verschillende soorten machtigingsgegevens om te indexeren. |
|
Native |
Definieert een beleid voor het detecteren van gegevensverwijdering met behulp van de systeemeigen functie voor voorlopig verwijderen van Azure Blob Storage voor het detecteren van verwijdering. |
|
Search |
Vertegenwoordigt informatie over de entiteit (zoals Azure SQL-tabel of CosmosDB-verzameling) die wordt geïndexeerd. |
|
Search |
Hiermee wist u de identiteitseigenschap van een gegevensbron. |
|
Search |
Vertegenwoordigt een gegevensbrondefinitie, die kan worden gebruikt om een indexeerfunctie te configureren. |
|
Search |
Definieert het type gegevensbron. |
|
Search |
Hiermee geeft u de identiteit op voor een gegevensbron die moet worden gebruikt. |
|
Search |
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. |
|
Soft |
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'. |
|
Sql |
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
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
Vertegenwoordigt referenties die kunnen worden gebruikt om verbinding te maken met een gegevensbron.
| Name | Type | Description |
|---|---|---|
| connectionString |
string |
De verbindingsreeks voor de gegevensbron. Stel in op |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
| Name | Type | Description |
|---|---|---|
| info |
object |
De aanvullende informatie. |
| type |
string |
Het extra informatietype. |
ErrorDetail
De foutdetails.
| Name | Type | Description |
|---|---|---|
| additionalInfo |
De fout bevat aanvullende informatie. |
|
| code |
string |
De foutcode. |
| details |
De foutdetails. |
|
| message |
string |
Het foutbericht. |
| target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
| Name | Type | Description |
|---|---|---|
| error |
Het foutobject. |
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.
| Name | Type | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Een URI-fragment dat het type beleid voor het detecteren van gegevenswijzigingen specificeert. |
| highWaterMarkColumnName |
string |
De naam van de hoogwatermerkkolom. |
IndexerPermissionOption
Opties met verschillende soorten machtigingsgegevens om te indexeren.
| Waarde | Description |
|---|---|
| userIds |
Indexeer om ACL userIds op te nemen van gegevensbron naar index. |
| groupIds |
Indexeerfunctie voor het opnemen van ACL groupIds van gegevensbron naar index. |
| rbacScope |
Indexeerfunctie om Azure RBAC-bereik op te nemen van gegevensbron naar index. |
NativeBlobSoftDeleteDeletionDetectionPolicy
Definieert een beleid voor het detecteren van gegevensverwijdering met behulp van de systeemeigen functie voor voorlopig verwijderen van Azure Blob Storage voor het detecteren van verwijdering.
| Name | Type | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Een URI-fragment dat het type detectiebeleid voor gegevensverwijdering specificeert. |
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. Wordt niet ondersteund door Azure SQL-gegevensbronnen. |
SearchIndexerDataNoneIdentity
Hiermee wist u de identiteitseigenschap van een gegevensbron.
| Name | Type | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Een URI-fragment dat het type identiteit specificeert. |
SearchIndexerDataSource
Vertegenwoordigt een gegevensbrondefinitie, die kan worden gebruikt om een indexeerfunctie te configureren.
| Name | Type | Description |
|---|---|---|
| @odata.etag |
string |
De ETag van de gegevensbron. |
| container |
De gegevenscontainer voor de gegevensbron. |
|
| credentials |
Referenties voor de gegevensbron. |
|
| dataChangeDetectionPolicy | DataChangeDetectionPolicy: |
Het beleid voor het detecteren van gegevenswijzigingen voor de gegevensbron. |
| dataDeletionDetectionPolicy | DataDeletionDetectionPolicy: |
Het detectiebeleid voor het verwijderen van gegevens voor de gegevensbron. |
| description |
string |
De beschrijving van de gegevensbron. |
| encryptionKey |
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. |
|
| identity | SearchIndexerDataIdentity: |
Een expliciete beheerde identiteit die u voor deze gegevensbron kunt gebruiken. Als deze niet is opgegeven en de verbindingsreeks een beheerde identiteit is, wordt de door het systeem toegewezen beheerde identiteit gebruikt. Als dit niet is opgegeven, blijft de waarde ongewijzigd. Als "geen" is opgegeven, wordt de waarde van deze eigenschap gewist. |
| indexerPermissionOptions |
Opnameopties met verschillende soorten machtigingsgegevens. |
|
| name |
string |
De naam van de gegevensbron. |
| subType |
string |
Een specifiek type van de gegevensbron, voor het geval de bron in staat is tot verschillende modaliteiten. Bijvoorbeeld 'MongoDb' voor bepaalde 'cosmosDb'-accounts. |
| type |
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. |
SearchIndexerDataUserAssignedIdentity
Hiermee geeft u de identiteit op voor een gegevensbron die moet worden gebruikt.
| Name | Type | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Een URI-fragment dat het type identiteit specificeert. |
| userAssignedIdentity |
string |
De volledig gekwalificeerde Azure-resource-id van een gebruiker waaraan een beheerde identiteit is toegewezen, meestal in de vorm '/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId' die had moeten zijn toegewezen aan de zoekservice. |
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 |
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. |
|
| identity | SearchIndexerDataIdentity: |
Een expliciete beheerde identiteit die u voor deze versleutelingssleutel kunt gebruiken. Als dit niet is opgegeven en de eigenschap toegangsreferenties null is, wordt de door het systeem toegewezen beheerde identiteit gebruikt. Als de expliciete identiteit bij het bijwerken van de resource 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 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 |
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'.
| Name | Type | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
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
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. |
Een URI-fragment dat het type beleid voor het detecteren van gegevenswijzigingen specificeert. |