Skip to content

Commit 65348bf

Browse files
committed
Updated management content
1 parent 0fd02ea commit 65348bf

File tree

4 files changed

+40
-40
lines changed

4 files changed

+40
-40
lines changed

articles/search/includes/how-tos/manage-index-portal.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ ms.topic: include
77
ms.date: 07/03/2025
88
---
99

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.
1111

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).
1313

1414
## Limitations
1515

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).
1717

1818
Otherwise, the following limitations apply to index management:
1919

@@ -37,10 +37,10 @@ To view all your indexes:
3737

3838
On the index page, the portal provides the following statistics:
3939

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.
4444

4545
:::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":::
4646

@@ -54,7 +54,7 @@ On the index page, select **Edit JSON** to view its complete definition.
5454

5555
<!--
5656
> [!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).
5858
-->
5959

6060
## Delete an index
@@ -68,4 +68,4 @@ On the index page, select **Delete** to initiate the deletion process.
6868

6969
The portal prompts you to confirm the deletion. After you select **Delete**, check your notifications to confirm that the deletion was successful.
7070

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":::

articles/search/includes/how-tos/manage-index-rest.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ ms.topic: include
77
ms.date: 07/03/2025
88
---
99

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.
1111

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).
1313

1414
## Limitations
1515

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).
1717

1818
Otherwise, the following limitations apply to index management:
1919

@@ -34,6 +34,8 @@ GET https://[service name].search.windows.net/indexes?api-version=[api version]
3434

3535
## View an index's statistics
3636

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+
3739
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.
3840

3941
```http
@@ -45,7 +47,7 @@ GET https://[service name].search.windows.net/indexes/[index name]/stats?api-ver
4547

4648
## View an index's definition
4749

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.
4951

5052
```http
5153
### Get index definition
@@ -59,7 +61,7 @@ GET https://[service name].search.windows.net/indexes/[index name]?api-version=[
5961
> [!WARNING]
6062
> 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.
6163
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.
6365

6466
```http
6567
### Delete an index

articles/search/includes/how-tos/manage-index-sdks.md renamed to articles/search/includes/how-tos/manage-index-sdk.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ ms.topic: include
77
ms.date: 07/03/2025
88
---
99

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.
1111

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).
1313

1414
## Limitations
1515

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).
1717

1818
Otherwise, the following limitations apply to index management:
1919

@@ -25,7 +25,7 @@ Otherwise, the following limitations apply to index management:
2525

2626
Use your preferred Azure SDK to retrieve all indexes on your search service.
2727

28-
### [.NET](#tab/dotnet)
28+
### [.NET](#tab/list-dotnet)
2929

3030
The Azure SDK for .NET provides [GetIndexesAsync](/dotnet/api/azure.search.documents.indexes.searchindexclient.getindexesasync) for this task.
3131

@@ -42,7 +42,7 @@ await foreach (var index in indexClient.GetIndexesAsync())
4242
}
4343
```
4444

45-
### [Java](#tab/java)
45+
### [Java](#tab/list-java)
4646

4747
The Azure SDK for Java provides `listIndexes` in the [SearchIndexAsyncClient](/java/api/com.azure.search.documents.indexes.searchindexasyncclient) class for this task.
4848

@@ -62,7 +62,7 @@ searchIndexAsyncClient.listIndexes()
6262
);
6363
```
6464

65-
### [JavaScript](#tab/javascript)
65+
### [JavaScript](#tab/list-javascript)
6666

6767
The Azure SDK for JavaScript provides `listIndexes` in the [SearchIndexClient](/javascript/api/@azure/search-documents/searchindexclient) class for this task.
6868

@@ -81,7 +81,7 @@ const client = new SearchIndexClient(endpoint, new AzureKeyCredential(adminKey)
8181
})();
8282
```
8383

84-
### [Python](#tab/python)
84+
### [Python](#tab/list-python)
8585

8686
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.
8787

@@ -96,17 +96,13 @@ for index in client.list_indexes():
9696
print(index.name)
9797
```
9898

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-
10399
---
104100

105101
## View an index's statistics
106102

107103
Use your preferred Azure SDK to retrieve the document count, storage usage, and vector storage usage of an index.
108104

109-
### [.NET](#tab/dotnet)
105+
### [.NET](#tab/stats-dotnet)
110106

111107
The Azure SDK for .NET provides [GetIndexStatisticsAsync](/dotnet/api/azure.search.documents.indexes.searchindexclient.getindexstatisticsasync) for this task.
112108

@@ -124,7 +120,7 @@ Console.WriteLine($"Storage consumed by index: {stats.StorageSize:N0} bytes");
124120
Console.WriteLine($"Storage consumed by vectors: {stats.VectorIndexSize:N0} bytes");
125121
```
126122

127-
### [Java](#tab/java)
123+
### [Java](#tab/stats-java)
128124

129125
The Azure SDK for Java provides `getIndexStatistics` in the [SearchIndexAsyncClient](/java/api/com.azure.search.documents.indexes.searchindexasyncclient) class for this task.
130126

