Data Sources - Create

Dienst:: Search Service

API-Version:: 2025-08-01-preview

Erstellt eine neue Datenquelle.

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

URI-Parameter

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

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 NativeBlobSoftDeleteDeletionDetectionPolicy	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.
identity		SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Eine explizite verwaltete Identität, die für diese Datenquelle verwendet werden soll. Wenn nicht angegeben und es sich bei der Verbindungszeichenfolge um eine verwaltete Identität handelt, wird die systemseitig zugewiesene verwaltete Identität verwendet. Wenn nicht angegeben, bleibt der Wert unverändert. Wenn "none" angegeben ist, wird der Wert dieser Eigenschaft gelöscht.
indexerPermissionOptions		IndexerPermissionOption[]	Erfassungsoptionen mit verschiedenen Arten von Berechtigungsdaten.

Antworten

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

Beispiele

SearchServiceCreateDataSource

Beispielanforderung

HTTP

POST https://previewexampleservice.search.windows.net/datasources?api-version=2025-08-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

Statuscode:: 201

{
  "@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
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.
IndexerPermissionOption	Optionen mit verschiedenen Arten von Berechtigungsdaten zum Indizieren.
NativeBlobSoftDeleteDeletionDetectionPolicy	Definiert eine Richtlinie zur Erkennung von Datenlöschungen, die das native Feature für vorläufiges Löschen von Azure Blob Storage für die Löscherkennung verwendet.
SearchIndexerDataContainer	Stellt Informationen über die Entität (z. B. Azure SQL-Tabelle oder CosmosDB-Sammlung) dar, die indiziert wird.
SearchIndexerDataNoneIdentity	Löscht die Identitätseigenschaft einer Datenquelle.
SearchIndexerDataSource	Stellt eine Datenquellendefinition dar, die zum Konfigurieren eines Indexers verwendet werden kann.
SearchIndexerDataSourceType	Definiert den Typ einer Datenquelle.
SearchIndexerDataUserAssignedIdentity	Gibt die Identität an, die von einer Datenquelle verwendet werden soll.
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. 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.

IndexerPermissionOption

Enumeration

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

Objekt

Definiert eine Richtlinie zur Erkennung von Datenlöschungen, die das native Feature für vorläufiges Löschen von Azure Blob Storage für die Löscherkennung verwendet.

Name	Typ	Beschreibung
@odata.type	string: #Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy	Ein URI-Fragment, das den Typ der Richtlinie zur Erkennung von Datenlöschungen angibt.

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-Datenquelle) oder Sammlung (für CosmosDB-Datenquelle), die indiziert werden soll.
query	string	Eine Abfrage, die auf diesen Datencontainer angewendet wird. Die Syntax und Bedeutung dieses Parameters ist datenquellenspezifisch. Wird von Azure SQL-Datenquellen nicht unterstützt.

SearchIndexerDataNoneIdentity

Objekt

Löscht die Identitätseigenschaft einer Datenquelle.

Name	Typ	Beschreibung
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Ein URI-Fragment, das den Typ der Identität angibt.

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: NativeBlobSoftDeleteDeletionDetectionPolicy 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.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Eine explizite verwaltete Identität, die für diese Datenquelle verwendet werden soll. Wenn nicht angegeben und es sich bei der Verbindungszeichenfolge um eine verwaltete Identität handelt, wird die systemseitig zugewiesene verwaltete Identität verwendet. Wenn nicht angegeben, bleibt der Wert unverändert. Wenn "none" angegeben ist, wird der Wert dieser Eigenschaft gelöscht.
indexerPermissionOptions	IndexerPermissionOption[]	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	SearchIndexerDataSourceType	Der Typ der Datenquelle.

SearchIndexerDataSourceType

Enumeration

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.

SearchIndexerDataUserAssignedIdentity

Objekt

Gibt die Identität an, die von einer Datenquelle verwendet werden soll.

Name	Typ	Beschreibung
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Ein URI-Fragment, das den Typ der Identität angibt.
userAssignedIdentity	string	Die vollqualifizierte Azure-Ressourcen-ID einer benutzerseitig 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 hätte zugewiesen werden sollen.

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.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Eine explizite verwaltete Identität, die für diesen Verschlüsselungsschlüssel verwendet werden soll. Wenn nicht angegeben und die Eigenschaft für die Zugriffsanmeldeinformationen null ist, wird die systemseitig zugewiesene verwaltete Identität verwendet. Wenn die explizite Identität beim Aktualisieren der Ressource nicht angegeben ist, bleibt sie unverändert. Wenn "none" angegeben ist, wird der Wert dieser Eigenschaft gelöscht.
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.