SearchIndexer interface

Package:

@azure/search-documents

Represents an indexer.

Properties

dataSourceName	The name of the datasource from which this indexer reads data.
description	The description of the indexer.
encryptionKey	A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them in Azure Cognitive Search. Once you have encrypted your indexer definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.
etag	The ETag of the indexer.
fieldMappings	Defines mappings between fields in the data source and corresponding target fields in the index.
isDisabled	A value indicating whether the indexer is disabled. Default is false. Default value: false.
name	The name of the indexer.
outputFieldMappings	Output field mappings are applied after enrichment and immediately before indexing.
parameters	Parameters for indexer execution.
schedule	The schedule for this indexer.
skillsetName	The name of the skillset executing with this indexer.
targetIndexName	The name of the index to which this indexer writes data.

Property Details

dataSourceName

The name of the datasource from which this indexer reads data.

dataSourceName: string

Property Value

string

description

The description of the indexer.

description?: string

Property Value

string

encryptionKey

A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them in Azure Cognitive Search. Once you have encrypted your indexer definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.

encryptionKey?: SearchResourceEncryptionKey

Property Value

SearchResourceEncryptionKey

etag

The ETag of the indexer.

etag?: string

Property Value

string

fieldMappings

Defines mappings between fields in the data source and corresponding target fields in the index.

fieldMappings?: FieldMapping[]

Property Value

FieldMapping[]

isDisabled

A value indicating whether the indexer is disabled. Default is false. Default value: false.

isDisabled?: boolean

Property Value

boolean

name

The name of the indexer.

name: string

Property Value

string

outputFieldMappings

Output field mappings are applied after enrichment and immediately before indexing.

outputFieldMappings?: FieldMapping[]

Property Value

FieldMapping[]

parameters

Parameters for indexer execution.

parameters?: IndexingParameters

Property Value

IndexingParameters

schedule

The schedule for this indexer.

schedule?: IndexingSchedule

Property Value

IndexingSchedule

skillsetName

The name of the skillset executing with this indexer.

skillsetName?: string

Property Value

string

targetIndexName

The name of the index to which this indexer writes data.

targetIndexName: string

Property Value

string