你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Data Sources - Create

参考

服务:: Search Service

API 版本:: 2024-07-01

创建新的数据源。

POST {endpoint}/datasources?api-version=2024-07-01

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	搜索服务的终结点 URL。
api-version	query	True	string	客户端 API 版本。

请求头

名称	必需	类型	说明
x-ms-client-request-id		string uuid	随请求一起发送的跟踪 ID，以帮助进行调试。

请求正文

名称	必需	类型	说明
container	True	SearchIndexerDataContainer	数据源的数据容器。
credentials	True	DataSourceCredentials	数据源的凭据。
name	True	string	数据源的名称。
type	True	SearchIndexerDataSourceType	数据源的类型。
@odata.etag		string	数据源的 ETag。
dataChangeDetectionPolicy		DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	数据源的数据更改检测策略。
dataDeletionDetectionPolicy		DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	数据源的数据删除检测策略。
description		string	数据源的说明。
encryptionKey		SearchResourceEncryptionKey	描述在 Azure Key Vault 中创建的加密密钥。如果希望完全保证没有人（甚至Microsoft）可以解密数据源定义，则此密钥用于为数据源定义提供额外的静态加密级别。加密数据源定义后，它将始终保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果需要轮换加密密钥，可以根据需要更改此属性;数据源定义将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。

响应

名称	类型	说明
201 Created	SearchIndexerDataSource
Other Status Codes	ErrorResponse	错误响应。

示例

SearchServiceCreateDataSource

示例请求

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

示例响应

状态代码:: 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
    }
  }
}

定义

名称	说明
AzureActiveDirectoryApplicationCredentials	为搜索服务创建的已注册应用程序的凭据，用于对 Azure Key Vault 中存储的加密密钥进行身份验证的访问权限。
DataSourceCredentials	表示可用于连接到数据源的凭据。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
HighWaterMarkChangeDetectionPolicy	定义数据更改检测策略，该策略根据高水印列的值捕获更改。
SearchIndexerDataContainer	表示要编制索引的实体（如 Azure SQL 表或 CosmosDB 集合）的相关信息。
SearchIndexerDataSource	表示可用于配置索引器的数据源定义。
SearchIndexerDataSourceType	定义数据源的类型。
SearchResourceEncryptionKey	Azure Key Vault 中的客户管理的加密密钥。创建和管理的密钥可用于加密或解密静态数据，例如索引和同义词映射。
SoftDeleteColumnDeletionDetectionPolicy	定义实现软删除策略的数据删除检测策略。它确定是否应根据指定的“软删除”列的值删除项。
SqlIntegratedChangeTrackingPolicy	定义使用 Azure SQL 数据库的集成更改跟踪功能捕获更改的数据更改检测策略。

AzureActiveDirectoryApplicationCredentials

为搜索服务创建的已注册应用程序的凭据，用于对 Azure Key Vault 中存储的加密密钥进行身份验证的访问权限。

名称	类型	说明
applicationId	string	向 AAD 应用程序 ID 授予对静态数据加密时要使用的 Azure Key Vault 所需的访问权限。应用程序 ID 不应与 AAD 应用程序的对象 ID 混淆。
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	高水印列的名称。

SearchIndexerDataContainer

表示要编制索引的实体（如 Azure SQL 表或 CosmosDB 集合）的相关信息。

名称	类型	说明
name	string	要编制索引的表或视图的名称（适用于 Azure SQL 数据源）或集合（适用于 CosmosDB 数据源）。
query	string	应用于此数据容器的查询。此参数的语法和含义特定于数据源。 Azure SQL 数据源不支持。

SearchIndexerDataSource

表示可用于配置索引器的数据源定义。

名称	类型	说明
@odata.etag	string	数据源的 ETag。
container	SearchIndexerDataContainer	数据源的数据容器。
credentials	DataSourceCredentials	数据源的凭据。
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	数据源的数据更改检测策略。
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	数据源的数据删除检测策略。
description	string	数据源的说明。
encryptionKey	SearchResourceEncryptionKey	描述在 Azure Key Vault 中创建的加密密钥。如果希望完全保证没有人（甚至Microsoft）可以解密数据源定义，则此密钥用于为数据源定义提供额外的静态加密级别。加密数据源定义后，它将始终保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果需要轮换加密密钥，可以根据需要更改此属性;数据源定义将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
name	string	数据源的名称。
type	SearchIndexerDataSourceType	数据源的类型。

SearchIndexerDataSourceType

定义数据源的类型。

名称	类型	说明
adlsgen2	string	指示 ADLS Gen2 数据源。
azureblob	string	指示 Azure Blob 数据源。
azuresql	string	指示 Azure SQL 数据源。
azuretable	string	指示 Azure 表数据源。
cosmosdb	string	指示 CosmosDB 数据源。
mysql	string	指示 MySql 数据源。

SearchResourceEncryptionKey

Azure Key Vault 中的客户管理的加密密钥。创建和管理的密钥可用于加密或解密静态数据，例如索引和同义词映射。

名称	类型	说明
accessCredentials	AzureActiveDirectoryApplicationCredentials	用于访问 Azure Key Vault 的可选 Azure Active Directory 凭据。如果改用托管标识，则不需要。
keyVaultKeyName	string	用于加密静态数据的 Azure Key Vault 密钥的名称。
keyVaultKeyVersion	string	用于加密静态数据的 Azure Key Vault 密钥的版本。
keyVaultUri	string	Azure Key Vault 的 URI（也称为 DNS 名称），其中包含用于加密静态数据的密钥。示例 URI 可能是 `https://my-keyvault-name.vault.azure.net`。

SoftDeleteColumnDeletionDetectionPolicy

定义实现软删除策略的数据删除检测策略。它确定是否应根据指定的“软删除”列的值删除项。

名称	类型	说明
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	指定数据删除检测策略类型的 URI 片段。
softDeleteColumnName	string	用于软删除检测的列的名称。
softDeleteMarkerValue	string	将项标识为已删除的标记值。

SqlIntegratedChangeTrackingPolicy

定义使用 Azure SQL 数据库的集成更改跟踪功能捕获更改的数据更改检测策略。

名称	类型	说明
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	指定数据更改检测策略类型的 URI 片段。

通过