SynonymMap Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a synonym map definition.
public class SynonymMap : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.SynonymMap>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.SynonymMap>type SynonymMap = class
interface IJsonModel<SynonymMap>
interface IPersistableModel<SynonymMap>Public Class SynonymMap
Implements IJsonModel(Of SynonymMap), IPersistableModel(Of SynonymMap)- Inheritance
-
SynonymMap
- Implements
Constructors
| SynonymMap(String, String) |
Initializes a new instance of the SynonymMap class. |
| SynonymMap(String, TextReader) |
Initializes a new instance of the SynonymMap class. |
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. Once you have encrypted your data, 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 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 SynonymMap. |
| Name |
The name of the synonym map. |
| Synonyms |
A series of synonym rules in the specified synonym map format. The rules must be separated by newlines. |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) |
Explicit Interface Implementations
| IJsonModel<SynonymMap>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<SynonymMap>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<SynonymMap>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<SynonymMap>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<SynonymMap>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
