SearchIndexClient.GetSynonymMapsAsync(CancellationToken) Method

Definition

Gets a list of all synonym maps.

public virtual System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Search.Documents.Indexes.Models.SynonymMap>>> GetSynonymMapsAsync (System.Threading.CancellationToken cancellationToken = default);
abstract member GetSynonymMapsAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Search.Documents.Indexes.Models.SynonymMap>>>
override this.GetSynonymMapsAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Search.Documents.Indexes.Models.SynonymMap>>>
Public Overridable Function GetSynonymMapsAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IReadOnlyList(Of SynonymMap)))

Parameters

cancellationToken
CancellationToken

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

Returns

The Response<T> from the server containing a list of SynonymMap.

Exceptions

Thrown when a failure is returned by the Search service.

Applies to