Share via


SearchIndexClient.GetSynonymMapAsync(String, CancellationToken) Method

Definition

Gets a specific SynonymMap.

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

Parameters

synonymMapName
String

Required. The name of the SynonymMap to get.

cancellationToken
CancellationToken

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

Returns

The Response<T> from the server containing the requested SynonymMap.

Exceptions

Thrown when synonymMapName is null.

Thrown when a failure is returned by the Search service.

Applies to