SearchIndexClient.GetSynonymMapsAsync(CancellationToken) 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.

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

Task<Response<IReadOnlyList<SynonymMap>>>

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

Exceptions

RequestFailedException

Thrown when a failure is returned by the Search service.

Applies to