AzureIndexStatisticsProvider.GetStatistics Method

Gets statistics of an Azure index.

Namespace: CMS.Search.Azure
Assembly: CMS.Search.Azure (in CMS.Search.Azure.dll) Version: 12.0.0

Syntax

public IIndexStatistics GetStatistics(
	SearchIndexInfo indexInfo
)

Parameters

indexInfo

Type: CMS.Search.SearchIndexInfo
Index to retrieve statistics for.

Return Value

Type: IIndexStatistics
Statistics of given index, or null when statistics are not available.

Implements

IIndexStatisticsProvider.GetStatistics(SearchIndexInfo)

Exceptions

Exception	Condition
ArgumentNullException	Thrown when indexInfo is null.
ArgumentException	Thrown when IndexProvider of given indexInfo is not Azure.

Remarks

This method returns null if index does not exist within Azure Search service or the index's service name and admin API key are not valid.