Data Sources - List

Szolgáltatás:: Search Service

API-verzió:: 2023-11-01

A keresési szolgáltatáshoz elérhető összes adatforrás listája.

GET {endpoint}/datasources?api-version=2023-11-01

Opcionális paraméterekkel:

GET {endpoint}/datasources?$select={$select}&api-version=2023-11-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A keresési szolgáltatás végponti URL-címe.
api-version	query	True	string	Ügyfél API-verziója.
$select	query		string	Kiválasztja a lekérni kívánt adatforrások legfelső szintű tulajdonságait. JSON-tulajdonságnevek vesszővel tagolt listájaként van megadva, vagy `*` az összes tulajdonsághoz. Az alapértelmezett érték az összes tulajdonság.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	A kéréssel együtt küldött nyomkövetési azonosító, amely segít a hibakeresésben.

Válaszok

Name	Típus	Description
200 OK	ListDataSourcesResult
Other Status Codes	SearchError	Hibaválasz.

Példák

SearchServiceListDataSources

Mintakérelem

HTTP

GET https://myservice.search.windows.net/datasources?$select=*&api-version=2023-11-01

Mintaválasz

Állapotkód:: 200

{
  "value": [
    {
      "name": "mydocdbdatasource",
      "description": "My Cosmos DB data source.",
      "type": "cosmosdb",
      "credentials": {
        "connectionString": null
      },
      "container": {
        "name": "myDocDbCollectionId",
        "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts"
      },
      "dataChangeDetectionPolicy": {
        "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy",
        "highWaterMarkColumnName": "_ts"
      },
      "dataDeletionDetectionPolicy": {
        "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy",
        "softDeleteColumnName": "isDeleted",
        "softDeleteMarkerValue": "true"
      },
      "encryptionKey": {
        "keyVaultKeyName": "myKeyName",
        "keyVaultKeyVersion": "myKeyVersion",
        "keyVaultUri": "https://myKeyVault.vault.azure.net",
        "accessCredentials": {
          "applicationId": "00000000-0000-0000-0000-000000000000",
          "applicationSecret": null
        }
      }
    }
  ]
}

Definíciók

Name	Description
AzureActiveDirectoryApplicationCredentials	A keresési szolgáltatáshoz létrehozott regisztrált alkalmazás hitelesítő adatai, amelyeket az Azure Key Vaultban tárolt titkosítási kulcsokhoz való hitelesített hozzáféréshez használnak.
DataSourceCredentials	Az adatforráshoz való csatlakozáshoz használható hitelesítő adatokat jelöli.
HighWaterMarkChangeDetectionPolicy	Olyan adatváltozás-észlelési szabályzatot definiál, amely egy magas vízjeloszlop értéke alapján rögzíti a változásokat.
ListDataSourcesResult	Válasz a List Datasources-kérésből. Ha sikeres, az összes adatforrás teljes definícióját tartalmazza.
SearchError	Az API hibafeltételét ismerteti.
SearchIndexerDataContainer	Az indexelendő entitásra (például az Azure SQL-táblára vagy a CosmosDB-gyűjteményre) vonatkozó információkat jelöli.
SearchIndexerDataSource	Az indexelő konfigurálásához használható adatforrásdefiníciót jelöli.
SearchIndexerDataSourceType	Meghatározza az adatforrás típusát.
SearchResourceEncryptionKey	Ügyfél által felügyelt titkosítási kulcs az Azure Key Vaultban. A létrehozott és kezelt kulcsokkal titkosíthatja vagy visszafejtheti a keresési szolgáltatás inaktív adatait, például indexeket és szinonimatérképeket.
SoftDeleteColumnDeletionDetectionPolicy	Olyan adattörlési észlelési szabályzatot definiál, amely helyreállítható törlési stratégiát implementál. Meghatározza, hogy egy elemet törölni kell-e egy kijelölt "helyreállítható törlés" oszlop értéke alapján.
SqlIntegratedChangeTrackingPolicy	Olyan adatváltozás-észlelési szabályzatot határoz meg, amely az Azure SQL Database integrált változáskövetési funkciójával rögzíti a változásokat.

AzureActiveDirectoryApplicationCredentials

Tárgy

A keresési szolgáltatáshoz létrehozott regisztrált alkalmazás hitelesítő adatai, amelyeket az Azure Key Vaultban tárolt titkosítási kulcsokhoz való hitelesített hozzáféréshez használnak.

Name	Típus	Description
applicationId	string	Egy AAD-alkalmazásazonosító, amely megkapta a szükséges hozzáférési engedélyeket az Azure Key Vaulthoz, amelyet az inaktív adatok titkosításához kell használni. Az alkalmazásazonosító nem tévesztendő össze az AAD-alkalmazás objektumazonosítójával.
applicationSecret	string	A megadott AAD-alkalmazás hitelesítési kulcsa.

DataSourceCredentials

Tárgy

Az adatforráshoz való csatlakozáshoz használható hitelesítő adatokat jelöli.

Name	Típus	Description
connectionString	string	Az adatforrás kapcsolati sztringje. Állítsa `<unchanged>` (szögletes zárójelekkel), ha nem szeretné frissíteni a kapcsolati sztringet. Állítsa `<redacted>`, ha el szeretné távolítani a kapcsolati sztring értékét az adatforrásból.

