SearchIndexClient.GetIndexStatsSummaryAsync(CancellationToken) Method

Definition

Namespace:: Azure.Search.Documents.Indexes

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.7.0-beta.5

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.

Retrieves a summary of statistics for all indexes in the search service.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.ListIndexStatsSummary>> GetIndexStatsSummaryAsync(System.Threading.CancellationToken cancellationToken = default);

abstract member GetIndexStatsSummaryAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.ListIndexStatsSummary>>
override this.GetIndexStatsSummaryAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.ListIndexStatsSummary>>

Public Overridable Function GetIndexStatsSummaryAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ListIndexStatsSummary))

Parameters

cancellationToken: CancellationToken

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

Returns

Task<Response<ListIndexStatsSummary>>

The Response<T> from the server containing ListIndexStatsSummary.

Exceptions

RequestFailedException

Thrown when a failure is returned by the Search service.

Applies to