Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SynonymMap

Package version

Represents a synonym map definition. Represents a synonym map definition.

Hierarchy

  • SynonymMap

Index

Properties

Optional encryptionKey

encryptionKey: SearchResourceEncryptionKey | null

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 data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, 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 data 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 data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, 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 data 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 synonym map. The ETag of the synonym map.

format

format: "solr"

The format of the synonym map. Only the 'solr' format is currently supported.

name

name: string

The name of the synonym map. The name of the synonym map.

synonyms

synonyms: string[]

A series of synonym rules in the specified synonym map format. The rules must be separated by newlines. An array of synonym rules in the specified synonym map format.

Generated using TypeDoc