Data Sources - Create

Служба:: Search Service

Версия API:: 2025-08-01-preview

Создает новый источник данных.

POST {endpoint}/datasources?api-version=2025-08-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	URL-адрес конечной точки службы поиска.
api-version	query	True	string	Версия API клиента.

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

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

Текст запроса

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

Ответы

Имя	Тип	Описание
201 Created	SearchIndexerDataSource
Other Status Codes	ErrorResponse	Ответ на ошибку.

Примеры

SearchServiceCreateDataSource

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

HTTP

POST https://previewexampleservice.search.windows.net/datasources?api-version=2025-08-01-preview


{
  "name": "tempdatasource",
  "description": "My Azure Blob data source.",
  "type": "azureblob",
  "credentials": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net "
  },
  "container": {
    "name": "doc-extraction-skillset",
    "query": "E2E_Dsat"
  },
  "identity": {
    "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
  },
  "dataChangeDetectionPolicy": {
    "highWaterMarkColumnName": "metadata_storage_last_modified",
    "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy"
  },
  "dataDeletionDetectionPolicy": {
    "softDeleteColumnName": "isDeleted",
    "softDeleteMarkerValue": "true",
    "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy"
  },
  "@odata.etag": "0x1234568AE7E58A1"
}

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

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

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "tempdatasource",
  "description": "My Azure Blob data source.",
  "type": "azureblob",
  "indexerPermissionOptions": [],
  "credentials": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net "
  },
  "container": {
    "name": "doc-extraction-skillset",
    "query": "E2E_Dsat"
  },
  "dataChangeDetectionPolicy": {
    "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy",
    "highWaterMarkColumnName": "metadata_storage_last_modified"
  },
  "dataDeletionDetectionPolicy": {
    "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy",
    "softDeleteColumnName": "isDeleted",
    "softDeleteMarkerValue": "true"
  },
  "identity": {
    "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
  }
}

Определения

Имя	Описание
AzureActiveDirectoryApplicationCredentials	Учетные данные зарегистрированного приложения, созданного для службы поиска, используемого для доступа с проверкой подлинности к ключам шифрования, хранящимся в Azure Key Vault.
DataSourceCredentials	Представляет учетные данные, которые можно использовать для подключения к источнику данных.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
HighWaterMarkChangeDetectionPolicy	Определяет политику обнаружения изменений данных, которая фиксирует изменения на основе значения столбца высокой отметки.
IndexerPermissionOption	Варианты с различными типами разрешений на индексирование.
NativeBlobSoftDeleteDeletionDetectionPolicy	Определяет политику обнаружения удаления данных с помощью встроенной функции обратимого удаления Хранилища BLOB-объектов Azure для обнаружения удаления.
SearchIndexerDataContainer	Представляет сведения о сущности (например, таблице Azure SQL или коллекции CosmosDB), которая будет индексирована.
SearchIndexerDataNoneIdentity	Очищает свойство identity источника данных.
SearchIndexerDataSource	Представляет собой определение источника данных, которое можно использовать для настройки индексатора.
SearchIndexerDataSourceType	Определяет тип источника данных.
SearchIndexerDataUserAssignedIdentity	Указывает идентификатор для используемого источника данных.
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>` если вы хотите удалить значение строки подключения из источника данных.

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

Ответ на ошибку

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

HighWaterMarkChangeDetectionPolicy

Объект

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

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

IndexerPermissionOption

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

Варианты с различными типами разрешений на индексирование.

Значение	Описание
userIds	Индексатор для приема идентификаторов пользователей ACL из источника данных в индекс.
groupIds	Индексатор для приема идентификаторов группы ACL из источника данных в индекс.
rbacScope	Индексатор для приема области Azure RBAC из источника данных в индекс.

NativeBlobSoftDeleteDeletionDetectionPolicy

Объект

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

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

SearchIndexerDataContainer

Объект

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

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

SearchIndexerDataNoneIdentity

Объект

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

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

SearchIndexerDataSource

Объект

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

Имя	Тип	Описание
@odata.etag	string	ETag источника данных.
container	SearchIndexerDataContainer	Контейнер данных для источника данных.
credentials	DataSourceCredentials	Учетные данные для источника данных.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Политика обнаружения изменений данных для источника данных.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: NativeBlobSoftDeleteDeletionDetectionPolicy SoftDeleteColumnDeletionDetectionPolicy	Политика обнаружения удаления данных для источника данных.
description	string	Описание источника данных.
encryptionKey	SearchResourceEncryptionKey	Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для обеспечения дополнительного уровня шифрования неактивных данных для определения источника данных, когда требуется полная уверенность в том, что никто, даже корпорация Майкрософт, не сможет расшифровать определение источника данных. После шифрования определения источника данных оно всегда будет оставаться зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника данных не будет затронуто. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных поисковых служб и доступно только для платных служб, созданных 1 января 2019 г. или позже.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Явное управляемое удостоверение для использования для этого источника данных. Если строка подключения не указана и является управляемым удостоверением, используется управляемое удостоверение, назначенное системой. Если значение не указано, оно остается неизменным. Если указано значение "none", значение этого свойства сбрасывается.
indexerPermissionOptions	IndexerPermissionOption[]	Варианты приема с различными типами данных разрешений.
name	string	Имя источника данных.
subType	string	Конкретный тип источника данных, в случае, если ресурс способен к различным модальностям. Например, «MongoDb» для определенных учетных записей «cosmosDb».
type	SearchIndexerDataSourceType	Тип источника данных.

SearchIndexerDataSourceType

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

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

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

SearchIndexerDataUserAssignedIdentity

Объект

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

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

SearchResourceEncryptionKey

Объект

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

Имя	Тип	Описание
accessCredentials	AzureActiveDirectoryApplicationCredentials	Необязательные учетные данные Azure Active Directory, используемые для доступа к Azure Key Vault. Не требуется, если вместо этого используется управляемое удостоверение.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Явное управляемое удостоверение, используемое для этого ключа шифрования. Если значение не указано и свойство учетных данных для доступа равно null, используется управляемое удостоверение, назначенное системой. При обновлении ресурса, если явное удостоверение не указано, оно остается неизменным. Если указано значение "none", значение этого свойства сбрасывается.
keyVaultKeyName	string	Имя ключа Azure Key Vault, который будет использоваться для шифрования неактивных данных.
keyVaultKeyVersion	string	Версия ключа Azure Key Vault, который будет использоваться для шифрования неактивных данных.
keyVaultUri	string	URI Azure Key Vault, также называемый 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), указывающий тип политики обнаружения изменения данных.