Data Sources - Create

Reference

Service:: Search Service

API Version:: 2023-11-01

Vytvoří nový zdroj dat.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
api-version	query	True	string	Verze rozhraní API klienta.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string uuid	ID sledování odeslané spolu s požadavkem na pomoc s laděním.

Text požadavku

Name	Vyžadováno	Typ	Description
container	True	SearchIndexerDataContainer	Kontejner dat pro zdroj dat.
credentials	True	DataSourceCredentials	Přihlašovací údaje ke zdroji dat.
name	True	string	Název zdroje dat.
type	True	SearchIndexerDataSourceType	Typ zdroje dat.
@odata.etag		string	Značka ETag zdroje dat.
dataChangeDetectionPolicy		DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Zásady detekce změn dat pro zdroj dat.
dataDeletionDetectionPolicy		DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	Zásady detekce odstranění dat pro zdroj dat.
description		string	Popis zdroje dat.
encryptionKey		SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč se používá k poskytnutí další úrovně šifrování neaktivních uložených uložených dat pro definici zdroje dat, pokud chcete mít plnou jistotu, že nikdo, dokonce ani Microsoft, nemůže dešifrovat definici zdroje dat. Jakmile definici zdroje dat zašifrujete, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Pokud chcete šifrovací klíč obměnit, můžete tuto vlastnost podle potřeby změnit. Na definici zdroje dat to nebude mít vliv. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.

Odpovědi

Name	Typ	Description
201 Created	SearchIndexerDataSource
Other Status Codes	SearchError	Odpověď na chybu.

Příklady

SearchServiceCreateDataSource

Sample Request

HTTP

POST https://myservice.search.windows.net/datasources?api-version=2023-11-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>"
    }
  }
}

Sample Response

Status code:: 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
    }
  }
}

Definice

Name	Description
AzureActiveDirectoryApplicationCredentials	Přihlašovací údaje zaregistrované aplikace vytvořené pro vyhledávací službu, které slouží k ověřenému přístupu k šifrovacím klíčům uloženým v Azure Key Vault.
DataSourceCredentials	Představuje přihlašovací údaje, které lze použít pro připojení ke zdroji dat.
HighWaterMarkChangeDetectionPolicy	Definuje zásadu detekce změn dat, která zaznamenává změny na základě hodnoty sloupce s vysokou hladinou.
SearchError	Popisuje chybový stav rozhraní API.
SearchIndexerDataContainer	Představuje informace o entitě (například Azure SQL tabulce nebo kolekci CosmosDB), která bude indexována.
SearchIndexerDataSource	Představuje definici zdroje dat, kterou lze použít ke konfiguraci indexeru.
SearchIndexerDataSourceType	Definuje typ zdroje dat.
SearchResourceEncryptionKey	Šifrovací klíč spravovaný zákazníkem v Azure Key Vault. Klíče, které vytvoříte a spravujete, můžete použít k šifrování nebo dešifrování neaktivních uložených dat ve vyhledávací službě, jako jsou indexy a mapy synonym.
SoftDeleteColumnDeletionDetectionPolicy	Definuje zásadu detekce odstranění dat, která implementuje strategii obnovitelného odstranění. Určuje, zda má být položka odstraněna na základě hodnoty určeného sloupce obnovitelného odstranění.
SqlIntegratedChangeTrackingPolicy	Definuje zásadu detekce změn dat, která zaznamenává změny pomocí integrované funkce Change Tracking služby Azure SQL Database.

AzureActiveDirectoryApplicationCredentials

Přihlašovací údaje zaregistrované aplikace vytvořené pro vyhledávací službu, které slouží k ověřenému přístupu k šifrovacím klíčům uloženým v Azure Key Vault.

Name	Typ	Description
applicationId	string	ID aplikace AAD, kterému byla udělena požadovaná přístupová oprávnění k azure Key Vault, která se mají použít při šifrování neaktivních uložených dat. ID aplikace by se nemělo zaměňovat s ID objektu vaší aplikace AAD.
applicationSecret	string	Ověřovací klíč zadané aplikace AAD.

DataSourceCredentials

Představuje přihlašovací údaje, které lze použít pro připojení ke zdroji dat.

Name	Typ	Description
connectionString	string	Připojovací řetězec pro zdroj dat. Pokud nechcete, aby se připojovací řetězec aktualizoval, nastavte na `<unchanged>` (se závorkami). Pokud chcete odebrat hodnotu připojovací řetězec ze zdroje dat, nastavte na `<redacted>` hodnotu .

