SearchIndexClient.GetAliases(CancellationToken) Method

Reference

Definition

Namespace:: Azure.Search.Documents.Indexes

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.6.0-beta.3

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 alias definitions available for a search service.

public virtual Azure.Pageable<Azure.Search.Documents.Indexes.Models.SearchAlias> GetAliases (System.Threading.CancellationToken cancellationToken = default);

abstract member GetAliases : System.Threading.CancellationToken -> Azure.Pageable<Azure.Search.Documents.Indexes.Models.SearchAlias>
override this.GetAliases : System.Threading.CancellationToken -> Azure.Pageable<Azure.Search.Documents.Indexes.Models.SearchAlias>

Public Overridable Function GetAliases (Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of SearchAlias)

Parameters

cancellationToken: CancellationToken

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

Returns

Pageable<SearchAlias>

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

Exceptions

RequestFailedException

Thrown when a failure is returned by the Search service.

Applies to