Data Sources - Create

Referencia

Szolgáltatás:: Search Service

API-verzió:: 2024-07-01

Új adatforrást hoz létre.

POST {endpoint}/datasources?api-version=2024-07-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.

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.

Kérelem törzse

Name	Kötelező	Típus	Description
container	True	SearchIndexerDataContainer	Az adatforrás adattárolója.
credentials	True	DataSourceCredentials	Az adatforrás hitelesítő adatai.
name	True	string	Az adatforrás neve.
type	True	SearchIndexerDataSourceType	Az adatforrás típusa.
@odata.etag		string	Az adatforrás ETagje.
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.

Válaszok

Name	Típus	Description
201 Created	SearchIndexerDataSource
Other Status Codes	ErrorResponse	Hibaválasz.

Példák

SearchServiceCreateDataSource

Mintakérelem

HTTP

POST https://myservice.search.windows.net/datasources?api-version=2024-07-01

{
  "name": "mydocdbdatasource",
  "description": "My Cosmos DB data source.",
  "type": "cosmosdb",
  "credentials": {
    "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId"
  },
  "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": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Mintaválasz

Állapotkód:: 201

{
  "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": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "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.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
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.
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 az inaktív adatokat, 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

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

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.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

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.

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.

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.

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

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

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

Name	Típus	Description
adlsgen2	string	ADLS Gen2-adatforrást jelez.
azureblob	string	Egy Azure Blob-adatforrást jelöl.
azuresql	string	Egy Azure SQL-adatforrást jelez.
azuretable	string	Egy Azure Table-adatforrást jelöl.
cosmosdb	string	CosmosDB-adatforrást jelez.
mysql	string	MySql-adatforrást jelöl.

SearchResourceEncryptionKey

Ügyfél által felügyelt titkosítási kulcs az Azure Key Vaultban. A létrehozott és kezelt kulcsokkal titkosíthatja vagy visszafejtheti az inaktív adatokat, 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

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

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.

Megosztás a következőn keresztül: