Data Sources - Create

Referencia

Szolgáltatás:: Search Service

API-verzió:: 2024-05-01-preview

Létrehoz egy új adatforrást.

POST {endpoint}/datasources?api-version=2024-05-01-preview

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 NativeBlobSoftDeleteDeletionDetectionPolicy	Az adatforrás adattörlési észlelési szabályzata.
description		string	Az adatforrás leírása.
encryptionKey		SearchResourceEncryptionKey	Az Azure Key Vault-ben létrehozott titkosítási kulcs leírása. Ez a kulcs további titkosítási szintet biztosít az adatforrás definíciójához, ha teljes körű biztosítékot szeretne kapni arról, hogy senki, még a Microsoft sem tudja visszafejteni az adatforrás definícióját. Miután titkosította az adatforrás definíciójá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. Ezt a tulajdonságot szükség szerint módosíthatja, 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 történő 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.
identity		SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Az adatforráshoz használandó explicit felügyelt identitás. Ha nincs megadva, és a kapcsolati karakterlánc egy felügyelt identitás, a rendszer a rendszer által hozzárendelt felügyelt identitást használja. Ha nincs megadva, az érték változatlan marad. Ha a "nincs" érték van megadva, a tulajdonság értéke törlődik.

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-05-01-preview

{
  "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, amelyet az Azure Key Vault 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	Adatváltozás-észlelési szabályzatot definiál, amely a magas vízjel oszlop értéke alapján rögzíti a változásokat.
NativeBlobSoftDeleteDeletionDetectionPolicy	Definiál egy adattörlési észlelési szabályzatot, amely Azure Blob Storage natív helyreállítható törlési funkcióját használja a törlés észleléséhez.
SearchIndexerDataContainer	Az indexelendő entitásra (például Azure SQL táblára vagy CosmosDB-gyűjteményre) vonatkozó információkat jelöli.
SearchIndexerDataNoneIdentity	Törli egy adatforrás identitástulajdonságát.
SearchIndexerDataSource	Egy adatforrásdefiníciót jelöl, amely egy indexelő konfigurálásához használható.
SearchIndexerDataSourceType	Meghatározza az adatforrás típusát.
SearchIndexerDataUserAssignedIdentity	Megadja a használni kívánt adatforrás identitását.
SearchResourceEncryptionKey	Ügyfél által felügyelt titkosítási kulcs az Azure Key Vault. A létrehozott és kezelt kulcsok az inaktív adatok, például indexek és szinonimák titkosítására vagy visszafejtésére használhatók.
SoftDeleteColumnDeletionDetectionPolicy	Definiál egy adattörlési észlelési szabályzatot, amely helyreállítható törlési stratégiát valósít meg. 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	Adatváltozás-észlelési szabályzatot határoz meg, amely rögzíti a módosításokat az Azure SQL Database Integrált Change Tracking funkciójával.

AzureActiveDirectoryApplicationCredentials

A keresési szolgáltatáshoz létrehozott regisztrált alkalmazás hitelesítő adatai, amelyet az Azure Key Vault 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 Vault, 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 karakterlánc. `<unchanged>` Ha nem szeretné frissíteni a kapcsolati karakterlánc, állítsa (szögletes zárójelekkel) értékre. Állítsa értékre`<redacted>`, ha el szeretné távolítani a kapcsolati karakterlánc értéket 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 adattí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 hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

HighWaterMarkChangeDetectionPolicy

Adatváltozás-észlelési szabályzatot definiál, amely a magas vízjel oszlop é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.

NativeBlobSoftDeleteDeletionDetectionPolicy

Definiál egy adattörlési észlelési szabályzatot, amely Azure Blob Storage natív helyreállítható törlési funkcióját használja a törlés észleléséhez.

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

SearchIndexerDataContainer

Az indexelendő entitásra (például Azure SQL táblára vagy 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ás esetén) vagy gyűjtemény (CosmosDB-adatforrás esetén).
query	string	Az adattárolóra alkalmazott lekérdezés. Ennek a paraméternek a szintaxisa és jelentése adatforrás-specifikus. Azure SQL adatforrások nem támogatják.

SearchIndexerDataNoneIdentity

Törli egy adatforrás identitástulajdonságát.

Name	Típus	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Az identitás típusát meghatározó URI-töredék.

SearchIndexerDataSource

Egy adatforrásdefiníciót jelöl, amely egy indexelő konfigurálásához használható.

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: NativeBlobSoftDeleteDeletionDetectionPolicy SoftDeleteColumnDeletionDetectionPolicy	Az adatforrás adattörlési észlelési szabályzata.
description	string	Az adatforrás leírása.
encryptionKey	SearchResourceEncryptionKey	Az Azure Key Vault-ben létrehozott titkosítási kulcs leírása. Ez a kulcs további titkosítási szintet biztosít az adatforrás definíciójához, ha teljes körű biztosítékot szeretne kapni arról, hogy senki, még a Microsoft sem tudja visszafejteni az adatforrás definícióját. Miután titkosította az adatforrás definíciójá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. Ezt a tulajdonságot szükség szerint módosíthatja, 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 történő 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.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Az adatforráshoz használandó explicit felügyelt identitás. Ha nincs megadva, és a kapcsolati karakterlánc egy felügyelt identitás, a rendszer a rendszer által hozzárendelt felügyelt identitást használja. Ha nincs megadva, az érték változatlan marad. Ha a "nincs" érték van megadva, a tulajdonság értéke törlődik.
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 jelez.
azuresql	string	Egy Azure SQL adatforrást jelöl.
azuretable	string	Egy Azure Table-adatforrást jelez.
cosmosdb	string	CosmosDB-adatforrást jelez.
mysql	string	MySql-adatforrást jelez.
onelake	string	Egy Microsoft Fabric OneLake-adatforrást jelöl.

SearchIndexerDataUserAssignedIdentity

Megadja a használni kívánt adatforrás identitását.

Name	Típus	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Az identitás típusát meghatározó URI-töredék.
userAssignedIdentity	string	A felhasználó által hozzárendelt felügyelt identitás teljes Azure-erőforrás-azonosítója általában "/subscriptions/12345678-1234-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" formában, amelyet hozzá kellett volna rendelni a keresési szolgáltatáshoz.

SearchResourceEncryptionKey

Ügyfél által felügyelt titkosítási kulcs az Azure Key Vault. A létrehozott és kezelt kulcsok az inaktív adatok, például indexek és szinonimák titkosítására vagy visszafejtésére használhatók.

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 felügyelt identitást használ helyette.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	A titkosítási kulcshoz használandó explicit felügyelt identitás. Ha nincs megadva, és a hozzáférési hitelesítő adatok tulajdonság null értékű, a rendszer a rendszer által hozzárendelt felügyelt identitást használja. Ha az erőforrás frissítésekor a explicit identitás nincs meghatározva, az változatlan marad. Ha a "nincs" érték van megadva, a tulajdonság értéke törlődik.
keyVaultKeyName	string	Az Inaktív adatok titkosításához használandó Azure-Key Vault kulcs neve.
keyVaultKeyVersion	string	Az Inaktív adatok titkosításához használandó Azure-Key Vault kulcs verziója.
keyVaultUri	string	Az Azure Key Vault ( más néven DNS-név) URI-ja, amely az inaktív adatok titkosításához használandó kulcsot tartalmazza. Példa URI-ra: `https://my-keyvault-name.vault.azure.net`.

SoftDeleteColumnDeletionDetectionPolicy

Definiál egy adattörlési észlelési szabályzatot, amely helyreállítható törlési stratégiát valósít meg. 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álni kívánt oszlop neve.
softDeleteMarkerValue	string	A törölt elemeket azonosító jelölőérték.

SqlIntegratedChangeTrackingPolicy

Adatváltozás-észlelési szabályzatot határoz meg, amely rögzíti a módosításokat az Azure SQL Database Integrált Change Tracking funkciójával.

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: