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

Data Sources - Get

服务:
Search Service
API 版本:
2025-08-01-preview

检索数据源定义。

GET {endpoint}/datasources('{dataSourceName}')?api-version=2025-08-01-preview

URI 参数

名称 在 必需 类型 说明
dataSourceName
 path True

string

要检索的数据源的名称。
endpoint
 path True

string

搜索服务的终结点 URL。
api-version
 query True

string

客户端 API 版本。

请求头

名称 必需 类型 说明
x-ms-client-request-id

string (uuid)

随请求一起发送的跟踪 ID，以帮助调试。

响应

名称 类型 说明
200 OK

SearchIndexerDataSource

Other Status Codes

ErrorResponse

错误响应。

示例

SearchServiceGetDataSource

示例请求

GET https://previewexampleservice.search.windows.net/datasources('mydocdbdatasource')?api-version=2025-08-01-preview

示例响应

状态代码:
200 
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "mydocdbdatasource",
  "description": "My Azure Adls Gen2 data source with ACLs.",
  "type": "adlsgen2",
  "indexerPermissionOptions": [
    "userIds",
    "groupIds",
    "rbacScope"
  ],
  "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"
  }
}

定义

名称 说明
AzureActiveDirectoryApplicationCredentials

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

表示可用于连接到数据源的凭据。
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
HighWaterMarkChangeDetectionPolicy

定义数据更改检测策略，该策略根据高水位线列的值捕获更改。
IndexerPermissionOption

具有各种类型的权限数据以建立索引的选项。
NativeBlobSoftDeleteDeletionDetectionPolicy

定义数据删除检测策略，利用 Azure Blob 存储的本机软删除功能进行删除检测。
SearchIndexerDataContainer

表示有关将编制索引的实体（例如 Azure SQL 表或 CosmosDB 集合）的信息。
SearchIndexerDataNoneIdentity

清除数据源的标识属性。
SearchIndexerDataSource

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

定义数据源的类型。
SearchIndexerDataUserAssignedIdentity

指定要使用的数据源的标识。
SearchResourceEncryptionKey

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

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

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

AzureActiveDirectoryApplicationCredentials

对象

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

名称 类型 说明
applicationId

string

向 Azure Key Vault 授予所需的访问权限的 AAD 应用程序 ID，该权限将在加密静态数据时使用。 应用程序 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

高水位线列的名称。

IndexerPermissionOption

枚举

具有各种类型的权限数据以建立索引的选项。

值 说明
userIds

索引器，用于将 ACL userId 从数据源引入索引。
groupIds

索引器，用于将 ACL groupIds 从数据源引入索引。
rbacScope

索引器，用于将 Azure RBAC 范围从数据源引入索引。

NativeBlobSoftDeleteDeletionDetectionPolicy

对象

定义数据删除检测策略，利用 Azure Blob 存储的本机软删除功能进行删除检测。

名称 类型 说明
@odata.type string:

#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy

指定数据删除检测策略类型的 URI 片段。

SearchIndexerDataContainer

对象

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

名称 类型 说明
name

string

将编制索引的表或视图（对于 Azure SQL 数据源）或集合（对于 CosmosDB 数据源）的名称。
query

string

应用于此数据容器的查询。 此参数的语法和含义特定于数据源。 Azure SQL 数据源不支持。

SearchIndexerDataNoneIdentity

对象

清除数据源的标识属性。

名称 类型 说明
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

指定身份类型的 URI 片段。

SearchIndexerDataSource

对象

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

名称 类型 说明
@odata.etag

string

数据源的 ETag。
container

SearchIndexerDataContainer

数据源的数据容器。
credentials

DataSourceCredentials

数据源的凭据。
dataChangeDetectionPolicy DataChangeDetectionPolicy:

数据源的数据更改检测策略。
dataDeletionDetectionPolicy DataDeletionDetectionPolicy:

数据源的数据删除检测策略。
description

string

数据源的描述。
encryptionKey

SearchResourceEncryptionKey

在 Azure Key Vault 中创建的加密密钥的说明。 当想要完全保证没有人（甚至 Microsoft）无法解密数据源定义时，此密钥用于为数据源定义提供额外的静态加密级别。 加密数据源定义后，它将始终保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果要轮换加密密钥，可以根据需要更改此属性;您的数据源定义将不受影响。 使用客户管理的密钥进行加密不适用于免费搜索服务，仅适用于 2019 年 1 月 1 日或之后创建的付费服务。
identity SearchIndexerDataIdentity:

用于此数据源的显式托管标识。 如果未指定，并且连接字符串是托管标识，则使用系统分配的托管标识。 如果未指定，则该值保持不变。 如果指定了“none”，则清除此属性的值。
indexerPermissionOptions

IndexerPermissionOption[]

具有各种类型权限数据的摄取选项。
name

string

数据源的名称。
subType

string

特定类型的数据源，以防资源支持不同的模式。 例如，某些“cosmosDb”帐户的“MongoDb”。
type

SearchIndexerDataSourceType

数据源的类型。

SearchIndexerDataSourceType

枚举

定义数据源的类型。

值 说明
azuresql

指示 Azure SQL 数据源。
cosmosdb

指示 CosmosDB 数据源。
azureblob

指示 Azure Blob 数据源。
azuretable

指示 Azure 表数据源。
mysql

表示 MySQL 数据源。
adlsgen2

指示 ADLS Gen2 数据源。
onelake

指示 Microsoft Fabric OneLake 数据源。

SearchIndexerDataUserAssignedIdentity

对象

指定要使用的数据源的标识。

名称 类型 说明
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

指定身份类型的 URI 片段。
userAssignedIdentity

string

用户分配的托管标识的完全限定的 Azure 资源 ID，通常采用“/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId”的形式，应分配给搜索服务。

SearchResourceEncryptionKey

对象

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

名称 类型 说明
accessCredentials

AzureActiveDirectoryApplicationCredentials

用于访问 Azure Key Vault 的可选 Azure Active Directory 凭据。 如果改用托管标识，则不需要。
identity SearchIndexerDataIdentity:

用于此加密密钥的显式托管标识。 如果未指定且访问凭据属性为 null，则使用系统分配的托管标识。 更新资源时，如果未指定显式标识，则该标识保持不变。 如果指定了“none”，则清除此属性的值。
keyVaultKeyName

string

用于加密静态数据的 Azure Key Vault 密钥的名称。
keyVaultKeyVersion

string

用于加密静态数据的 Azure Key Vault 密钥版本。
keyVaultUri

string

Azure 密钥保管库的 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 片段。