Data Sources - Create

Dienst:: Search Service

API-Version:: 2025-09-01

Erstellt eine neue Datenquelle.

POST {endpoint}/datasources?api-version=2025-09-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Die Endpunkt-URL des Suchdiensts.
api-version	query	True	string	Client-API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string (uuid)	Die Nachverfolgungs-ID, die mit der Anforderung gesendet wird, um das Debuggen zu unterstützen.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
container	True	SearchIndexerDataContainer	Der Datencontainer für die Datenquelle.
credentials	True	DataSourceCredentials	Anmeldeinformationen für die Datenquelle.
name	True	string	Der Name der Datenquelle.
type	True	SearchIndexerDataSourceType	Der Typ der Datenquelle.
@odata.etag		string	Das ETag der Datenquelle.
dataChangeDetectionPolicy		DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Die Richtlinie zur Erkennung von Datenänderungen für die Datenquelle.
dataDeletionDetectionPolicy		DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	Die Richtlinie zur Erkennung von Datenlöschungen für die Datenquelle.
description		string	Die Beschreibung der Datenquelle.
encryptionKey		SearchResourceEncryptionKey	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 Ihren Verschlüsselungsschlüssel rotieren möchten. Ihre Datenquellendefinition ist davon nicht betroffen. Die Verschlüsselung mit kundenseitig verwalteten Schlüsseln ist für kostenlose Suchdienste nicht verfügbar und nur für kostenpflichtige Dienste, die am oder nach dem 1. Januar 2019 erstellt wurden.

Antworten

Name	Typ	Beschreibung
201 Created	SearchIndexerDataSource
Other Status Codes	ErrorResponse	Fehlerantwort.

Beispiele

SearchServiceCreateDataSource

Beispielanforderung

HTTP

POST https://stableexampleservice.search.windows.net/datasources?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"
}

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
AzureActiveDirectoryApplicationCredentials	Anmeldeinformationen einer registrierten Anwendung, die für Ihren Suchdienst erstellt wurde und für den authentifizierten Zugriff auf die in Azure Key Vault gespeicherten Verschlüsselungsschlüssel verwendet wird.
DataSourceCredentials	Stellt Anmeldeinformationen dar, die zum Herstellen einer Verbindung mit einer Datenquelle verwendet werden können.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
HighWaterMarkChangeDetectionPolicy	Definiert eine Richtlinie zur Erkennung von Datenänderungen, die Änderungen basierend auf dem Wert einer oberen Grenze-Spalte erfasst.
SearchIndexerDataContainer	Stellt Informationen über die Entität (z. B. Azure SQL-Tabelle oder CosmosDB-Sammlung) dar, die indiziert wird.
SearchIndexerDataSource	Stellt eine Datenquellendefinition dar, die zum Konfigurieren eines Indexers verwendet werden kann.
SearchIndexerDataSourceType	Definiert den Typ einer Datenquelle.
SearchResourceEncryptionKey	Ein kundenseitig verwalteter Verschlüsselungsschlüssel in 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.
SoftDeleteColumnDeletionDetectionPolicy	Definiert eine Richtlinie zur Erkennung von Datenlöschungen, die eine Strategie für vorläufiges Löschen implementiert. Es bestimmt, ob ein Element basierend auf dem Wert einer bestimmten Spalte für vorläufiges Löschen gelöscht werden soll.
SqlIntegratedChangeTrackingPolicy	Definiert eine Richtlinie zur Erkennung von Datenänderungen, die Änderungen mithilfe der integrierten Änderungsnachverfolgung von Azure SQL-Datenbank erfasst.

AzureActiveDirectoryApplicationCredentials

Objekt

Anmeldeinformationen einer registrierten Anwendung, die für Ihren Suchdienst erstellt wurde und für den authentifizierten Zugriff auf die in Azure Key Vault gespeicherten Verschlüsselungsschlüssel verwendet wird.

Name	Typ	Beschreibung
applicationId	string	Eine AAD-Anwendungs-ID, der die erforderlichen Zugriffsberechtigungen für Azure Key Vault erteilt wurden, die beim Verschlüsseln ruhender Daten verwendet werden soll. Die Anwendungs-ID sollte nicht mit der Objekt-ID für Ihre AAD-Anwendung verwechselt werden.
applicationSecret	string	Der Authentifizierungsschlüssel der angegebenen AAD-Anwendung.

DataSourceCredentials

Objekt

Stellt Anmeldeinformationen dar, die zum Herstellen einer Verbindung mit einer Datenquelle verwendet werden können.

