Data Sources - List

Служба:: Search Service

Версия API:: 2023-11-01

Выводит список всех источников данных, доступных для службы поиска.

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

С использованием необязательных параметров:

GET {endpoint}/datasources?$select={$select}&api-version=2023-11-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	URL-адрес конечной точки службы поиска.
api-version	query	True	string	Версия клиентского API.
$select	query		string	Определяет, какие свойства верхнего уровня извлекаются из источников данных. Указан как разделенный запятыми список имен свойств JSON или `*` для всех свойств. Значение по умолчанию — все свойства.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-request-id		string (uuid)	Идентификатор отслеживания, отправляемый запросом на отладку.

Ответы

Имя	Тип	Описание
200 OK	ListDataSourcesResult
Other Status Codes	SearchError	Ответ на ошибку.

Примеры

SearchServiceListDataSources

Образец запроса

HTTP

GET https://myservice.search.windows.net/datasources?$select=*&api-version=2023-11-01

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "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": "myKeyName",
        "keyVaultKeyVersion": "myKeyVersion",
        "keyVaultUri": "https://myKeyVault.vault.azure.net",
        "accessCredentials": {
          "applicationId": "00000000-0000-0000-0000-000000000000",
          "applicationSecret": null
        }
      }
    }
  ]
}

Определения

Имя	Описание
AzureActiveDirectoryApplicationCredentials	Учетные данные зарегистрированного приложения, созданного для службы поиска, используемого для проверки подлинности доступа к ключам шифрования, хранящимся в Azure Key Vault.
DataSourceCredentials	Представляет учетные данные, которые можно использовать для подключения к источнику данных.
HighWaterMarkChangeDetectionPolicy	Определяет политику обнаружения изменений данных, которая фиксирует изменения в зависимости от значения столбца высокой водяной отметки.
ListDataSourcesResult	Ответ из запроса источников данных списка. При успешном выполнении он включает полные определения всех источников данных.
SearchError	Описывает условие ошибки для API.
SearchIndexerDataContainer	Представляет сведения о сущности (например, таблице SQL Azure или коллекции CosmosDB), которая будет индексирована.
SearchIndexerDataSource	Представляет определение источника данных, которое можно использовать для настройки индексатора.
SearchIndexerDataSourceType	Определяет тип источника данных.
SearchResourceEncryptionKey	Ключ шифрования, управляемый клиентом, в Azure Key Vault. Ключи, которые создаются и управляются, можно использовать для шифрования или расшифровки неактивных данных в службе поиска, таких как индексы и карты синонимов.
SoftDeleteColumnDeletionDetectionPolicy	Определяет политику обнаружения удаления данных, реализующую стратегию обратимого удаления. Он определяет, следует ли удалять элемент на основе значения указанного столбца обратимого удаления.
SqlIntegratedChangeTrackingPolicy	Определяет политику обнаружения изменений данных, которая фиксирует изменения с помощью функции встроенного отслеживания изменений базы данных SQL Azure.

AzureActiveDirectoryApplicationCredentials

Объект

Учетные данные зарегистрированного приложения, созданного для службы поиска, используемого для проверки подлинности доступа к ключам шифрования, хранящимся в Azure Key Vault.

Имя	Тип	Описание
applicationId	string	Идентификатор приложения AAD, которому было предоставлено необходимые разрешения на доступ к Azure Key Vault, который будет использоваться при шифровании неактивных данных. Идентификатор приложения не следует путать с идентификатором объекта для приложения AAD.
applicationSecret	string	Ключ проверки подлинности указанного приложения AAD.

DataSourceCredentials

Объект

Представляет учетные данные, которые можно использовать для подключения к источнику данных.

Имя	Тип	Описание
connectionString	string	Строка подключения для источника данных. Установите значение `<unchanged>` (с скобками), если строка подключения не обновлена. Установите значение `<redacted>`, если вы хотите удалить значение строки подключения из источника данных.

HighWaterMarkChangeDetectionPolicy

Объект

Определяет политику обнаружения изменений данных, которая фиксирует изменения в зависимости от значения столбца высокой водяной отметки.

Имя	Тип	Описание
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	Фрагмент URI, указывающий тип политики обнаружения изменений данных.
highWaterMarkColumnName	string	Имя столбца с высокой водой.

