SearchIndexClient.CreateOrUpdateSynonymMapAsync Method

Reference

Definition

Namespace:: Azure.Search.Documents.Indexes

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.5.1

Package:: Azure.Search.Documents v11.6.0-beta.3

Source:: SearchIndexClient.cs

Source:: SearchIndexClient.Aliases.cs

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.

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

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SynonymMap>> CreateOrUpdateSynonymMapAsync (Azure.Search.Documents.Indexes.Models.SynonymMap synonymMap, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateOrUpdateSynonymMapAsync : Azure.Search.Documents.Indexes.Models.SynonymMap * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SynonymMap>>
override this.CreateOrUpdateSynonymMapAsync : Azure.Search.Documents.Indexes.Models.SynonymMap * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SynonymMap>>

Public Overridable Function CreateOrUpdateSynonymMapAsync (synonymMap As SynonymMap, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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

Task<Response<SynonymMap>>

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

ArgumentNullException

Thrown when synonymMap is null.

RequestFailedException

Thrown when a failure is returned by the Search service.

Applies to