Package version:

Interface SearchIndexer

Represents an indexer.

interface SearchIndexer {
    cache?: SearchIndexerCache;
    dataSourceName: string;
    description?: string;
    encryptionKey?: SearchResourceEncryptionKey;
    etag?: string;
    fieldMappings?: FieldMapping[];
    isDisabled?: boolean;
    name: string;
    outputFieldMappings?: FieldMapping[];
    parameters?: IndexingParameters;
    schedule?: IndexingSchedule;
    skillsetName?: string;
    targetIndexName: string;
}

Properties

cache? dataSourceName description? encryptionKey? etag? fieldMappings? isDisabled? name outputFieldMappings? parameters? schedule? skillsetName? targetIndexName

Properties

Optionalcache

cache?: SearchIndexerCache

Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time.

dataSourceName

dataSourceName: string

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

Optionaldescription

description?: string

The description of the indexer.

OptionalencryptionKey

encryptionKey?: SearchResourceEncryptionKey

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.

Optionaletag

etag?: string

The ETag of the indexer.

OptionalfieldMappings

fieldMappings?: FieldMapping[]

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

OptionalisDisabled

isDisabled?: boolean

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

name

name: string

The name of the indexer.

OptionaloutputFieldMappings

outputFieldMappings?: FieldMapping[]

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

Optionalparameters

parameters?: IndexingParameters

Parameters for indexer execution.

Optionalschedule

schedule?: IndexingSchedule

The schedule for this indexer.

OptionalskillsetName

skillsetName?: string

The name of the skillset executing with this indexer.

targetIndexName

targetIndexName: string

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

Settings

Member Visibility