SearchIndexClient.GetIndexStatisticsAsync(String, 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.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 SearchIndexStatistics for the given index, including a document count and storage usage.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexStatistics>> GetIndexStatisticsAsync (string indexName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIndexStatisticsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexStatistics>>
override this.GetIndexStatisticsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexStatistics>>

Public Overridable Function GetIndexStatisticsAsync (indexName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SearchIndexStatistics))

Parameters

indexName: String

Required. The name of the index.

cancellationToken: CancellationToken

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

Returns

Task<Response<SearchIndexStatistics>>

The Response<T> from the server containing SearchIndexStatistics.

Exceptions

ArgumentNullException

Thrown when indexName is null.

RequestFailedException

Thrown when a failure is returned by the Search service.

Applies to