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

SearchIndexer interface

包:

@azure/search-documents

表示索引器。

属性

dataSourceName	此索引器从中读取数据的数据源的名称。
description	索引器的说明。
encryptionKey	在 Azure 密钥保管库 中创建的加密密钥的说明。 此密钥用于为索引器定义 (提供额外的静态加密级别，以及索引器执行状态) （如果想要完全保证没有人（甚至 Microsoft）可以在Azure 认知搜索中解密它们。 加密索引器定义后，它将始终保持加密状态。 Azure 认知搜索将忽略将此属性设置为 null 的尝试。 如果要轮换加密密钥，可以根据需要更改此属性;索引器定义 (和索引器执行状态) 将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于 2019 年 1 月 1 日或之后创建的付费服务。
etag	索引器的 ETag。
fieldMappings	定义数据源中的字段与索引中相应目标字段之间的映射。
isDisabled	一个值，该值指示是否禁用索引器。 默认值为 false。 默认值：false。
name	索引器的名称。
outputFieldMappings	输出字段映射在扩充后应用，在编制索引之前立即应用。
parameters	索引器执行的参数。
schedule	此索引器的计划。
skillsetName	使用此索引器执行的技能组的名称。
targetIndexName	此索引器将数据写入到的索引的名称。

属性详细信息

dataSourceName

此索引器从中读取数据的数据源的名称。

dataSourceName: string

属性值

string

description

索引器的说明。

description?: string

属性值

string

encryptionKey

在 Azure 密钥保管库 中创建的加密密钥的说明。 此密钥用于为索引器定义 (提供额外的静态加密级别，以及索引器执行状态) （如果想要完全保证没有人（甚至 Microsoft）可以在Azure 认知搜索中解密它们。 加密索引器定义后，它将始终保持加密状态。 Azure 认知搜索将忽略将此属性设置为 null 的尝试。 如果要轮换加密密钥，可以根据需要更改此属性;索引器定义 (和索引器执行状态) 将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于 2019 年 1 月 1 日或之后创建的付费服务。

encryptionKey?: SearchResourceEncryptionKey

属性值

SearchResourceEncryptionKey

etag

索引器的 ETag。

etag?: string

属性值

string

fieldMappings

定义数据源中的字段与索引中相应目标字段之间的映射。

fieldMappings?: FieldMapping[]

属性值

FieldMapping[]

isDisabled

一个值，该值指示是否禁用索引器。 默认值为 false。 默认值：false。

isDisabled?: boolean

属性值

boolean

name

索引器的名称。

name: string

属性值

string

outputFieldMappings

输出字段映射在扩充后应用，在编制索引之前立即应用。

outputFieldMappings?: FieldMapping[]

属性值

FieldMapping[]

parameters

索引器执行的参数。

parameters?: IndexingParameters

属性值

IndexingParameters

schedule

此索引器的计划。

schedule?: IndexingSchedule

属性值

IndexingSchedule

skillsetName

使用此索引器执行的技能组的名称。

skillsetName?: string

属性值

string

targetIndexName

此索引器将数据写入到的索引的名称。

targetIndexName: string

属性值

string