Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SearchIndexer

Package version

Represents an indexer. Represents an indexer.

Hierarchy

  • SearchIndexer

Index

Properties

Optional cache

Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time. 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. The name of the datasource from which this indexer reads data.

Optional description

description: undefined | string

The description of the indexer. The description of the indexer.

Optional 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. 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.

Optional etag

etag: undefined | string

The ETag of the indexer. The ETag of the indexer.

Optional fieldMappings

fieldMappings: FieldMapping[]

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

Optional isDisabled

isDisabled: undefined | false | true

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

name

name: string

The name of the indexer. The name of the indexer.

Optional outputFieldMappings

outputFieldMappings: FieldMapping[]

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

Optional parameters

parameters: IndexingParameters

Parameters for indexer execution. Parameters for indexer execution.

Optional schedule

The schedule for this indexer. The schedule for this indexer.

Optional skillsetName

skillsetName: undefined | string

The name of the skillset executing with this indexer. The name of the skillset executing with this indexer.

targetIndexName

targetIndexName: string

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

Generated using TypeDoc