Name	Typ	Beschreibung
connectionString	string	Die Verbindungszeichenfolge für die Datenquelle. Für Azure SQL, Azure Blob, ADLS Gen 2 und Azure Table wäre dies die Verbindungszeichenfolge oder Ressourcen-ID, wenn eine verwaltete Identität verwendet wird. Für CosmosDB wäre dies eine formatierte Verbindungszeichenfolge, die ApiKind oder die Ressourcen-ID für die verwaltete Identität angibt. Für Onelake-Dateien wäre die Verbindungszeichenfolge entweder die Workspace-GUID oder der Workspace-FQDN. Onelake unterstützt nur Verbindungen mit verwalteten Identitäten. Legen Sie diese Option auf `<unchanged>` (mit eckigen Klammern) fest, wenn die Verbindungszeichenfolge nicht aktualisiert werden soll. Legen Sie diese Option fest `<redacted>` , wenn Sie den Wert der Verbindungszeichenfolge aus der Datenquelle entfernen möchten.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

HighWaterMarkChangeDetectionPolicy

Objekt

Definiert eine Richtlinie zur Erkennung von Datenänderungen, die Änderungen basierend auf dem Wert einer oberen Grenze-Spalte erfasst.

Name	Typ	Beschreibung
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	Ein URI-Fragment, das den Typ der Richtlinie zur Erkennung von Datenänderungen angibt.
highWaterMarkColumnName	string	Der Name der Spalte mit dem oberen Grenzwert.

SearchIndexerDataContainer

Objekt

Stellt Informationen über die Entität (z. B. Azure SQL-Tabelle oder CosmosDB-Sammlung) dar, die indiziert wird.

Name	Typ	Beschreibung
name	string	Der Name der Tabelle oder Sicht (für Azure SQL-Datenquellen), der Sammlung (für CosmosDB-Datenquellen), des Containers (für Azure Blob- und ADLS Gen 2-Datenquellen), der Azure-Tabelle (für die Azure-Tabellendatenquelle) oder des Lakehouse (für die Onelake-Datenquelle), die indiziert werden sollen.
query	string	Eine Abfrage, die auf diesen Datencontainer angewendet wird. Für die CosmosDB-Datenquellenabfrage können Daten vereinfacht und gefiltert werden. Für Azure Blob und ADLS Gen 2 kann die Abfrage nach Ordnern filtern. Für die Azure-Tabellenabfrage kann nach Zeilendaten gefiltert werden. Für Onelake-Abfragen kann nach Ordner oder Verknüpfung gefiltert werden. Wird von Azure SQL-Datenquellen nicht unterstützt.

SearchIndexerDataSource

Objekt

Stellt eine Datenquellendefinition dar, die zum Konfigurieren eines Indexers verwendet werden kann.

Name	Typ	Beschreibung
@odata.etag	string	Das ETag der Datenquelle.
container	SearchIndexerDataContainer	Der Datencontainer für die Datenquelle.
credentials	DataSourceCredentials	Anmeldeinformationen für die Datenquelle.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Die Richtlinie zur Erkennung von Datenänderungen für die Datenquelle.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	Die Richtlinie zur Erkennung von Datenlöschungen für die Datenquelle.
description	string	Die Beschreibung der Datenquelle.
encryptionKey	SearchResourceEncryptionKey	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 Ihren Verschlüsselungsschlüssel rotieren möchten. Ihre Datenquellendefinition ist davon nicht betroffen. Die Verschlüsselung mit kundenseitig verwalteten Schlüsseln ist für kostenlose Suchdienste nicht verfügbar und nur für kostenpflichtige Dienste, die am oder nach dem 1. Januar 2019 erstellt wurden.
name	string	Der Name der Datenquelle.
type	SearchIndexerDataSourceType	Der Typ der Datenquelle.

SearchIndexerDataSourceType

Enumeration

Definiert den Typ einer Datenquelle.