HighWaterMarkChangeDetectionPolicy

Tárgy

Olyan adatváltozás-észlelési szabályzatot definiál, amely egy magas vízjeloszlop értéke alapján rögzíti a változásokat.

Name	Típus	Description
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	Az adatváltozás-észlelési szabályzat típusát meghatározó URI-töredék.
highWaterMarkColumnName	string	A magas vízjel oszlop neve.

ListDataSourcesResult

Tárgy

Válasz a List Datasources-kérésből. Ha sikeres, az összes adatforrás teljes definícióját tartalmazza.

Name	Típus	Description
value	SearchIndexerDataSource[]	A Keresési szolgáltatás adatforrásai.

SearchError

Tárgy

Az API hibafeltételét ismerteti.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	SearchError[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
message	string	A hiba ember által olvasható ábrázolása.

SearchIndexerDataContainer

Tárgy

Az indexelendő entitásra (például az Azure SQL-táblára vagy a CosmosDB-gyűjteményre) vonatkozó információkat jelöli.

Name	Típus	Description
name	string	Az indexelendő tábla vagy nézet neve (Azure SQL-adatforráshoz) vagy gyűjteményhez (CosmosDB-adatforráshoz).
query	string	Az adattárolóra alkalmazott lekérdezés. Ennek a paraméternek a szintaxisa és jelentése adatforrás-specifikus. Az Azure SQL-adatforrások nem támogatják.

SearchIndexerDataSource

Tárgy

Az indexelő konfigurálásához használható adatforrásdefiníciót jelöli.

Name	Típus	Description
@odata.etag	string	Az adatforrás ETagje.
container	SearchIndexerDataContainer	Az adatforrás adattárolója.
credentials	DataSourceCredentials	Az adatforrás hitelesítő adatai.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Az adatforrás adatváltozás-észlelési szabályzata.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	Az adatforrás adattörlési észlelési szabályzata.
description	string	Az adatforrás leírása.
encryptionKey	SearchResourceEncryptionKey	Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ez a kulcs további inaktív szintű titkosítást biztosít az adatforrás definíciójához, ha teljes bizonyosságot szeretne arról, hogy senki, még a Microsoft sem tudja visszafejteni az adatforrás definícióját. Miután titkosította az adatforrásdefiníciót, az mindig titkosítva marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre történő beállítására tett kísérleteket. Szükség szerint módosíthatja ezt a tulajdonságot, ha el szeretné forgatni a titkosítási kulcsot; Az adatforrás definíciója nem lesz hatással. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el.
name	string	Az adatforrás neve.
type	SearchIndexerDataSourceType	Az adatforrás típusa.

SearchIndexerDataSourceType

Felsorolás

Meghatározza az adatforrás típusát.

Érték	Description
azuresql	Egy Azure SQL-adatforrást jelez.
cosmosdb	CosmosDB-adatforrást jelez.
azureblob	Egy Azure Blob-adatforrást jelöl.
azuretable	Egy Azure Table-adatforrást jelöl.
mysql	MySql-adatforrást jelöl.
adlsgen2	ADLS Gen2-adatforrást jelez.

SearchResourceEncryptionKey

Tárgy

Ügyfél által felügyelt titkosítási kulcs az Azure Key Vaultban. A létrehozott és kezelt kulcsokkal titkosíthatja vagy visszafejtheti a keresési szolgáltatás inaktív adatait, például indexeket és szinonimatérképeket.

Name	Típus	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Az Azure Key Vault eléréséhez használt opcionális Azure Active Directory-hitelesítő adatok. Nem kötelező, ha ehelyett felügyelt identitást használ.
keyVaultKeyName	string	A inaktív adatok titkosításához használandó Azure Key Vault-kulcs neve.
keyVaultKeyVersion	string	Az Azure Key Vault-kulcs inaktív adatok titkosításához használandó verziója.
keyVaultUri	string	Az Azure Key Vault URI-ja, más néven DNS-név, amely tartalmazza az inaktív adatok titkosításához használandó kulcsot. Példa URI lehet `https://my-keyvault-name.vault.azure.net`.

SoftDeleteColumnDeletionDetectionPolicy

Tárgy

Olyan adattörlési észlelési szabályzatot definiál, amely helyreállítható törlési stratégiát implementál. Meghatározza, hogy egy elemet törölni kell-e egy kijelölt "helyreállítható törlés" oszlop értéke alapján.

Name	Típus	Description
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	Az adattörlési észlelési szabályzat típusát meghatározó URI-töredék.
softDeleteColumnName	string	A helyreállítható törlés észleléséhez használandó oszlop neve.
softDeleteMarkerValue	string	Az elemeket töröltként azonosító jelölőérték.

SqlIntegratedChangeTrackingPolicy

Tárgy

Olyan adatváltozás-észlelési szabályzatot határoz meg, amely az Azure SQL Database integrált változáskövetési funkciójával rögzíti a változásokat.

Name	Típus	Description
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	Az adatváltozás-észlelési szabályzat típusát meghatározó URI-töredék.