Share via


SearchIndexClient.GetAliasesAsync(CancellationToken) Method

Definition

Gets a list of all alias definitions available for a search service.

public virtual Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchAlias> GetAliasesAsync (System.Threading.CancellationToken cancellationToken = default);
abstract member GetAliasesAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchAlias>
override this.GetAliasesAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchAlias>
Public Overridable Function GetAliasesAsync (Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of SearchAlias)

Parameters

cancellationToken
CancellationToken

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

Returns

The Pageable<T> from the server containing a list of SearchAlias objects.

Exceptions

Thrown when a failure is returned by the Search service.

Applies to