Wert	Beschreibung
azuresql	Definition einer Azure SQL-Datenquelle, deren Anmeldeinformationen entweder eine standardmäßige SQL-Verbindungszeichenfolge oder die ResourceId der SQL-Ressource sein können. Die Containereigenschaft bezieht sich auf die Tabelle oder Sicht, die indiziert werden soll. Der Abfrageparameter wird für diese Datenquelle nicht unterstützt.
cosmosdb	Definition einer CosmosDB-Datenquelle, deren Anmeldeinformationen entweder eine formatierte Verbindungszeichenfolge mit Details für AccountEndpoint, AccountKey und Database für eine schlüsselbasierte Verbindung oder Details für ResourceID und ApiKind für eine schlüssellose Verbindung sein können. Die container-Eigenschaft verweist auf die cosmosdb-Sammlung, die indiziert werden soll, und die optionale query-Eigenschaft verweist auf eine SQL-Abfrage für die Sammlung.
azureblob	Definition einer Azure Blob-Datenquelle, deren Anmeldeinformationen entweder eine Speicherverbindungszeichenfolge oder die ResourceId des Speicherkontos sein können. Die container-Eigenschaft bezieht sich auf den zu indizierenden Blob-Container, und die optionale query-Eigenschaft verweist auf einen bestimmten Unterordner im Container.
azuretable	Definition einer Azure-Tabellendatenquelle, deren Anmeldeinformationen entweder eine Tabellenverbindungszeichenfolge oder die ResourceId des Speicherkontos sein können. Die container-Eigenschaft bezieht sich auf den Blob-Container, der indiziert werden soll, und die optionale query-Eigenschaft kann zum Filtern von Zeilen verwendet werden.
mysql	Definition einer Azure SQL-Datenquelle, deren Anmeldeinformationen entweder eine standardmäßige ADO.NET formatierte SQL-Verbindungszeichenfolge oder die ResourceId der SQL-Ressource sein können. Die Containereigenschaft bezieht sich auf die Tabelle oder Sicht, die indiziert werden soll. Der Abfrageparameter wird für diese Datenquelle nicht unterstützt.
adlsgen2	Definition einer Azure ADLS Gen 2-Datenquelle, deren Anmeldeinformationen entweder eine Speicherverbindungszeichenfolge oder die ResourceId des Speicherkontos sein können. Die container-Eigenschaft bezieht sich auf den zu indizierenden Blob-Container, und die optionale query-Eigenschaft verweist auf einen bestimmten Unterordner im Container.
onelake	Definition einer Microsoft Fabric Onelake-Datenquelle, deren Anmeldeinformationen entweder die Fabric-Arbeitsbereichs-GUID oder ein Arbeitsbereichs-FQDN sein können. Die container-Eigenschaft bezieht sich auf die Lakehouse-GUID, und die optionale query-Eigenschaft bezieht sich auf Ordner oder Verknüpfungen im Lakehouse.

SearchResourceEncryptionKey

Objekt

Ein kundenseitig verwalteter Verschlüsselungsschlüssel in 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	Beschreibung
accessCredentials	AzureActiveDirectoryApplicationCredentials	Optionale Azure Active Directory-Anmeldeinformationen, die für den Zugriff auf Ihren Azure Key Vault verwendet werden. Nicht erforderlich, wenn stattdessen eine verwaltete Identität verwendet wird.
keyVaultKeyName	string	Der Name Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln ruhender Daten verwendet werden soll.
keyVaultKeyVersion	string	Die Version Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln ruhender Daten verwendet werden soll.
keyVaultUri	string	Der URI Ihres Azure Key Vault-Postfachs, der auch als DNS-Name bezeichnet wird und den Schlüssel enthält, der zum Verschlüsseln ruhender Daten verwendet werden soll. Ein Beispiel-URI könnte sein `https://my-keyvault-name.vault.azure.net`.

SoftDeleteColumnDeletionDetectionPolicy

Objekt

Definiert eine Richtlinie zur Erkennung von Datenlöschungen, die eine Strategie für vorläufiges Löschen implementiert. Es bestimmt, ob ein Element basierend auf dem Wert einer bestimmten Spalte für vorläufiges Löschen gelöscht werden soll.

Name	Typ	Beschreibung
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	Ein URI-Fragment, das den Typ der Richtlinie zur Erkennung von Datenlöschungen angibt.
softDeleteColumnName	string	Der Name der Spalte, die für die Erkennung des vorläufigen Löschens verwendet werden soll.
softDeleteMarkerValue	string	Der Markierungswert, der ein Element als gelöscht kennzeichnet.

SqlIntegratedChangeTrackingPolicy

Objekt

Definiert eine Richtlinie zur Erkennung von Datenänderungen, die Änderungen mithilfe der integrierten Änderungsnachverfolgung von Azure SQL-Datenbank erfasst.

Name	Typ	Beschreibung
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	Ein URI-Fragment, das den Typ der Richtlinie zur Erkennung von Datenänderungen angibt.

Freigeben über

Data Sources - Create

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Beispiele

SearchServiceCreateDataSource

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AzureActiveDirectoryApplicationCredentials

DataSourceCredentials

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HighWaterMarkChangeDetectionPolicy

SearchIndexerDataContainer

SearchIndexerDataSource

SearchIndexerDataSourceType

SearchResourceEncryptionKey

SoftDeleteColumnDeletionDetectionPolicy

SqlIntegratedChangeTrackingPolicy