Data Sources - Get

Служба:: Search Service

Версия API:: 2026-04-01

Извлекает определение источника данных.

GET {endpoint}/datasources('{dataSourceName}')?api-version=2026-04-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
dataSourceName	path	True	string	Имя источника данных.
endpoint	path	True	string (uri)	URL-адрес конечной точки службы поиска.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

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

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

Ответы

Имя	Тип	Описание
200 OK	SearchIndexerDataSource	Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

api-key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://search.azure.com/.default

Примеры

SearchServiceGetDataSource

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

HTTP

GET https://exampleservice.search.windows.net/datasources('mydocdbdatasource')?api-version=2026-04-01

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

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

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "mydocdbdatasource",
  "description": "My Azure Adls Gen2 data source with ACLs.",
  "type": "adlsgen2",
  "credentials": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net "
  },
  "container": {
    "name": "adls-gen2-doc-extraction-acl",
    "query": "folder_has_final_acl"
  },
  "dataChangeDetectionPolicy": {
    "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy",
    "highWaterMarkColumnName": "metadata_storage_last_modified"
  },
  "dataDeletionDetectionPolicy": {
    "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy",
    "softDeleteColumnName": "isDeleted",
    "softDeleteMarkerValue": "true"
  }
}

Определения

Имя	Описание
Accept	Заголовок Accept.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
HighWaterMarkChangeDetectionPolicy	Определяет политику обнаружения изменений данных, которая фиксирует изменения в зависимости от значения столбца высокой водяной отметки.
NativeBlobSoftDeleteDeletionDetectionPolicy	Определяет политику обнаружения удаления данных, используюющую собственную функцию обратимого удаления хранилища BLOB-объектов Azure для обнаружения удаления.
SearchIndexerDataContainer	Представляет сведения о сущности (например, таблице SQL Azure или коллекции CosmosDB), которая будет индексирована.
SearchIndexerDataNoneIdentity	Очищает свойство удостоверения источника данных.
SearchIndexerDataSource	Представляет определение источника данных, которое можно использовать для настройки индексатора.
SearchIndexerDataSourceType	Определяет тип источника данных.
SearchIndexerDataUserAssignedIdentity	Указывает удостоверение для используемого источника данных.
SearchResourceEncryptionKey	Ключ шифрования, управляемый клиентом, в Azure Key Vault. Ключи, которые вы создаете и которыми управляете, можно использовать для шифрования или расшифровки хранимых данных, таких как индексы и сопоставления синонимов.
SoftDeleteColumnDeletionDetectionPolicy	Определяет политику обнаружения удаления данных, реализующую стратегию обратимого удаления. Он определяет, следует ли удалять элемент на основе значения указанного столбца обратимого удаления.
SqlIntegratedChangeTrackingPolicy	Определяет политику обнаружения изменений данных, которая фиксирует изменения с помощью функции встроенного отслеживания изменений базы данных SQL Azure.

Accept

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

Заголовок Accept.

Значение	Описание
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info		Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

HighWaterMarkChangeDetectionPolicy

Объект

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

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

NativeBlobSoftDeleteDeletionDetectionPolicy

Объект

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

Имя	Тип	Описание
@odata.type	string: #Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy	Дискриминатор производных типов.

SearchIndexerDataContainer

Объект

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

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

SearchIndexerDataNoneIdentity

Объект

Очищает свойство удостоверения источника данных.

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

SearchIndexerDataSource

Объект

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

Имя	Тип	Описание
@odata.etag	string	ETag источника данных.
container	SearchIndexerDataContainer	Контейнер данных для источника данных.
credentials.connectionString	string	Строка подключения для источника данных. Установите значение `<unchanged>` (в квадратных скобках), если вы не хотите обновлять строку подключения. Задайте значение, `<redacted>` если вы хотите удалить значение строки подключения из источника данных.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Политика обнаружения изменений данных для источника данных.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: NativeBlobSoftDeleteDeletionDetectionPolicy SoftDeleteColumnDeletionDetectionPolicy	Политика обнаружения удаления данных для источника данных.
description	string	Описание источника данных.
encryptionKey	SearchResourceEncryptionKey	Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для обеспечения дополнительного уровня шифрования неактивных данных для определения источника данных, когда требуется полная уверенность в том, что никто, даже корпорация Майкрософт, не сможет расшифровать определение источника данных. После шифрования определения источника данных он всегда будет оставаться зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Это свойство можно изменить по мере необходимости, если вы хотите повернуть ключ шифрования; Определение источника данных не будет затронуто. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Явное управляемое удостоверение, используемое для этого источника данных. Если строка подключения не указана, то используется управляемое удостоверение, назначаемое системой управляемое удостоверение. Если значение не указано, значение остается неизменным. Если задано значение none, то значение этого свойства очищается.
name	string	Имя источника данных.
type	SearchIndexerDataSourceType	Тип источника данных.

SearchIndexerDataSourceType

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

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

Значение	Описание
azuresql	Указывает на источник данных Azure SQL.
cosmosdb	Указывает источник данных CosmosDB.
azureblob	Указывает на источник данных Azure BLOB.
azuretable	Указывает на источник данных Azure Table.
mysql	Указывает на источник данных MySql.
adlsgen2	Указывает на источник данных ADLS 2-го поколения.
onelake	Указывает на источник данных OneLake для Microsoft Fabric.
sharepoint	Указывает на источник данных SharePoint.

SearchIndexerDataUserAssignedIdentity

Объект

Указывает удостоверение для используемого источника данных.

Имя	Тип	Описание
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Фрагмент URI, указывающий тип удостоверения.
userAssignedIdentity	string	Полный идентификатор ресурса Azure назначаемого пользователем управляемого удостоверения обычно в форме "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", который должен быть назначен службе поиска.

SearchResourceEncryptionKey

Объект

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

Имя	Тип	Описание
accessCredentials.applicationId	string	Идентификатор приложения AAD, которому было предоставлено необходимые разрешения на доступ к Azure Key Vault, который будет использоваться при шифровании неактивных данных. Идентификатор приложения не следует путать с идентификатором объекта для приложения AAD.
accessCredentials.applicationSecret	string	Ключ проверки подлинности указанного приложения AAD.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Явное управляемое удостоверение, используемое для этого ключа шифрования. Если не указано, а свойство учетных данных доступа равно NULL, используется управляемое удостоверение, назначаемое системой. При обновлении ресурса, если явное удостоверение не указано, оно остается неизменным. Если задано значение none, то значение этого свойства очищается.
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	Дискриминатор производных типов.
softDeleteColumnName	string	Имя столбца, используемого для обнаружения обратимого удаления.
softDeleteMarkerValue	string	Значение маркера, определяющее элемент как удаленный.

SqlIntegratedChangeTrackingPolicy

Объект

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

Имя	Тип	Описание
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	Дискриминатор производных типов.