SearchIndexClient.GetIndexNames(CancellationToken) Method

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
SearchIndexClient.cs
Source:
SearchIndexClient.cs

Gets a list of all index names.

public virtual Azure.Pageable<string> GetIndexNames (System.Threading.CancellationToken cancellationToken = default);
abstract member GetIndexNames : System.Threading.CancellationToken -> Azure.Pageable<string>
override this.GetIndexNames : System.Threading.CancellationToken -> Azure.Pageable<string>
Public Overridable Function GetIndexNames (Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of String)

Parameters

cancellationToken
CancellationToken

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

Returns

Pageable<String>

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

Exceptions

RequestFailedException

Thrown when a failure is returned by the Search service.

Applies to