Data Sources - Create Or Update

Szolgáltatás:: Search Service

API-verzió:: 2024-03-01-Preview

Létrehoz egy új adatforrást, vagy frissíti az adatforrást, ha már létezik.

PUT {endpoint}/datasources('{dataSourceName}')?api-version=2024-03-01-Preview

Opcionális paraméterekkel:

PUT {endpoint}/datasources('{dataSourceName}')?api-version=2024-03-01-Preview&ignoreResetRequirements={ignoreResetRequirements}

URI-paraméterek

Name	In	Kötelező	Típus	Description
dataSourceName	path	True	string	A létrehozni vagy frissíteni kívánt adatforrás neve.
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.
ignoreResetRequirements	query		boolean	Figyelmen kívül hagyja a gyorsítótár alaphelyzetbe állítására vonatkozó követelményeket.

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.
If-Match		string	Meghatározza a If-Match feltételt. A művelet csak akkor lesz végrehajtva, ha a kiszolgálón lévő ETag megfelel ennek az értéknek.
If-None-Match		string	Meghatározza az If-None-Match feltételt. A művelet csak akkor lesz végrehajtva, ha a kiszolgálón lévő ETag nem egyezik meg ezzel az értékkel.
Prefer	True	string	HTTP PUT-kérések esetén utasítja a szolgáltatást, hogy a létrehozott/frissített erőforrást adja vissza a sikerhez.

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 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.
identity		SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Az adatforráshoz használandó explicit felügyelt identitás. Ha nincs megadva, és a kapcsolati sztring 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 nincs megadva, a tulajdonság értéke törlődik.

Válaszok

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

Példák

SearchServiceCreateOrUpdateDataSource

Mintakérelem

HTTP

PUT https://myservice.search.windows.net/datasources('mydatasource')?api-version=2024-03-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": null
  }
}

Mintaválasz

Állapotkód:: 200

{
  "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": null
  }
}

Á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": 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.
NativeBlobSoftDeleteDeletionDetectionPolicy	Definiál egy adattörlési észlelési szabályzatot, amely az Azure Blob Storage natív helyreállítható törlési funkcióját használja a törlésészleléshez.
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.
SearchIndexerDataNoneIdentity	Törli az adatforrás identitástulajdonságát.
SearchIndexerDataSource	Az indexelő konfigurálásához használható adatforrásdefiníciót jelöli.
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 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

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.

ErrorAdditionalInfo

Tárgy

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

Tárgy

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

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

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.

NativeBlobSoftDeleteDeletionDetectionPolicy

Tárgy

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

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

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.

SearchIndexerDataNoneIdentity

Tárgy

Törli az 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

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: 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 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.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Az adatforráshoz használandó explicit felügyelt identitás. Ha nincs megadva, és a kapcsolati sztring 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 nincs megadva, a tulajdonság értéke törlődik.
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.

SearchIndexerDataUserAssignedIdentity

Tárgy

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 található, amelyet hozzá kellett volna rendelni a keresési szolgáltatáshoz.

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 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.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Explicit felügyelt identitás ehhez a titkosítási kulcshoz. Ha nincs megadva, és a hozzáférési hitelesítő adatok tulajdonság null értékű, akkor a rendszer a rendszer által hozzárendelt felügyelt identitást használja. Az erőforrás frissítésekor, ha az explicit identitás nincs meghatározva, az változatlan marad. Ha nincs megadva, a tulajdonság értéke törlődik.
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.