Share via


SearchIndexClient.CreateOrUpdateSynonymMap Method

Definition

Creates a new synonym map or updates an existing synonym map.

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

Parameters

synonymMap
SynonymMap

Required. The SynonymMap to create or update.

onlyIfUnchanged
Boolean

True to throw a RequestFailedException if the ETag does not match the current service version; otherwise, the current service version will be overwritten.

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