SearchIndexClient.GetSynonymMaps(CancellationToken) Method

Definition

Gets a list of all synonym maps.

public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Search.Documents.Indexes.Models.SynonymMap>> GetSynonymMaps (System.Threading.CancellationToken cancellationToken = default);
abstract member GetSynonymMaps : System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Search.Documents.Indexes.Models.SynonymMap>>
override this.GetSynonymMaps : System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Search.Documents.Indexes.Models.SynonymMap>>
Public Overridable Function GetSynonymMaps (Optional cancellationToken As CancellationToken = Nothing) As 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