Data Sources - Create

Usługa:: Search Service

Wersja interfejsu API:: 2025-09-01

Tworzy nowe źródło danych.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Adres URL punktu końcowego usługi wyszukiwania.
api-version	query	True	string	Wersja interfejsu API klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string (uuid)	Identyfikator śledzenia wysłany z żądaniem, aby pomóc w debugowaniu.

Treść żądania

Nazwa	Wymagane	Typ	Opis
container	True	SearchIndexerDataContainer	Kontener danych dla źródła danych.
credentials	True	DataSourceCredentials	Poświadczenia źródła danych.
name	True	string	Nazwa źródła danych.
type	True	SearchIndexerDataSourceType	Typ źródła danych.
@odata.etag		string	Element ETag źródła danych.
dataChangeDetectionPolicy		DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Zasady wykrywania zmian danych dla źródła danych.
dataDeletionDetectionPolicy		DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	Zasady wykrywania usuwania danych dla źródła danych.
description		string	Opis źródła danych.
encryptionKey		SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania magazynowanego dla definicji źródła danych, gdy chcesz mieć pełną pewność, że nikt, nawet firma Microsoft, nie może odszyfrować definicji źródła danych. Po zaszyfrowaniu definicji źródła danych zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość zgodnie z potrzebami, jeśli chcesz obrócić klucz szyfrowania; Nie będzie to miało wpływu na definicję źródła danych. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne w przypadku bezpłatnych usług wyszukiwania i jest dostępne tylko w przypadku płatnych usług utworzonych 1 stycznia 2019 r. lub później.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	SearchIndexerDataSource
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Przykłady

SearchServiceCreateDataSource

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Definicje

Nazwa	Opis
AzureActiveDirectoryApplicationCredentials	Poświadczenia zarejestrowanej aplikacji utworzonej dla usługi wyszukiwania, używanej do uwierzytelnionego dostępu do kluczy szyfrowania przechowywanych w usłudze Azure Key Vault.
DataSourceCredentials	Reprezentuje poświadczenia, których można użyć do nawiązania połączenia ze źródłem danych.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
HighWaterMarkChangeDetectionPolicy	Definiuje zasady wykrywania zmian danych, które przechwytują zmiany na podstawie wartości kolumny znacznika górnego limitu.
SearchIndexerDataContainer	Reprezentuje informacje o jednostce (takiej jak tabela Azure SQL lub kolekcja CosmosDB), która zostanie zindeksowana.
SearchIndexerDataSource	Reprezentuje definicję źródła danych, której można użyć do skonfigurowania indeksatora.
SearchIndexerDataSourceType	Definiuje typ źródła danych.
SearchResourceEncryptionKey	Klucz szyfrowania zarządzany przez klienta w usłudze Azure Key Vault. Klucze, które tworzysz i którymi zarządzasz, mogą służyć do szyfrowania lub odszyfrowywania danych magazynowanych, takich jak indeksy i mapy synonimów.
SoftDeleteColumnDeletionDetectionPolicy	Definiuje zasady wykrywania usuwania danych, które implementują strategię usuwania nietrwałego. Określa, czy element powinien zostać usunięty, na podstawie wartości wyznaczonej kolumny "usuwanie nietrwałe".
SqlIntegratedChangeTrackingPolicy	Definiuje zasady wykrywania zmian danych, które przechwytują zmiany przy użyciu funkcji zintegrowanego śledzenia zmian Azure SQL Database.

AzureActiveDirectoryApplicationCredentials

Objekt

Poświadczenia zarejestrowanej aplikacji utworzonej dla usługi wyszukiwania, używanej do uwierzytelnionego dostępu do kluczy szyfrowania przechowywanych w usłudze Azure Key Vault.

Nazwa	Typ	Opis
applicationId	string	Identyfikator aplikacji usługi AAD, któremu udzielono wymaganych uprawnień dostępu do usługi Azure Key Vault, który ma być używany podczas szyfrowania danych magazynowanych. Identyfikatora aplikacji nie należy mylić z identyfikatorem obiektu aplikacji usługi AAD.
applicationSecret	string	Klucz uwierzytelniania określonej aplikacji usługi AAD.

DataSourceCredentials

Objekt

Reprezentuje poświadczenia, których można użyć do nawiązania połączenia ze źródłem danych.

