SearchIndexClient.GetIndexNamesAsync(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.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 index names.

public virtual Azure.AsyncPageable<string> GetIndexNamesAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member GetIndexNamesAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<string>
override this.GetIndexNamesAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<string>

Public Overridable Function GetIndexNamesAsync (Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of String)

Parameters

cancellationToken: CancellationToken

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

Returns

AsyncPageable<String>

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

Exceptions

RequestFailedException

Thrown when a failure is returned by the Search service.

Applies to