SearchIndexClient.CreateSynonymMap(SynonymMap, CancellationToken) Method

Definition

Creates a new synonym map.

public virtual Azure.Response<Azure.Search.Documents.Indexes.Models.SynonymMap> CreateSynonymMap (Azure.Search.Documents.Indexes.Models.SynonymMap synonymMap, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateSynonymMap : Azure.Search.Documents.Indexes.Models.SynonymMap * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SynonymMap>
override this.CreateSynonymMap : Azure.Search.Documents.Indexes.Models.SynonymMap * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SynonymMap>
Public Overridable Function CreateSynonymMap (synonymMap As SynonymMap, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SynonymMap)

Parameters

synonymMap
SynonymMap

Required. The SynonymMap to create.

cancellationToken
CancellationToken

Optional CancellationToken to propagate notifications that the operation should be canceled.

Returns

The Response<T> from the server containing the SynonymMap that was created. This may differ slightly from what was passed in since the service may return back properties set to their default values.

Exceptions

Thrown when synonymMap is null.

Thrown when a failure is returned by the Search service.

Applies to