Nazwa	Typ	Opis
connectionString	string	Parametry połączenia dla źródła danych. W przypadku Azure SQL, Azure Blob, ADLS Gen 2 i Azure Table będzie to parametry połączenia lub identyfikator zasobu w przypadku korzystania z tożsamości zarządzanej. W przypadku usługi CosmosDB będą to sformatowane parametry połączenia określające ApiKind lub identyfikator zasobu dla tożsamości zarządzanej. W przypadku plików Onelake parametry połączenia będą identyfikatorem GUID obszaru roboczego lub nazwą FQDN obszaru roboczego; Onelake obsługuje tylko połączenia tożsamości zarządzanej. Ustaw wartość `<unchanged>` (w nawiasach), jeśli nie chcesz, aby parametry połączenia były aktualizowane. Ustaw na `<redacted>` , jeśli chcesz usunąć wartość parametrów połączenia ze źródła danych.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

HighWaterMarkChangeDetectionPolicy

Objekt

Definiuje zasady wykrywania zmian danych, które przechwytują zmiany na podstawie wartości kolumny znacznika górnego limitu.

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	Fragment identyfikatora URI określający typ zasad wykrywania zmian danych.
highWaterMarkColumnName	string	Nazwa kolumny znaku wysokiej wody.

SearchIndexerDataContainer

Objekt

Reprezentuje informacje o jednostce (takiej jak tabela Azure SQL lub kolekcja CosmosDB), która zostanie zindeksowana.

Nazwa	Typ	Opis
name	string	Nazwa tabeli lub widoku (dla źródła danych Azure SQL), kolekcji (dla źródła danych CosmosDB), kontenera (dla źródeł danych Azure Blob i ADLS Gen 2), tabeli platformy Azure (dla źródła danych tabeli platformy Azure) lub repozytorium lakehouse (dla źródła danych Onelake), który zostanie zindeksowany.
query	string	Zapytanie, które jest stosowane do tego kontenera danych. W przypadku źródła danych CosmosDB zapytanie może spłaszczać i filtrować dane. W przypadku usług Azure Blob i ADLS Gen 2 zapytanie można filtrować według folderów. W przypadku zapytania tabeli platformy Azure można filtrować według danych wiersza. W przypadku zapytania Onelake można filtrować według folderu lub skrótu. Nie jest obsługiwane przez źródła danych Azure SQL.

SearchIndexerDataSource

Objekt

Reprezentuje definicję źródła danych, której można użyć do skonfigurowania indeksatora.

Nazwa	Typ	Opis
@odata.etag	string	Element ETag źródła danych.
container	SearchIndexerDataContainer	Kontener danych dla źródła danych.
credentials	DataSourceCredentials	Poświadczenia źródła danych.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Zasady wykrywania zmian danych dla źródła danych.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	Zasady wykrywania usuwania danych dla źródła danych.
description	string	Opis źródła danych.
encryptionKey	SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania magazynowanego dla definicji źródła danych, gdy chcesz mieć pełną pewność, że nikt, nawet firma Microsoft, nie może odszyfrować definicji źródła danych. Po zaszyfrowaniu definicji źródła danych zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość zgodnie z potrzebami, jeśli chcesz obrócić klucz szyfrowania; Nie będzie to miało wpływu na definicję źródła danych. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne w przypadku bezpłatnych usług wyszukiwania i jest dostępne tylko w przypadku płatnych usług utworzonych 1 stycznia 2019 r. lub później.
name	string	Nazwa źródła danych.
type	SearchIndexerDataSourceType	Typ źródła danych.

SearchIndexerDataSourceType

Wyliczanie

Definiuje typ źródła danych.

