Data Sources - Create

Reference

Služba:: Search Service

Verze rozhraní API:: 2024-07-01

Vytvoří nový zdroj dat.

POST {endpoint}/datasources?api-version=2024-07-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é s požadavkem, které vám pomůže 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 pro zdroj dat.
name	True	string	Název zdroje dat.
type	True	SearchIndexerDataSourceType	Typ zdroje dat.
@odata.etag		string	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 ve službě Azure Key Vault. Tento klíč se používá k poskytnutí další úrovně neaktivních uložených šifrování pro definici zdroje dat, pokud chcete mít plnou jistotu, že nikdo, 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. Tuto vlastnost můžete podle potřeby změnit, pokud chcete šifrovací klíč otočit; Definice zdroje dat 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 po 1. lednu 2019.

Odpovědi

Name	Typ	Description
201 Created	SearchIndexerDataSource
Other Status Codes	ErrorResponse	Chybová odpověď.

Příklady

SearchServiceCreateDataSource

Ukázkový požadavek

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>"
    }
  }
}

Ukázková odpověď

Stavový kó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
    }
  }
}

Definice

Name	Description
AzureActiveDirectoryApplicationCredentials	Přihlašovací údaje registrované aplikace vytvořené pro vaši vyhledávací službu, které slouží k ověřenému přístupu k šifrovacím klíčům uloženým ve službě Azure Key Vault.
DataSourceCredentials	Představuje přihlašovací údaje, které lze použít pro připojení ke zdroji dat.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
HighWaterMarkChangeDetectionPolicy	Definuje zásadu detekce změn dat, která zachycuje změny na základě hodnoty sloupce horní značky.
SearchIndexerDataContainer	Představuje informace o entitě (například tabulce Azure SQL nebo kolekci CosmosDB), která se bude indexovat.
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 ve službě Azure Key Vault. Klíče, které vytvoříte a spravujete, se dají použít k šifrování nebo dešifrování neaktivních uložených dat, 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á zachycuje změny pomocí integrované funkce Change Tracking ve službě Azure SQL Database.

AzureActiveDirectoryApplicationCredentials

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

Name	Typ	Description
applicationId	string	ID aplikace AAD, kterému byla udělena požadovaná přístupová oprávnění ke službě Azure Key Vault, která se má použít při šifrování neaktivních uložených dat. ID aplikace by nemělo být zaměňováno s ID objektu pro vaši aplikaci 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>` (s hranatými závorkami). Pokud chcete odebrat hodnotu připojovacího řetězce ze zdroje dat, nastavte na `<redacted>`.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

HighWaterMarkChangeDetectionPolicy

Definuje zásadu detekce změn dat, která zachycuje změny na základě hodnoty sloupce horní značky.

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 horní značky.

SearchIndexerDataContainer

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

Name	Typ	Description
name	string	Název tabulky nebo zobrazení (pro zdroj dat Azure SQL) nebo kolekci (pro zdroj dat CosmosDB), které se budou indexovat.
query	string	Dotaz, který se použije pro tento kontejner dat. Syntaxe a význam tohoto parametru je specifická pro zdroj dat. Zdroje dat Azure SQL nepodporují.

SearchIndexerDataSource

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

Name	Typ	Description
@odata.etag	string	ETag zdroje dat.
container	SearchIndexerDataContainer	Kontejner dat pro zdroj dat.
credentials	DataSourceCredentials	Přihlašovací údaje pro zdroj 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 ve službě Azure Key Vault. Tento klíč se používá k poskytnutí další úrovně neaktivních uložených šifrování pro definici zdroje dat, pokud chcete mít plnou jistotu, že nikdo, 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. Tuto vlastnost můžete podle potřeby změnit, pokud chcete šifrovací klíč otočit; Definice zdroje dat 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 po 1. lednu 2019.
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 Azure Blob.
azuresql	string	Označuje zdroj dat Azure SQL.
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 ve službě Azure Key Vault. Klíče, které vytvoříte a spravujete, se dají použít k šifrování nebo dešifrování neaktivních uložených dat, jako jsou indexy a mapy synonym.

Name	Typ	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Volitelné přihlašovací údaje Azure Active Directory používané pro přístup ke službě Azure Key Vault. Nevyžaduje se, pokud místo toho používáte spravovanou identitu.
keyVaultKeyName	string	Název klíče služby Azure Key Vault, který se má použít k šifrování neaktivních uložených dat.
keyVaultKeyVersion	string	Verze klíče služby Azure Key Vault, která se má použít k šifrování neaktivních uložených dat.
keyVaultUri	string	Identifikátor URI služby Azure Key Vault, 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á zachycuje změny pomocí integrované funkce Change Tracking ve službě 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.

Sdílet prostřednictvím