SearchIndexer Class

Definition

Represents an indexer.

public class SearchIndexer
type SearchIndexer = class
Public Class SearchIndexer
Inheritance
SearchIndexer

Constructors

SearchIndexer(String, String, String)

Initializes a new instance of SearchIndexer.

Properties

Cache

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

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. Once you have encrypted your indexer definition, it will always remain encrypted. The search service 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 SearchIndexer.

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.

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.

Applies to