ListDataSourcesResult

Объект

Ответ из запроса источников данных списка. При успешном выполнении он включает полные определения всех источников данных.

Имя	Тип	Описание
value	SearchIndexerDataSource[]	Источники данных в службе поиска.

SearchError

Объект

Описывает условие ошибки для API.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	SearchError[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
message	string	Читаемое пользователем представление ошибки.

SearchIndexerDataContainer

Объект

Представляет сведения о сущности (например, таблице SQL Azure или коллекции CosmosDB), которая будет индексирована.

Имя	Тип	Описание
name	string	Имя таблицы или представления (для источника данных SQL Azure) или коллекции (для источника данных CosmosDB), который будет индексирован.
query	string	Запрос, применяемый к этому контейнеру данных. Синтаксис и значение этого параметра относятся к источнику данных. Не поддерживается источниками данных SQL Azure.

SearchIndexerDataSource

Объект

Представляет определение источника данных, которое можно использовать для настройки индексатора.

Имя	Тип	Описание
@odata.etag	string	ETag источника данных.
container	SearchIndexerDataContainer	Контейнер данных для источника данных.
credentials	DataSourceCredentials	Учетные данные для источника данных.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Политика обнаружения изменений данных для источника данных.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	Политика обнаружения удаления данных для источника данных.
description	string	Описание источника данных.
encryptionKey	SearchResourceEncryptionKey	Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для предоставления дополнительного уровня шифрования неактивных данных для определения источника данных, если требуется полная уверенность в том, что никто, даже не Корпорация Майкрософт, не может расшифровать определение источника данных. После шифрования определения источника данных он всегда будет оставаться зашифрованным. Служба поиска игнорирует попытки задать для этого свойства значение NULL. Это свойство можно изменить по мере необходимости, если вы хотите повернуть ключ шифрования; Определение источника данных не будет затронуто. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
name	string	Имя источника данных.
type	SearchIndexerDataSourceType	Тип источника данных.

SearchIndexerDataSourceType

Перечисление

Определяет тип источника данных.

Значение	Описание
azuresql	Указывает источник данных SQL Azure.
cosmosdb	Указывает источник данных CosmosDB.
azureblob	Указывает источник данных BLOB-объектов Azure.
azuretable	Указывает источник данных таблицы Azure.
mysql	Указывает источник данных MySql.
adlsgen2	Указывает источник данных ADLS 2-го поколения.

SearchResourceEncryptionKey

Объект

Ключ шифрования, управляемый клиентом, в Azure Key Vault. Ключи, которые создаются и управляются, можно использовать для шифрования или расшифровки неактивных данных в службе поиска, таких как индексы и карты синонимов.

Имя	Тип	Описание
accessCredentials	AzureActiveDirectoryApplicationCredentials	Необязательные учетные данные Azure Active Directory, используемые для доступа к Azure Key Vault. Не требуется, если вместо этого используется управляемое удостоверение.
keyVaultKeyName	string	Имя ключа Azure Key Vault, используемого для шифрования неактивных данных.
keyVaultKeyVersion	string	Версия ключа Azure Key Vault, используемая для шифрования неактивных данных.
keyVaultUri	string	Универсальный код ресурса (URI) Хранилища ключей Azure, который также называется DNS-именем, который содержит ключ, используемый для шифрования неактивных данных. Пример URI может быть `https://my-keyvault-name.vault.azure.net`.

SoftDeleteColumnDeletionDetectionPolicy

Объект

Определяет политику обнаружения удаления данных, реализующую стратегию обратимого удаления. Он определяет, следует ли удалять элемент на основе значения указанного столбца обратимого удаления.

Имя	Тип	Описание
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	Фрагмент URI, указывающий тип политики обнаружения удаления данных.
softDeleteColumnName	string	Имя столбца, используемого для обнаружения обратимого удаления.
softDeleteMarkerValue	string	Значение маркера, определяющее элемент как удаленный.

SqlIntegratedChangeTrackingPolicy

Объект

Определяет политику обнаружения изменений данных, которая фиксирует изменения с помощью функции встроенного отслеживания изменений базы данных SQL Azure.

Имя	Тип	Описание
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	Фрагмент URI, указывающий тип политики обнаружения изменений данных.