You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/search/includes/how-tos/manage-index-portal.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,13 @@ ms.topic: include
7
7
ms.date: 07/03/2025
8
8
---
9
9
10
-
After you [create an index](search-how-to-create-search-index.md), you can use the [Azure portal](https://portal.azure.com) to access its statistics and definition or remove it from your search service.
10
+
After you [create an index](../../search-how-to-create-search-index.md), you can use the [Azure portal](https://portal.azure.com) to access its statistics and definition or remove it from your search service.
11
11
12
-
This article describes how to manage an index without affecting its content. For guidance on modifying an index definition, see [Update or rebuild an index in Azure AI Search](search-howto-reindex.md).
12
+
This article describes how to manage an index without affecting its content. For guidance on modifying an index definition, see [Update or rebuild an index in Azure AI Search](../../search-howto-reindex.md).
13
13
14
14
## Limitations
15
15
16
-
The pricing tier of your search service determines the maximum number and size of your indexes, fields, and documents. For more information, see [Service limits in Azure AI Search](search-limits-quotas-capacity.md).
16
+
The pricing tier of your search service determines the maximum number and size of your indexes, fields, and documents. For more information, see [Service limits in Azure AI Search](../../search-limits-quotas-capacity.md).
17
17
18
18
Otherwise, the following limitations apply to index management:
19
19
@@ -37,10 +37,10 @@ To view all your indexes:
37
37
38
38
On the index page, the portal provides the following statistics:
39
39
40
-
+**Documents**: Number of documents in the index.
41
-
+**Total storage**: Storage space used by the index.
42
-
+**Vector index quota usage**: Vector storage space used by the index.
43
-
+**Max storage**: Maximum storage space for each index in your search service, which depends on your pricing tier. This value doesn't represent the total storage currently available to the index.
40
+
+The number of documents in the index.
41
+
+The storage space used by the index.
42
+
+The vector storage space used by the index.
43
+
+The maximum storage space for each index on your search service, which [depends on your pricing tier](../../search-limits-quotas-capacity.md). This value doesn't represent the total storage currently available to the index.
44
44
45
45
:::image type="content" source="../../media/search-how-to-manage-index/index-statistics.png" alt-text="Screenshot of the index statistics in the portal." border="true" lightbox="../../media/search-how-to-manage-index/index-statistics.png":::
46
46
@@ -54,7 +54,7 @@ On the index page, select **Edit JSON** to view its complete definition.
54
54
55
55
<!--
56
56
> [!NOTE]
57
-
> The portal doesn't support synonym map definitions. You can use the portal to view existing synonyms, but you can't create them or assign them to fields. For more information, see [Add synonyms in Azure AI Search](search-synonym.md).
57
+
> The portal doesn't support synonym map definitions. You can use the portal to view existing synonyms, but you can't create them or assign them to fields. For more information, see [Add synonyms in Azure AI Search](../../search-synonym.md).
58
58
-->
59
59
60
60
## Delete an index
@@ -68,4 +68,4 @@ On the index page, select **Delete** to initiate the deletion process.
68
68
69
69
The portal prompts you to confirm the deletion. After you select **Delete**, check your notifications to confirm that the deletion was successful.
70
70
71
-
:::image type="content" source="../../media/search-how-to-manage-index/delete-confirmation.png" alt-text="Screenshot of the delete confirmation in the portal." border="true" lightbox="../../media/search-how-to-manage-index/delete-confirmation.png":::
71
+
:::image type="content" source="../../media/search-how-to-manage-index/delete-confirmation.png" alt-text="Screenshot of the deletion confirmation in the portal." border="true" lightbox="../../media/search-how-to-manage-index/delete-confirmation.png":::
Copy file name to clipboardExpand all lines: articles/search/includes/how-tos/manage-index-rest.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,13 @@ ms.topic: include
7
7
ms.date: 07/03/2025
8
8
---
9
9
10
-
After you [create an index](search-how-to-create-search-index.md), you can use the [Azure AI Search REST APIs](/rest/api/searchservice/) to access its statistics and definition or remove it from your search service.
10
+
After you [create an index](../../search-how-to-create-search-index.md), you can use the [Azure AI Search REST APIs](/rest/api/searchservice/) to access its statistics and definition or remove it from your search service.
11
11
12
-
This article describes how to manage an index without affecting its content. For guidance on modifying an index definition, see [Update or rebuild an index in Azure AI Search](search-howto-reindex.md).
12
+
This article describes how to manage an index without affecting its content. For guidance on modifying an index definition, see [Update or rebuild an index in Azure AI Search](../../search-howto-reindex.md).
13
13
14
14
## Limitations
15
15
16
-
The pricing tier of your search service determines the maximum number and size of your indexes, fields, and documents. For more information, see [Service limits in Azure AI Search](search-limits-quotas-capacity.md).
16
+
The pricing tier of your search service determines the maximum number and size of your indexes, fields, and documents. For more information, see [Service limits in Azure AI Search](../../search-limits-quotas-capacity.md).
17
17
18
18
Otherwise, the following limitations apply to index management:
19
19
@@ -34,6 +34,8 @@ GET https://[service name].search.windows.net/indexes?api-version=[api version]
34
34
35
35
## View an index's statistics
36
36
37
+
Each index is defined by fields and optional components that enhance search capabilities, such as analyzers, normalizers, tokenizers, and synonym maps. This definition determines the index's structure and behavior during indexing and querying.
38
+
37
39
Use [Indexes - Get Statistics (REST API)](/rest/api/searchservice/indexes/get-statistics) to retrieve the document count, storage usage, and vector storage usage of an index.
38
40
39
41
```http
@@ -45,7 +47,7 @@ GET https://[service name].search.windows.net/indexes/[index name]/stats?api-ver
45
47
46
48
## View an index's definition
47
49
48
-
Use [Indexes - Get (REST API)](https://docs.microsoft.com/rest/api/searchservice/get-index) to retrieve the JSON definition of an index.
50
+
Use [Indexes - Get (REST API)](/rest/api/searchservice/indexes/get) to retrieve the JSON definition of an index.
49
51
50
52
```http
51
53
### Get index definition
@@ -59,7 +61,7 @@ GET https://[service name].search.windows.net/indexes/[index name]?api-version=[
59
61
> [!WARNING]
60
62
> You can't undo an index deletion. Before you proceed, make sure that you want to permanently remove the index and its documents from your search service. We recommend that you test this operation in a nonproduction environment.
61
63
62
-
Use [Indexes - Delete (REST API)](https://docs.microsoft.com/rest/api/searchservice/delete-index) to permanently delete an index.
64
+
Use [Indexes - Delete (REST API)](/rest/api/searchservice/indexes/delete) to permanently delete an index.
Copy file name to clipboardExpand all lines: articles/search/includes/how-tos/manage-index-sdk.md
+21-23Lines changed: 21 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,13 @@ ms.topic: include
7
7
ms.date: 07/03/2025
8
8
---
9
9
10
-
After you [create an index](search-how-to-create-search-index.md), you can use the Azure SDKs to access its statistics and definition or remove it from your search service.
10
+
After you [create an index](../../search-how-to-create-search-index.md), you can use the Azure SDKs to access its statistics and definition or remove it from your search service.
11
11
12
-
This article describes how to manage an index without affecting its content. For guidance on modifying an index definition, see [Update or rebuild an index in Azure AI Search](search-howto-reindex.md).
12
+
This article describes how to manage an index without affecting its content. For guidance on modifying an index definition, see [Update or rebuild an index in Azure AI Search](../../search-howto-reindex.md).
13
13
14
14
## Limitations
15
15
16
-
The pricing tier of your search service determines the maximum number and size of your indexes, fields, and documents. For more information, see [Service limits in Azure AI Search](search-limits-quotas-capacity.md).
16
+
The pricing tier of your search service determines the maximum number and size of your indexes, fields, and documents. For more information, see [Service limits in Azure AI Search](../../search-limits-quotas-capacity.md).
17
17
18
18
Otherwise, the following limitations apply to index management:
19
19
@@ -25,7 +25,7 @@ Otherwise, the following limitations apply to index management:
25
25
26
26
Use your preferred Azure SDK to retrieve all indexes on your search service.
27
27
28
-
### [.NET](#tab/dotnet)
28
+
### [.NET](#tab/list-dotnet)
29
29
30
30
The Azure SDK for .NET provides [GetIndexesAsync](/dotnet/api/azure.search.documents.indexes.searchindexclient.getindexesasync) for this task.
31
31
@@ -42,7 +42,7 @@ await foreach (var index in indexClient.GetIndexesAsync())
42
42
}
43
43
```
44
44
45
-
### [Java](#tab/java)
45
+
### [Java](#tab/list-java)
46
46
47
47
The Azure SDK for Java provides `listIndexes` in the [SearchIndexAsyncClient](/java/api/com.azure.search.documents.indexes.searchindexasyncclient) class for this task.
The Azure SDK for JavaScript provides `listIndexes` in the [SearchIndexClient](/javascript/api/@azure/search-documents/searchindexclient) class for this task.
68
68
@@ -81,7 +81,7 @@ const client = new SearchIndexClient(endpoint, new AzureKeyCredential(adminKey)
81
81
})();
82
82
```
83
83
84
-
### [Python](#tab/python)
84
+
### [Python](#tab/list-python)
85
85
86
86
The Azure SDK for Python provides `list_indexes` in the [SearchIndexClient](/python/api/azure-search-documents/azure.search.documents.indexes.searchindexclient) class for this task.
87
87
@@ -96,17 +96,13 @@ for index in client.list_indexes():
96
96
print(index.name)
97
97
```
98
98
99
-
### [Typescript](#tab/typescript)
100
-
101
-
The Azure SDK for TypeScript provides `listIndexes` in the [SearchIndexClient](/javascript/api/@azure/search-documents/searchindexclient) class for this task.
102
-
103
99
---
104
100
105
101
## View an index's statistics
106
102
107
103
Use your preferred Azure SDK to retrieve the document count, storage usage, and vector storage usage of an index.
108
104
109
-
### [.NET](#tab/dotnet)
105
+
### [.NET](#tab/stats-dotnet)
110
106
111
107
The Azure SDK for .NET provides [GetIndexStatisticsAsync](/dotnet/api/azure.search.documents.indexes.searchindexclient.getindexstatisticsasync) for this task.
112
108
@@ -124,7 +120,7 @@ Console.WriteLine($"Storage consumed by index: {stats.StorageSize:N0} bytes");
124
120
Console.WriteLine($"Storage consumed by vectors: {stats.VectorIndexSize:N0} bytes");
125
121
```
126
122
127
-
### [Java](#tab/java)
123
+
### [Java](#tab/stats-java)
128
124
129
125
The Azure SDK for Java provides `getIndexStatistics` in the [SearchIndexAsyncClient](/java/api/com.azure.search.documents.indexes.searchindexasyncclient) class for this task.
130
126
@@ -144,7 +140,7 @@ System.out.println("Storage consumed by index: " + stats.getStorageSize() + " by
144
140
System.out.println("Storage consumed by vectors: "+ stats.getVectorIndexSize() +" bytes");
145
141
```
146
142
147
-
### [JavaScript](#tab/javascript)
143
+
### [JavaScript](#tab/stats-javascript)
148
144
149
145
The Azure SDK for JavaScript provides `getIndexStatistics` in the [SearchIndexClient](/javascript/api/@azure/search-documents/searchindexclient) class for this task.
150
146
@@ -164,7 +160,7 @@ const client = new SearchIndexClient(endpoint, new AzureKeyCredential(adminKey)
164
160
})();
165
161
```
166
162
167
-
### [Python](#tab/python)
163
+
### [Python](#tab/stats-python)
168
164
169
165
The Azure SDK for Python provides [get_index_statistics](/python/api/azure-search-documents/azure.search.documents.indexes.searchindexclient) for this task.
170
166
@@ -185,9 +181,11 @@ print(f"Storage consumed by vectors: {stats['vector_index_size']} bytes")
185
181
186
182
## View an index's definition
187
183
184
+
Each index is defined by fields and optional components that enhance search capabilities, such as analyzers, normalizers, tokenizers, and synonym maps. This definition determines the index's structure and behavior during indexing and querying.
185
+
188
186
Use your preferred Azure SDK to retrieve the JSON definition of an index.
189
187
190
-
### [.NET](#tab/dotnet)
188
+
### [.NET](#tab/definition-dotnet)
191
189
192
190
The Azure SDK for .NET provides [GetIndexAsync](/dotnet/api/azure.search.documents.indexes.searchindexclient.getindexasync) for this task.
193
191
@@ -203,7 +201,7 @@ string indexJson = JsonSerializer.Serialize(index.Value, new JsonSerializerOptio
203
201
Console.WriteLine(indexJson);
204
202
```
205
203
206
-
### [Java](#tab/java)
204
+
### [Java](#tab/definition-java)
207
205
208
206
The Azure SDK for Java provides `getIndex` in the [SearchIndexAsyncClient](/java/api/com.azure.search.documents.indexes.searchindexasyncclient) class for this task.
The Azure SDK for JavaScript provides `getIndex` in the [SearchIndexClient](/javascript/api/@azure/search-documents/searchindexclient) class for this task.
236
234
@@ -248,7 +246,7 @@ const client = new SearchIndexClient(endpoint, new AzureKeyCredential(adminKey)
248
246
})();
249
247
```
250
248
251
-
### [Python](#tab/python)
249
+
### [Python](#tab/definition-python)
252
250
253
251
The Azure SDK for Python provides `get_index` in the [SearchIndexClient](/python/api/azure-search-documents/azure.search.documents.indexes.searchindexclient) class for this task.
The Azure SDK for Java provides `deleteIndex` in the [SearchIndexAsyncClient](/java/api/com.azure.search.documents.indexes.searchindexasyncclient) class for this task.
The Azure SDK for JavaScript provides `deleteIndex` in the [SearchIndexClient](/javascript/api/@azure/search-documents/searchindexclient) class for this task.
311
309
@@ -323,7 +321,7 @@ const client = new SearchIndexClient(endpoint, new AzureKeyCredential(adminKey)
323
321
})();
324
322
```
325
323
326
-
### [Python](#tab/python)
324
+
### [Python](#tab/delete-python)
327
325
328
326
The Azure SDK for Python provides `delete_index` in the [SearchIndexClient](/python/api/azure-search-documents/azure.search.documents.indexes.searchindexclient) class for this task.
0 commit comments