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/search-api-migration.md
+24-23Lines changed: 24 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,20 +12,19 @@ ms.custom:
12
12
- build-2024
13
13
- ignite-2024
14
14
ms.topic: conceptual
15
-
ms.date: 11/19/2024
15
+
ms.date: 02/14/2025
16
16
---
17
17
18
18
# Upgrade to the latest REST API in Azure AI Search
19
19
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.
21
21
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 |
29
28
30
29
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).
31
30
@@ -48,15 +47,15 @@ Azure AI Search breaks backward compatibility as a last resort. Upgrade is neces
48
47
49
48
## How to upgrade
50
49
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.
52
51
53
52
1. Update the `api-version` parameter, specified in the request header, to a newer version.
54
53
55
54
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).
56
55
57
56
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.
58
57
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.
60
59
61
60
## Breaking change for data plane client code that reads connection information
62
61
@@ -125,11 +124,11 @@ If you're upgrading from `2023-10-01-preview`, there are no breaking changes. Ho
125
124
126
125
1. Search your codebase for `vectorFilterMode` references.
127
126
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.
129
128
130
129
### Upgrade to 2023-11-01
131
130
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 rankerand vector support.
133
132
134
133
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).
135
134
@@ -420,22 +419,24 @@ You can update flat indexes to the new format with the following steps using API
420
419
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.
421
420
422
421
> [!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.
424
423
425
-
## Management plane upgrades
424
+
## Control plane upgrades
426
425
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`
428
427
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.
430
429
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` parameterto the most recent version (`2023-11-01`).
432
431
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
+
```
437
438
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.
Copy file name to clipboardExpand all lines: articles/search/search-monitor-enable-logging.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ ms.date: 01/28/2025
13
13
14
14
# Configure diagnostic logging for Azure AI Search
15
15
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 managementplane. 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
17
17
18
18
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.
Copy file name to clipboardExpand all lines: articles/search/search-security-api-keys.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ Visually, there's no distinction between an admin key or query key. Both keys ar
43
43
44
44
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/).
45
45
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:
47
47
- Admin keys are used for creating, modifying, or deleting objects. Admin keys are also used to GET object definitions and system information.
48
48
- Query keys are typically distributed to client applications that issue queries.
0 commit comments