Skip to content

Commit 75b7018

Browse files
committed
Formatting on API migration doc
1 parent 44ab171 commit 75b7018

File tree

3 files changed

+26
-25
lines changed

3 files changed

+26
-25
lines changed

articles/search/search-api-migration.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,19 @@ ms.custom:
1212
- build-2024
1313
- ignite-2024
1414
ms.topic: conceptual
15-
ms.date: 11/19/2024
15+
ms.date: 02/14/2025
1616
---
1717

1818
# Upgrade to the latest REST API in Azure AI Search
1919

20-
Use this article to migrate data plane calls to newer versions of the [**Search REST APIs**](/rest/api/searchservice/) and management plane calls to newer version of the [**Search Management REST APIs**](/rest/api/searchmanagement/)
20+
Use this article to migrate to newer versions of the [**Search Service REST APIs**](/rest/api/searchservice/) and the [**Search Management REST APIs**](/rest/api/searchmanagement/) for [data plane and control plane](/azure/azure-resource-manager/management/control-plane-and-data-plane) operations.
2121

22-
+ [`2024-07-01`](/rest/api/searchservice/search-service-api-versions#2024-07-01) is the most recent stable data plane API version.
23-
24-
+ [`2024-11-01-preview`](/rest/api/searchservice/search-service-api-versions#2024-11-01-preview) is the most recent preview data plane API version.
25-
26-
+ [`2023-11-01`](/rest/api/searchmanagement/operation-groups?view=rest-searchmanagement-2023-11-01) is the most recent stable management plane API version.
27-
28-
+ [`2024-03-01-preview`](/rest/api/searchmanagement/operation-groups?view=rest-searchmanagement-2024-03-01-preview) is the most recent preview management plane API version.
22+
| Targeted operations | REST API | Status |
23+
|---------------------|----------|--------|
24+
| Data plane | [`2024-07-01`](/rest/api/searchservice/search-service-api-versions#2024-07-01) | Stable |
25+
| Data plane | [`2024-11-01-preview`](/rest/api/searchservice/search-service-api-versions#2024-11-01-preview) | Preview |
26+
| Control plane | [`2023-11-01`](/rest/api/searchmanagement/operation-groups?view=rest-searchmanagement-2023-11-01) | Stable |
27+
| Control plane | [`2024-03-01-preview`](/rest/api/searchmanagement/operation-groups?view=rest-searchmanagement-2024-03-01-preview) | Preview |
2928

3029
Upgrade instructions focus on code changes that get you through breaking changes from previous versions so that existing code runs the same as before, but on the newer API version. Once your code is in working order, you can decide whether to adopt newer features. To learn more about new features, see [vector code samples](https://github.com/Azure/azure-search-vector-samples) and [What's New](whats-new.md).
3130

@@ -48,15 +47,15 @@ Azure AI Search breaks backward compatibility as a last resort. Upgrade is neces
4847

4948
## How to upgrade
5049

51-
1. If you are upgrading a data plane version, review the [release notes](/rest/api/searchservice/search-service-api-versions) for the new API version.
50+
1. If you're upgrading a data plane version, review the [release notes](/rest/api/searchservice/search-service-api-versions) for the new API version.
5251

5352
1. Update the `api-version` parameter, specified in the request header, to a newer version.
5453

5554
In your application code that makes direct calls to the REST APIs, search for all instances of the existing version and then replace it with the new version. For more information about structuring a REST call, see [Quickstart: using REST](search-get-started-rest.md#set-up-visual-studio-code).
5655

5756
If you're using an Azure SDK, those packages target specific versions of the REST API. Package updates might coincide with a REST API update, but each SDK is on its own release schedule that ships independently of Azure AI Search REST API versions. Check the change log of your SDK package to determine whether a package release targets the latest REST API version.
5857

59-
1. If you are upgrading a data plane version, review the breaking changes documented in this article and implement the workarounds. Start with the version used by your code and resolve any breaking change for each newer API version until you get to the newest stable or preview release.
58+
1. If you're upgrading a data plane version, review the breaking changes documented in this article and implement the workarounds. Start with the version used by your code and resolve any breaking change for each newer API version until you get to the newest stable or preview release.
6059

6160
## Breaking change for data plane client code that reads connection information
6261

@@ -125,11 +124,11 @@ If you're upgrading from `2023-10-01-preview`, there are no breaking changes. Ho
125124

126125
1. Search your codebase for `vectorFilterMode` references.
127126

128-
1. If the property is explicitly set, no action is required. If you used the default, be aware that the new default behavior is to filter before query execution. If you want post-query filtering, explicitly set `vectorFilterMode` to postfilter to retain the old behavior.
127+
1. If the property is explicitly set, no action is required. If you relied on the default value, the new default behavior is to filter *before* query execution. If you want post-query filtering, explicitly set `vectorFilterMode` to postfilter to retain the old behavior.
129128

130129
### Upgrade to 2023-11-01
131130

132-
[`2023-11-01`](/rest/api/searchservice/search-service-api-versions#2023-11-01) is a general release. The former preview features are now generally available: semantic ranker, vector index and query support.
131+
[`2023-11-01`](/rest/api/searchservice/search-service-api-versions#2023-11-01) is a general release. The former preview features are now generally available: semantic ranker and vector support.
133132

134133
There are no breaking changes from `2023-10-01-preview`, but there are multiple breaking changes from `2023-07-01-preview` to `2023-11-01`. For more information, see [Upgrade from 2023-07-01-preview](#upgrade-from-2023-07-01-preview).
135134

@@ -420,22 +419,24 @@ You can update flat indexes to the new format with the following steps using API
420419
1. Perform a PUT request to update the index to the new format. Avoid changing any other details of the index, such as the searchability/filterability of fields, because changes that affect the physical expression of existing index isn't allowed by the Update Index API.
421420

422421
> [!NOTE]
423-
> It is not possible to manage indexes created with the old "flat" format from the Azure portal. Please upgrade your indexes from the “flat” representation to the “tree” representation at your earliest convenience.
422+
> It isn't possible to manage indexes created with the old "flat" format from the Azure portal. Upgrade your indexes from the “flat” representation to the “tree” representation at your earliest convenience.
424423
425-
## Management plane upgrades
424+
## Control plane upgrades
426425

427-
### Upgrading from 2014-07-31-Preview, 2015-02-28, and 2015-08-19
426+
**Applies to:** `2014-07-31-Preview`, `2015-02-28`, and `2015-08-19`
428427

429-
The `listQueryKeys` operation is deprecated on these API versions. It's recommended to update to the latest stable management plane API versopm to use the `listQueryKeys` operation.
428+
The `listQueryKeys` GET request on older Search Management API versions is now deprecated. We recommend migrating to the most recent stable control plane API version to use the `listQueryKeys` POST request.
430429

431-
1. If you are using a REST request, in addition to changing the `api-version` parameter, it's necessary to switch from `GET` to `POST`
430+
1. In existing code, change the `api-version` parameter to the most recent version (`2023-11-01`).
432431

433-
```
434-
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys?api-version=2023-11-01
435-
Authorization: Bearer {{token}}
436-
```
432+
1. Refactor the request from `GET` to `POST`:
433+
434+
```http
435+
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys?api-version=2023-11-01
436+
Authorization: Bearer {{token}}
437+
```
437438

438-
2. If you are using the Azure SDK, it's recommended to update to the latest version.
439+
1. If you're using an Azure SDK, it's recommended that you upgrade to the latest version.
439440

440441
### Next steps
441442

articles/search/search-monitor-enable-logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.date: 01/28/2025
1313

1414
# Configure diagnostic logging for Azure AI Search
1515

16-
Resource-level diagnostic logs provide insight into operations that occur in your Azure AI Search resource. In contrast, activity logs provide an insight into the operations performed on each Azure resource in the subscription from the outside, known as the control plane or management plane. Activity logging is enabled automatically, and often
16+
Resource-level diagnostic logs provide insight into operations that occur in your Azure AI Search resource. In contrast, activity logs provide an insight into the operations performed on each Azure resource in the subscription from the outside, known as the [control plane](/azure/azure-resource-manager/management/control-plane-and-data-plane). Activity logging is enabled automatically, and often
1717

1818
This article explains how to enable resource-level diagnostic logging and how to find information about system and user operations on an Azure AI Search resource.
1919

articles/search/search-security-api-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Visually, there's no distinction between an admin key or query key. Both keys ar
4343

4444
API keys are used for data plane (content) requests, such as creating or accessing an index or, any other request that's represented in the [Search REST APIs](/rest/api/searchservice/).
4545

46-
You can use either an API key or [Azure roles](search-security-rbac.md) for management plane (service) requests. When you use an API key:
46+
You can use either an API key or [Azure roles](search-security-rbac.md) for control plane (service) requests. When you use an API key:
4747
- Admin keys are used for creating, modifying, or deleting objects. Admin keys are also used to GET object definitions and system information.
4848
- Query keys are typically distributed to client applications that issue queries.
4949

0 commit comments

Comments
 (0)