SearchIndexClient.GetServiceStatistics(CancellationToken) Method

Definition

Namespace:

Azure.Search.Documents.Indexes

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.5.1

Source:

SearchIndexClient.cs

Gets service level statistics for a Search service.

This operation returns the number and type of objects in your service, the maximum allowed for each object type given the service tier, actual and maximum storage, and other limits that vary by tier. This request pulls information from the service so that you don't have to look up or calculate service limits.

Statistics on document count and storage size are collected every few minutes, not in real time. Therefore, the statistics returned by this API may not reflect changes caused by recent indexing operations.

public virtual Azure.Response<Azure.Search.Documents.Indexes.Models.SearchServiceStatistics> GetServiceStatistics (System.Threading.CancellationToken cancellationToken = default);

abstract member GetServiceStatistics : System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchServiceStatistics>
override this.GetServiceStatistics : System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchServiceStatistics>

Public Overridable Function GetServiceStatistics (Optional cancellationToken As CancellationToken = Nothing) As Response(Of SearchServiceStatistics)

Parameters

cancellationToken

CancellationToken

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

Returns

Response<SearchServiceStatistics>

The Response<T> from the server containing SearchServiceStatistics.

Exceptions

RequestFailedException

Thrown when a failure is returned by the Search service.