index_stats_summaries
Creates, updates, deletes, gets or lists an index_stats_summaries resource.
Overview
| Name | index_stats_summaries |
| Type | Resource |
| Id | azure.search_documents.index_stats_summaries |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_index_stats_summary | exec | search_service_name | $top, $skip, $count | Retrieves a summary of statistics for all indexes in the search service. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
search_service_name | string | Search service name. (default: ) |
$count | boolean | A value that specifies whether to fetch the total count of items. Default is false. Default value is None. |
$skip | integer | The number of items to skip. Default value is None. |
$top | integer | The number of items to retrieve. Default is 50, maximum is 1000. Default value is None. |
Lifecycle Methods
- list_index_stats_summary
Retrieves a summary of statistics for all indexes in the search service.
EXEC azure.search_documents.index_stats_summaries.list_index_stats_summary
@search_service_name='{{ search_service_name }}' --required,
@$top='{{ $top }}',
@$skip='{{ $skip }}',
@$count={{ $count }}
;