HighWaterMarkChangeDetectionPolicy

Definuje zásadu detekce změn dat, která zaznamenává změny na základě hodnoty sloupce s vysokou hladinou.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	Fragment identifikátoru URI určující typ zásad detekce změn dat.
highWaterMarkColumnName	string	Název sloupce s vysokou značkou vody.

SearchError

Popisuje chybový stav rozhraní API.

Name	Typ	Description
code	string	Jeden ze serverem definované sady kódů chyb.
details	SearchError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message	string	Lidsky čitelná reprezentace chyby.

SearchIndexerDataContainer

Představuje informace o entitě (například Azure SQL tabulce nebo kolekci CosmosDB), která bude indexována.

Name	Typ	Description
name	string	Název tabulky nebo zobrazení (pro Azure SQL zdroj dat) nebo kolekce (pro zdroj dat CosmosDB), která se bude indexovat.
query	string	Dotaz, který se použije na tento kontejner dat. Syntaxe a význam tohoto parametru jsou specifické pro zdroj dat. Nepodporuje Azure SQL zdroje dat.

SearchIndexerDataSource

Představuje definici zdroje dat, kterou lze použít ke konfiguraci indexeru.

Name	Typ	Description
@odata.etag	string	Značka ETag zdroje dat.
container	SearchIndexerDataContainer	Kontejner dat pro zdroj dat.
credentials	DataSourceCredentials	Přihlašovací údaje ke zdroji dat.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Zásady detekce změn dat pro zdroj dat.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	Zásady detekce odstranění dat pro zdroj dat.
description	string	Popis zdroje dat.
encryptionKey	SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč se používá k poskytnutí další úrovně šifrování neaktivních uložených uložených dat pro definici zdroje dat, pokud chcete mít plnou jistotu, že nikdo, dokonce ani Microsoft, nemůže dešifrovat definici zdroje dat. Jakmile definici zdroje dat zašifrujete, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Pokud chcete šifrovací klíč obměnit, můžete tuto vlastnost podle potřeby změnit. Na definici zdroje dat to nebude mít vliv. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.
name	string	Název zdroje dat.
type	SearchIndexerDataSourceType	Typ zdroje dat.

SearchIndexerDataSourceType

Definuje typ zdroje dat.

Name	Typ	Description
adlsgen2	string	Označuje zdroj dat ADLS Gen2.
azureblob	string	Označuje zdroj dat objektu blob Azure.
azuresql	string	Označuje Azure SQL zdroj dat.
azuretable	string	Označuje zdroj dat tabulky Azure.
cosmosdb	string	Označuje zdroj dat CosmosDB.
mysql	string	Označuje zdroj dat MySql.

SearchResourceEncryptionKey

Šifrovací klíč spravovaný zákazníkem v Azure Key Vault. Klíče, které vytvoříte a spravujete, můžete použít k šifrování nebo dešifrování neaktivních uložených dat ve vyhledávací službě, jako jsou indexy a mapy synonym.

Name	Typ	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Volitelné přihlašovací údaje Azure Active Directory používané pro přístup k Key Vault Azure. Nevyžaduje se, pokud místo toho použijete spravovanou identitu.
keyVaultKeyName	string	Název klíče Azure Key Vault, který se má použít k šifrování neaktivních uložených dat.
keyVaultKeyVersion	string	Verze klíče Azure Key Vault, který se má použít k šifrování neaktivních uložených dat.
keyVaultUri	string	Identifikátor URI Key Vault Azure, označovaný také jako název DNS, který obsahuje klíč, který se má použít k šifrování neaktivních uložených dat. Příkladem identifikátoru URI může být `https://my-keyvault-name.vault.azure.net`.

SoftDeleteColumnDeletionDetectionPolicy

Definuje zásadu detekce odstranění dat, která implementuje strategii obnovitelného odstranění. Určuje, zda má být položka odstraněna na základě hodnoty určeného sloupce obnovitelného odstranění.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	Fragment identifikátoru URI určující typ zásad detekce odstranění dat.
softDeleteColumnName	string	Název sloupce, který se má použít pro detekci obnovitelného odstranění.
softDeleteMarkerValue	string	Hodnota značky, která identifikuje položku jako odstraněnou.

SqlIntegratedChangeTrackingPolicy

Definuje zásadu detekce změn dat, která zaznamenává změny pomocí integrované funkce Change Tracking služby Azure SQL Database.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	Fragment identifikátoru URI určující typ zásad detekce změn dat.