Data Sources - Create
Erstellt eine neue Datenquelle.
POST {endpoint}/datasources?api-version=2026-05-01-preview
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Die Endpunkt-URL des Suchdiensts. |
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Accept |
Die Überschrift "Annehmen". |
||
| x-ms-client-request-id |
string (uuid) |
Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung. |
Anforderungstext
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| container | True |
Der Datencontainer für die Datenquelle. |
|
| name | True |
string |
Der Name der Datenquelle. |
| type | True |
Der Typ der Datenquelle. |
|
| @odata.etag |
string |
Das ETag der Datenquelle. |
|
| credentials.connectionString |
string |
Die Verbindungszeichenfolge für die Datenquelle. Legen Sie diese Option auf |
|
| dataChangeDetectionPolicy | DataChangeDetectionPolicy: |
Die Datenänderungserkennungsrichtlinie für die Datenquelle. |
|
| dataDeletionDetectionPolicy | DataDeletionDetectionPolicy: |
Die Datenlöscherkennungsrichtlinie für die Datenquelle. |
|
| description |
string |
Die Beschreibung der Datenquelle. |
|
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel wird verwendet, um eine zusätzliche Ebene der Verschlüsselung ruhender Daten für Ihre Datenquellendefinition bereitzustellen, wenn Sie vollständig sicherstellen möchten, dass niemand, nicht einmal Microsoft, Ihre Datenquellendefinition entschlüsseln kann. Nachdem Sie Ihre Datenquellendefinition verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Sie können diese Eigenschaft nach Bedarf ändern, wenn Sie den Verschlüsselungsschlüssel drehen möchten. Ihre Datenquellendefinition ist davon unberührt. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
||
| identity | SearchIndexerDataIdentity: |
Eine explizite verwaltete Identität, die für diese Datenquelle verwendet werden soll. Wenn sie nicht angegeben ist und die Verbindungszeichenfolge eine verwaltete Identität ist, wird die vom System zugewiesene verwaltete Identität verwendet. Wenn nicht angegeben, bleibt der Wert unverändert. Wenn "none" angegeben wird, wird der Wert dieser Eigenschaft gelöscht. |
|
| indexerPermissionOptions |
Erfassungsoptionen mit verschiedenen Arten von Berechtigungsdaten. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 201 Created |
Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt. |
|
| Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
api-key
Typ:
apiKey
In:
header
OAuth2Auth
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| https://search.azure.com/.default |
Beispiele
SearchServiceCreateDataSource
Beispielanforderung
POST https://previewexampleservice.search.windows.net/datasources?api-version=2026-05-01-preview
{
"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"
}
Beispiel für eine Antwort
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "tempdatasource",
"description": "My Azure Blob data source.",
"type": "azureblob",
"indexerPermissionOptions": [],
"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"
}
}
Definitionen
| Name | Beschreibung |
|---|---|
| Accept |
Die Überschrift "Annehmen". |
|
Error |
Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung. |
|
Error |
Die Fehlerdetails. |
|
Error |
Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.) |
|
High |
Definiert eine Datenänderungserkennungsrichtlinie, die Änderungen basierend auf dem Wert einer Wasserzeichenspalte erfasst. |
|
Indexer |
Optionen mit verschiedenen Arten von Berechtigungsdaten zum Indizieren. |
|
Native |
Definiert eine Datenlöscherkennungsrichtlinie, die das systemeigene Feature für das vorläufige Löschen von Azure Blob Storage für die Löscherkennung verwendet. |
|
Search |
Stellt Informationen zur Entität (z. B. Azure SQL-Tabelle oder CosmosDB-Auflistung) dar, die indiziert wird. |
|
Search |
Löscht die Identitätseigenschaft einer Datenquelle. |
|
Search |
Stellt eine Datenquellendefinition dar, die zum Konfigurieren eines Indexers verwendet werden kann. |
|
Search |
Definiert den Typ einer Datenquelle. |
|
Search |
Gibt die Identität für eine zu verwendende Datenquelle an. |
|
Search |
Ein vom Kunden verwalteter Verschlüsselungsschlüssel im Azure Key Vault. Schlüssel, die Sie erstellen und verwalten, können zum Verschlüsseln oder Entschlüsseln ruhender Daten verwendet werden, z. B. Indizes und Synonymzuordnungen. |
|
Soft |
Definiert eine Datenlöscherkennungsrichtlinie, die eine Strategie für das vorläufige Löschen implementiert. Es bestimmt, ob ein Element basierend auf dem Wert einer festgelegten Spalte "vorläufiges Löschen" gelöscht werden soll. |
|
Sql |
Definiert eine Datenänderungserkennungsrichtlinie, die Änderungen mithilfe des Integrierten Änderungsnachverfolgungsfeatures von Azure SQL-Datenbank erfasst. |
Accept
Die Überschrift "Annehmen".
| Wert | Beschreibung |
|---|---|
| application/json;odata.metadata=minimal |
ErrorAdditionalInfo
Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.
| Name | Typ | Beschreibung |
|---|---|---|
| info |
Zusätzliche Informationen. |
|
| type |
string |
Typ der Zusatzinformationen. |
ErrorDetail
Die Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| additionalInfo |
Die Zusatzinformationen zum Fehler. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Der Fehlerzielwert. |
ErrorResponse
Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerobjekt. |
HighWaterMarkChangeDetectionPolicy
Definiert eine Datenänderungserkennungsrichtlinie, die Änderungen basierend auf dem Wert einer Wasserzeichenspalte erfasst.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Der Diskriminator für abgeleitete Typen. |
| highWaterMarkColumnName |
string |
Der Name der Spalte "Hohe Wassermarke". |
IndexerPermissionOption
Optionen mit verschiedenen Arten von Berechtigungsdaten zum Indizieren.
| Wert | Beschreibung |
|---|---|
| userIds |
Indexer zum Erfassen von ACL-Benutzer-IDs aus der Datenquelle in den Index. |
| groupIds |
Indexer zum Erfassen von ACL-GroupIds aus der Datenquelle in den Index. |
| rbacScope |
Indexer zum Erfassen des Azure RBAC-Bereichs von der Datenquelle in den Index. |
NativeBlobSoftDeleteDeletionDetectionPolicy
Definiert eine Datenlöscherkennungsrichtlinie, die das systemeigene Feature für das vorläufige Löschen von Azure Blob Storage für die Löscherkennung verwendet.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Der Diskriminator für abgeleitete Typen. |
SearchIndexerDataContainer
Stellt Informationen zur Entität (z. B. Azure SQL-Tabelle oder CosmosDB-Auflistung) dar, die indiziert wird.
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
Der Name der Tabelle oder Ansicht (für Azure SQL-Datenquelle) oder Sammlung (für CosmosDB-Datenquelle), die indiziert wird. |
| query |
string |
Eine Abfrage, die auf diesen Datencontainer angewendet wird. Die Syntax und Bedeutung dieses Parameters ist datenquellenspezifisch. Von Azure SQL-Datenquellen nicht unterstützt. |
SearchIndexerDataNoneIdentity
Löscht die Identitätseigenschaft einer Datenquelle.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Ein URI-Fragment, das den Typ der Identität angibt. |
SearchIndexerDataSource
Stellt eine Datenquellendefinition dar, die zum Konfigurieren eines Indexers verwendet werden kann.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.etag |
string |
Das ETag der Datenquelle. |
| container |
Der Datencontainer für die Datenquelle. |
|
| credentials.connectionString |
string |
Die Verbindungszeichenfolge für die Datenquelle. Legen Sie diese Option auf |
| dataChangeDetectionPolicy | DataChangeDetectionPolicy: |
Die Datenänderungserkennungsrichtlinie für die Datenquelle. |
| dataDeletionDetectionPolicy | DataDeletionDetectionPolicy: |
Die Datenlöscherkennungsrichtlinie für die Datenquelle. |
| description |
string |
Die Beschreibung der Datenquelle. |
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel wird verwendet, um eine zusätzliche Ebene der Verschlüsselung ruhender Daten für Ihre Datenquellendefinition bereitzustellen, wenn Sie vollständig sicherstellen möchten, dass niemand, nicht einmal Microsoft, Ihre Datenquellendefinition entschlüsseln kann. Nachdem Sie Ihre Datenquellendefinition verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Sie können diese Eigenschaft nach Bedarf ändern, wenn Sie den Verschlüsselungsschlüssel drehen möchten. Ihre Datenquellendefinition ist davon unberührt. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
|
| identity | SearchIndexerDataIdentity: |
Eine explizite verwaltete Identität, die für diese Datenquelle verwendet werden soll. Wenn sie nicht angegeben ist und die Verbindungszeichenfolge eine verwaltete Identität ist, wird die vom System zugewiesene verwaltete Identität verwendet. Wenn nicht angegeben, bleibt der Wert unverändert. Wenn "none" angegeben wird, wird der Wert dieser Eigenschaft gelöscht. |
| indexerPermissionOptions |
Erfassungsoptionen mit verschiedenen Arten von Berechtigungsdaten. |
|
| name |
string |
Der Name der Datenquelle. |
| subType |
string |
Ein bestimmter Typ der Datenquelle, falls die Ressource zu verschiedenen Modalitäten fähig ist. Beispiel: "MongoDb" für bestimmte "cosmosDb"-Konten. |
| type |
Der Typ der Datenquelle. |
SearchIndexerDataSourceType
Definiert den Typ einer Datenquelle.
| Wert | Beschreibung |
|---|---|
| azuresql |
Gibt eine Azure SQL-Datenquelle an. |
| cosmosdb |
Gibt eine CosmosDB-Datenquelle an. |
| azureblob |
Gibt eine Azure Blob-Datenquelle an. |
| azuretable |
Gibt eine Azure-Tabellendatenquelle an. |
| mysql |
Gibt eine MySql-Datenquelle an. |
| adlsgen2 |
Gibt eine ADLS Gen2-Datenquelle an. |
| onelake |
Gibt eine Microsoft Fabric OneLake-Datenquelle an. |
| sharepoint |
Gibt eine SharePoint-Datenquelle an. |
SearchIndexerDataUserAssignedIdentity
Gibt die Identität für eine zu verwendende Datenquelle an.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Ein URI-Fragment, das den Typ der Identität angibt. |
| federatedIdentityClientId |
string |
Multi-Tenant User-Assigned Managed Identity Support: Die Client-ID der Multi-Tentant-App, die so konfiguriert wurde, dass sie mit der vom Benutzer zugewiesenen verwalteten Identität föderiert. |
| userAssignedIdentity |
string |
Die vollqualifizierte Azure-Ressourcen-ID einer vom Benutzer zugewiesenen verwalteten Identität in der Regel im Format "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", die dem Suchdienst zugewiesen werden sollen. |
SearchResourceEncryptionKey
Ein vom Kunden verwalteter Verschlüsselungsschlüssel im Azure Key Vault. Schlüssel, die Sie erstellen und verwalten, können zum Verschlüsseln oder Entschlüsseln ruhender Daten verwendet werden, z. B. Indizes und Synonymzuordnungen.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| accessCredentials.applicationId |
string |
Eine AAD-Anwendungs-ID, die die erforderlichen Zugriffsberechtigungen für den Azure Key Vault erteilt hat, die beim Verschlüsseln Ihrer ruhenden Daten verwendet werden sollen. Die Anwendungs-ID sollte nicht mit der Objekt-ID für Ihre AAD-Anwendung verwechselt werden. |
|
| accessCredentials.applicationSecret |
string |
Der Authentifizierungsschlüssel der angegebenen AAD-Anwendung. |
|
| identity | SearchIndexerDataIdentity: |
Eine explizite verwaltete Identität, die für diesen Verschlüsselungsschlüssel verwendet werden soll. Wenn diese Eigenschaft nicht angegeben ist und die Eigenschaft für Zugriffsanmeldeinformationen null ist, wird die vom System zugewiesene verwaltete Identität verwendet. Wenn die explizite Identität nicht angegeben ist, bleibt die Aktualisierung der Ressource unverändert. Wenn "none" angegeben wird, wird der Wert dieser Eigenschaft gelöscht. |
|
| isServiceLevelKey |
boolean |
False |
Ein optionaler Wert, der angibt, ob dieser Schlüssel ein Service-Level-Schlüssel ist. Die Standardeinstellung ist "false". |
| keyVaultKeyName |
string |
Der Name Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll. |
|
| keyVaultKeyVersion |
string |
Die Version Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll. |
|
| keyVaultUri |
string |
Der URI Ihres Azure Key Vault, auch als DNS-Name bezeichnet, der den Schlüssel enthält, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll. Ein Beispiel-URI kann |
SoftDeleteColumnDeletionDetectionPolicy
Definiert eine Datenlöscherkennungsrichtlinie, die eine Strategie für das vorläufige Löschen implementiert. Es bestimmt, ob ein Element basierend auf dem Wert einer festgelegten Spalte "vorläufiges Löschen" gelöscht werden soll.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Der Diskriminator für abgeleitete Typen. |
| softDeleteColumnName |
string |
Der Name der Spalte, die für die Erkennung vorläufiger Löschungen verwendet werden soll. |
| softDeleteMarkerValue |
string |
Der Markierungswert, der ein Element als gelöscht identifiziert. |
SqlIntegratedChangeTrackingPolicy
Definiert eine Datenänderungserkennungsrichtlinie, die Änderungen mithilfe des Integrierten Änderungsnachverfolgungsfeatures von Azure SQL-Datenbank erfasst.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Der Diskriminator für abgeleitete Typen. |