Wartość	Opis
azuresql	Definicja źródła danych Azure SQL, którego poświadczenia mogą być standardowymi parametrami połączenia SQL lub identyfikatorem ResourceId zasobu SQL. Właściwość container odwołuje się do tabeli lub widoku, który ma być indeksowany. Parametr zapytania nie jest obsługiwany dla tego źródła danych.
cosmosdb	Definicja źródła danych CosmosDB, którego poświadczenia mogą być sformatowanymi parametrami połączenia zawierającymi szczegóły dla AccountEndpoint, AccountKey i Database dla połączenia opartego na kluczu lub szczegóły dla ResourceID i ApiKind dla połączenia bez klucza. Właściwość container odwołuje się do kolekcji cosmosdb, która ma być indeksowana, a opcjonalna właściwość zapytania odwołuje się do zapytania SQL w kolekcji.
azureblob	Definicja źródła danych obiektu blob platformy Azure, którego poświadczenia mogą być parametrami połączenia magazynu lub identyfikatorem ResourceId konta magazynu. Właściwość container odwołuje się do kontenera obiektów blob, który ma być indeksowany, a opcjonalna właściwość zapytania odwołuje się do określonego podfolderu w kontenerze.
azuretable	Definicja źródła danych tabeli platformy Azure, którego poświadczenia mogą być parametrami połączenia tabeli lub identyfikatorem ResourceId konta magazynu. Właściwość container odwołuje się do kontenera obiektów blob, który ma być indeksowany, a opcjonalna właściwość zapytania może służyć do filtrowania wierszy.
mysql	Definicja źródła danych Azure SQL, którego poświadczenia mogą być standardowymi ADO.NET sformatowanymi parametrami połączenia SQL lub identyfikatorem ResourceId zasobu SQL. Właściwość container odwołuje się do tabeli lub widoku, który ma być indeksowany. Parametr zapytania nie jest obsługiwany dla tego źródła danych.
adlsgen2	Definicja źródła danych usługi Azure ADLS Gen 2, którego poświadczenia mogą być parametrami połączenia magazynu lub identyfikatorem ResourceId konta magazynu. Właściwość container odwołuje się do kontenera obiektów blob, który ma być indeksowany, a opcjonalna właściwość zapytania odwołuje się do określonego podfolderu w kontenerze.
onelake	Definicja źródła danych usługi Microsoft Fabric Onelake, którego poświadczenia mogą być identyfikatorem GUID obszaru roboczego sieci szkieletowej lub nazwą FQDN obszaru roboczego. Właściwość container odwołuje się do identyfikatora GUID usługi lakehouse, a opcjonalna właściwość zapytania odwołuje się do folderów lub skrótów w usłudze lakehouse.

SearchResourceEncryptionKey

Objekt

Klucz szyfrowania zarządzany przez klienta w usłudze Azure Key Vault. Klucze, które tworzysz i którymi zarządzasz, mogą służyć do szyfrowania lub odszyfrowywania danych magazynowanych, takich jak indeksy i mapy synonimów.

Nazwa	Typ	Opis
accessCredentials	AzureActiveDirectoryApplicationCredentials	Opcjonalne poświadczenia usługi Azure Active Directory używane do uzyskiwania dostępu do usługi Azure Key Vault. Nie jest to wymagane, jeśli zamiast tego używasz tożsamości zarządzanej.
keyVaultKeyName	string	Nazwa klucza usługi Azure Key Vault, który ma być używany do szyfrowania danych magazynowanych.
keyVaultKeyVersion	string	Wersja klucza usługi Azure Key Vault, która ma być używana do szyfrowania danych magazynowanych.
keyVaultUri	string	Identyfikator URI usługi Azure Key Vault, nazywany również nazwą DNS, który zawiera klucz, który ma być używany do szyfrowania danych magazynowanych. Przykładowym identyfikatorem URI może być `https://my-keyvault-name.vault.azure.net`.

SoftDeleteColumnDeletionDetectionPolicy

Objekt

Definiuje zasady wykrywania usuwania danych, które implementują strategię usuwania nietrwałego. Określa, czy element powinien zostać usunięty, na podstawie wartości wyznaczonej kolumny "usuwanie nietrwałe".

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	Fragment identyfikatora URI określający typ zasad wykrywania usuwania danych.
softDeleteColumnName	string	Nazwa kolumny, która ma być używana do wykrywania usuwania nietrwałego.
softDeleteMarkerValue	string	Wartość znacznika identyfikująca element jako usunięty.

SqlIntegratedChangeTrackingPolicy

Objekt

Definiuje zasady wykrywania zmian danych, które przechwytują zmiany przy użyciu funkcji zintegrowanego śledzenia zmian Azure SQL Database.

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	Fragment identyfikatora URI określający typ zasad wykrywania zmian danych.

Udostępnij przez

Data Sources - Create

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Przykłady

SearchServiceCreateDataSource

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AzureActiveDirectoryApplicationCredentials

DataSourceCredentials

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HighWaterMarkChangeDetectionPolicy

SearchIndexerDataContainer

SearchIndexerDataSource

SearchIndexerDataSourceType

SearchResourceEncryptionKey

SoftDeleteColumnDeletionDetectionPolicy

SqlIntegratedChangeTrackingPolicy