Share via


SearchIndexClient.GetSynonymMap(String, CancellationToken) Method

Definition

Gets a specific SynonymMap.

public virtual Azure.Response<Azure.Search.Documents.Indexes.Models.SynonymMap> GetSynonymMap (string synonymMapName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSynonymMap : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SynonymMap>
override this.GetSynonymMap : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SynonymMap>
Public Overridable Function GetSynonymMap (synonymMapName As String, Optional cancellationToken As CancellationToken = Nothing) As 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