SynonymMap interface

Package:

@azure/search-documents

Represents a synonym map definition.

Properties

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 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.
etag	The ETag of the synonym map.
name	The name of the synonym map.
synonyms	An array of synonym rules in the specified synonym map format.

Property Details

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

encryptionKey?: SearchResourceEncryptionKey

Property Value

SearchResourceEncryptionKey

etag

The ETag of the synonym map.

etag?: string

Property Value

string

name

The name of the synonym map.

name: string

Property Value

string

synonyms

An array of synonym rules in the specified synonym map format.

synonyms: string[]

Property Value

string[]