SynonymMap Class

Represents a synonym map definition.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance

Model

SynonymMap

Constructor

SynonymMap(**kwargs)

Parameters

name

str

Required

Required. The name of the synonym map.

synonyms

list[str]

Required

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

encryption_key

SearchResourceEncryptionKey

Required

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.

e_tag

str

Required

The ETag of the synonym map.

Variables

format

str

Required. The format of the synonym map. Only the 'solr' format is currently supported. Default value: "solr".

Attributes

format

format = 'solr'