Share via

IndexesOperationsExtensions.GetStatisticsAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Search
Assembly:
Microsoft.Azure.Search.Service.dll
Package:
Microsoft.Azure.Search.Service v10.1.0
Source:
IndexesOperationsExtensions.Customization.cs

Returns statistics for the given index, including a document count and storage usage. https://docs.microsoft.com/rest/api/searchservice/Get-Index-Statistics

public static System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.IndexGetStatisticsResult> GetStatisticsAsync (this Microsoft.Azure.Search.IIndexesOperations operations, string indexName, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);
static member GetStatisticsAsync : Microsoft.Azure.Search.IIndexesOperations * string * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.IndexGetStatisticsResult>
<Extension()>
Public Function GetStatisticsAsync (operations As IIndexesOperations, indexName As String, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IndexGetStatisticsResult)

Parameters

operations
IIndexesOperations

The operations group for this extension method.

indexName
String

The name of the index for which to retrieve statistics.

searchRequestOptions
SearchRequestOptions

Additional parameters for the operation

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<IndexGetStatisticsResult>

Applies to