@@ -144,7 +140,7 @@ System.out.println("Storage consumed by index: " + stats.getStorageSize() + " by
144140
System.out.println("Storage consumed by vectors: " + stats.getVectorIndexSize() + " bytes");
145141
```
146142

147-
### [JavaScript](#tab/javascript)
143+
### [JavaScript](#tab/stats-javascript)
148144

149145
The Azure SDK for JavaScript provides `getIndexStatistics` in the [SearchIndexClient](/javascript/api/@azure/search-documents/searchindexclient) class for this task.
150146

@@ -164,7 +160,7 @@ const client = new SearchIndexClient(endpoint, new AzureKeyCredential(adminKey)
164160
})();
165161
```
166162

167-
### [Python](#tab/python)
163+
### [Python](#tab/stats-python)
168164

169165
The Azure SDK for Python provides [get_index_statistics](/python/api/azure-search-documents/azure.search.documents.indexes.searchindexclient) for this task.
170166

@@ -185,9 +181,11 @@ print(f"Storage consumed by vectors: {stats['vector_index_size']} bytes")
185181

186182
## View an index's definition
187183

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+
188186
Use your preferred Azure SDK to retrieve the JSON definition of an index.
189187

190-
### [.NET](#tab/dotnet)
188+
### [.NET](#tab/definition-dotnet)
191189

192190
The Azure SDK for .NET provides [GetIndexAsync](/dotnet/api/azure.search.documents.indexes.searchindexclient.getindexasync) for this task.
193191

@@ -203,7 +201,7 @@ string indexJson = JsonSerializer.Serialize(index.Value, new JsonSerializerOptio
203201
Console.WriteLine(indexJson);
204202
```
205203

206-
### [Java](#tab/java)
204+
### [Java](#tab/definition-java)
207205

208206
The Azure SDK for Java provides `getIndex` in the [SearchIndexAsyncClient](/java/api/com.azure.search.documents.indexes.searchindexasyncclient) class for this task.
209207

@@ -230,7 +228,7 @@ searchIndexAsyncClient.getIndex("[index name]")
230228
});
231229
```
232230

233-
### [JavaScript](#tab/javascript)
231+
### [JavaScript](#tab/definition-javascript)
234232

235233
The Azure SDK for JavaScript provides `getIndex` in the [SearchIndexClient](/javascript/api/@azure/search-documents/searchindexclient) class for this task.
236234

@@ -248,7 +246,7 @@ const client = new SearchIndexClient(endpoint, new AzureKeyCredential(adminKey)
248246
})();
249247
```
250248

251-
### [Python](#tab/python)
249+
### [Python](#tab/definition-python)
252250

253251
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.
254252

@@ -270,7 +268,7 @@ print(json.dumps(index.as_dict(), indent=2, sort_keys=True, ensure_ascii=False))
270268
271269
Use your preferred Azure SDK to permanently delete an index.
272270

273-
### [.NET](#tab/dotnet)
271+
### [.NET](#tab/delete-dotnet)
274272

275273
The Azure SDK for .NET provides [DeleteIndexAsync](/dotnet/api/azure.search.documents.indexes.searchindexclient.deleteindexasync) for this task.
276274

@@ -285,7 +283,7 @@ await indexClient.DeleteIndexAsync("[index name]");
285283
Console.WriteLine("Index deleted successfully.");
286284
```
287285

288-
### [Java](#tab/java)
286+
### [Java](#tab/delete-java)
289287

290288
The Azure SDK for Java provides `deleteIndex` in the [SearchIndexAsyncClient](/java/api/com.azure.search.documents.indexes.searchindexasyncclient) class for this task.
291289

@@ -305,7 +303,7 @@ searchIndexAsyncClient.deleteIndex("[index name]")
305303
);
306304
```
307305

308-
### [JavaScript](#tab/javascript)
306+
### [JavaScript](#tab/delete-javascript)
309307

310308
The Azure SDK for JavaScript provides `deleteIndex` in the [SearchIndexClient](/javascript/api/@azure/search-documents/searchindexclient) class for this task.
311309

@@ -323,7 +321,7 @@ const client = new SearchIndexClient(endpoint, new AzureKeyCredential(adminKey)
323321
})();
324322
```
325323

326-
### [Python](#tab/python)
324+
### [Python](#tab/delete-python)
327325

328326
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.
329327

articles/search/search-how-to-manage-index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.author: haileytapia
88
ms.service: azure-ai-search
99
ms.topic: how-to
1010
ms.date: 07/03/2025
11-
zone_pivot_groups: manage-index-search
11+
zone_pivot_groups: search-how-to-manage-index
1212
---
1313

1414
# Manage an index in Azure AI Search
@@ -22,12 +22,12 @@ zone_pivot_groups: manage-index-search
2222
::: zone-end
2323

2424
::: zone pivot="azure-sdks"
25-
[!INCLUDE [Azure SDKs instructions](includes/how-tos/manage-index-sdks.md)]
25+
[!INCLUDE [Azure SDKs instructions](includes/how-tos/manage-index-sdk.md)]
2626
::: zone-end
2727

2828
## Related content
2929

3030
+ [Search indexes in Azure AI Search](search-what-is-an-index.md)
31-
+ [Create an index](create-search-index.md)
31+
+ [Create an index](search-how-to-create-search-index.md)
3232
+ [Load data into an index](tutorial-csharp-overview.md)
3333
+ [Update or rebuild an index](search-howto-reindex.md)

0 commit comments

Comments
 (0)