Skip to content

Commit ccd845d

Browse files
Merge pull request #279235 from HeidiSteen/heidist-june24
[azure search] API version, update links and preview API references
2 parents 88ac337 + 5120450 commit ccd845d

10 files changed

+79
-80
lines changed

articles/search/search-api-preview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Preview features are removed from this list if they're retired or transition to
5252

5353
|Feature                         | Category | Description | Availability |
5454
|---------|------------------|-------------|---------------|
55-
| [**Search service under a user-assigned managed identity**](search-howto-managed-identities-data-sources.md) | Service | Configures a search service to use a previously created user-assigned managed identity. | [Services - Update](/rest/api/searchmanagement/services/update?view=rest-searchmanagement-2024-03-01-preview&preserve-view=true#identity), 2021-04-01-preview or a later. |
55+
| [**Search service under a user-assigned managed identity**](search-howto-managed-identities-data-sources.md) | Service | Configures a search service to use a previously created user-assigned managed identity. | [Services - Update](/rest/api/searchmanagement/services/update?view=rest-searchmanagement-2024-06-01-preview&preserve-view=true#identity), 2021-04-01-preview or the latest preview version. We recommend using the latest preview version. |
5656

5757
## Preview features in Azure SDKs
5858

articles/search/search-howto-incremental-index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: cognitive-search
88
ms.custom:
99
- ignite-2023
1010
ms.topic: how-to
11-
ms.date: 03/04/2024
11+
ms.date: 06/25/2024
1212
---
1313

1414
# Enable caching for incremental enrichment in Azure AI Search
@@ -45,10 +45,10 @@ You can use the Azure portal, preview APIs, or beta Azure SDKs are required to e
4545

4646
### [**REST**](#tab/rest)
4747

48-
On new indexers, add the "cache" property in the indexer definition payload when calling [Create or Update Indexer (2021-04-30-Preview)](/rest/api/searchservice/preview-api/create-or-update-indexer). You can also use the previous preview API version, 2020-06-30-Preview.
48+
On new indexers, add the "cache" property in the indexer definition payload when calling Create or Update Indexer. You can use preview API versions 2021-04-30-preview and later. We recommend the latest preview for [Create or Update Indexer (2024-05-01-preview)](/rest/api/searchservice/indexers/create-or-update?view=rest-searchservice-2024-05-01-preview&preserve-view=true).
4949

5050
```https
51-
POST https://[service name].search.windows.net/indexers?api-version=2021-04-30-Preview
51+
POST https://[service name].search.windows.net/indexers?api-version=2024-05-01-preview
5252
{
5353
"name": "<YOUR-INDEXER-NAME>",
5454
"targetIndexName": "<YOUR-INDEX-NAME>",
@@ -72,10 +72,10 @@ For existing indexers that already have a skillset, use the following steps to a
7272

7373
### Step 1: Get the indexer definition
7474

75-
Start with a valid, work indexer that has these components: data source, skillset, index. Using an API client, send a [GET Indexer](/rest/api/searchservice/get-indexer) request to retrieve the indexer. When you use the preview API version to the GET the indexer, a "cache" property set to null is added to the definition automatically.
75+
Start with a valid, work indexer that has these components: data source, skillset, index. Using an API client, send a [GET Indexer](/rest/api/searchservice/indexers/get?view=rest-searchservice-2024-05-01-preview&preserve-view=true) request to retrieve the indexer. When you use the preview API version to the GET the indexer, a "cache" property set to null is added to the definition automatically.
7676

7777
```http
78-
GET https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]?api-version=2021-04-30-Preview
78+
GET https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]?api-version=2024-05-01-preview
7979
Content-Type: application/json
8080
api-key: [YOUR-ADMIN-KEY]
8181
```
@@ -88,7 +88,7 @@ In the index definition, modify "cache" to include the following required and op
8888
+ (Optional) `enableReprocessing` boolean property (`true` by default), indicates that incremental enrichment is enabled. Set to `false` if you want to suspend incremental processing while other resource-intensive operations, such as indexing new documents, are underway and then switch back to `true` later.
8989

9090
```http
91-
POST https://[service name].search.windows.net/indexers?api-version=2021-04-30-Preview
91+
POST https://[service name].search.windows.net/indexers?api-version=2024-05-01-preview
9292
{
9393
"name": "<YOUR-INDEXER-NAME>",
9494
"targetIndexName": "<YOUR-INDEX-NAME>",
@@ -106,20 +106,20 @@ POST https://[service name].search.windows.net/indexers?api-version=2021-04-30-P
106106

107107
### Step 3: Reset the indexer
108108

109-
[Reset Indexer](/rest/api/searchservice/reset-indexer) is required when setting up incremental enrichment for existing indexers to ensure all documents are in a consistent state. You can use the portal or an API client for this task.
109+
[Reset Indexer](/rest/api/searchservice/indexers/reset) is required when setting up incremental enrichment for existing indexers to ensure all documents are in a consistent state. You can use the portal or an API client for this task.
110110

111111
```https
112-
POST https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]/reset?api-version=2021-04-30-Preview
112+
POST https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]/reset?api-version=2024-05-01-preview
113113
Content-Type: application/json
114114
api-key: [YOUR-ADMIN-KEY]
115115
```
116116

117117
### Step 4: Save the indexer
118118

119-
[Update Indexer (2021-04-30-Preview)](/rest/api/searchservice/preview-api/create-or-update-indexer) with a PUT request, where the body of the request includes "cache".
119+
[Update Indexer](/rest/api/searchservice/indexers/create-or-update?view=rest-searchservice-2024-05-01-preview&preserve-view=true) with a PUT request, where the body of the request includes "cache".
120120

121121
```http
122-
PUT https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]?api-version=2021-04-30-Preview
122+
PUT https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]?api-version=2024-05-01-preview
123123
Content-Type: application/json
124124
api-key: [YOUR-ADMIN-KEY]
125125
{
@@ -146,10 +146,10 @@ If you now issue another GET request on the indexer, the response from the servi
146146

147147
To run indexer, you can use the portal or the API. In the portal, from the indexers list, select the indexer and select **Run**. One advantage to using the portal is that you can monitor indexer status, note the duration of the job, and how many documents are processed. Portal pages are refreshed every few minutes.
148148

149-
Alternatively, you can use REST to [run the indexer](/rest/api/searchservice/run-indexer):
149+
Alternatively, you can use REST to [run the indexer](/rest/api/searchservice/indexers/run):
150150

151151
```http
152-
POST https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]/run?api-version=2020-06-30-Preview
152+
POST https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]/run?api-version=2024-05-01-preview
153153
Content-Type: application/json
154154
api-key: [YOUR-ADMIN-KEY]
155155
```

articles/search/search-howto-index-cosmosdb-gremlin.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@ Because terminology can be confusing, it's worth noting that [Azure Cosmos DB in
4141

4242
The data source definition specifies the data to index, credentials, and policies for identifying changes in the data. A data source is defined as an independent resource so that it can be used by multiple indexers.
4343

44-
For this call, specify a [preview REST API version](search-api-preview.md) (2020-06-30-Preview or 2021-04-30-Preview) to create a data source that connects via an Azure Cosmos DB for Apache Gremlin.
44+
For this call, specify a [preview REST API version](search-api-preview.md) to create a data source that connects via an Azure Cosmos DB for Apache Gremlin. You can use 2021-04-01-preview or later. We recommend the latest preview API.
4545

46-
1. [Create or update a data source](/rest/api/searchservice/preview-api/create-or-update-data-source) to set its definition:
46+
1. [Create or update a data source](/rest/api/searchservice/data-sources/create-or-update?view=rest-searchservice-2024-05-01-preview&preserve-view=true) to set its definition:
4747

4848
```http
49-
POST https://[service name].search.windows.net/datasources?api-version=2021-04-30-Preview
49+
POST https://[service name].search.windows.net/datasources?api-version=2024-05-01-preview
5050
Content-Type: application/json
5151
api-key: [Search service admin key]
5252
{
@@ -102,10 +102,10 @@ Avoid port numbers in the endpoint URL. If you include the port number, the conn
102102

103103
In a [search index](search-what-is-an-index.md), add fields to accept the source JSON documents or the output of your custom query projection. Ensure that the search index schema is compatible with your graph. For content in Azure Cosmos DB, your search index schema should correspond to the [Azure Cosmos DB items](../cosmos-db/resource-model.md#azure-cosmos-db-items) in your data source.
104104

105-
1. [Create or update an index](/rest/api/searchservice/create-index) to define search fields that will store data:
105+
1. [Create or update an index](/rest/api/searchservice/indexes/create-or-update) to define search fields that will store data:
106106

107107
```http
108-
POST https://[service name].search.windows.net/indexes?api-version=2020-06-30-Preview
108+
POST https://[service name].search.windows.net/indexes?api-version=2024-05-01-preview
109109
Content-Type: application/json
110110
api-key: [Search service admin key]
111111
{
@@ -164,10 +164,10 @@ In a [search index](search-what-is-an-index.md), add fields to accept the source
164164

165165
Once the index and data source have been created, you're ready to create the indexer. Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
166166

167-
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
167+
1. [Create or update an indexer](/rest/api/searchservice/indexers/create-or-update?view=rest-searchservice-2024-05-01-preview&preserve-view=true) by giving it a name and referencing the data source and target index:
168168

169169
```http
170-
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
170+
POST https://[service name].search.windows.net/indexers?api-version=2024-05-01-preview
171171
Content-Type: application/json
172172
api-key: [search service admin key]
173173
{
@@ -196,10 +196,10 @@ An indexer runs automatically when it's created. You can prevent this by setting
196196
197197
## Check indexer status
198198
199-
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/get-indexer-status) request:
199+
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/indexers/get-status) request:
200200
201201
```http
202-
GET https://myservice.search.windows.net/indexers/myindexer/status?api-version=2020-06-30
202+
GET https://myservice.search.windows.net/indexers/myindexer/status?api-version=2024-05-01-preview
203203
Content-Type: application/json
204204
api-key: [admin key]
205205
```
@@ -276,7 +276,7 @@ When graph data is deleted, you might want to delete its corresponding document
276276
The following example creates a data source with a soft-deletion policy:
277277

278278
```http
279-
POST https://[service name].search.windows.net/datasources?api-version=2020-06-30-Preview
279+
POST https://[service name].search.windows.net/datasources?api-version=2024-05-01-preview
280280
Content-Type: application/json
281281
api-key: [Search service admin key]
282282

articles/search/search-howto-index-cosmosdb-mongodb.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: cognitive-search
88
ms.custom:
99
- ignite-2023
1010
ms.topic: how-to
11-
ms.date: 02/28/2024
11+
ms.date: 06/25/2024
1212
---
1313

1414
# Index data from Azure Cosmos DB for MongoDB for queries in Azure AI Search
@@ -44,19 +44,18 @@ These are the limitations of this feature:
4444

4545
+ The MongoDB attribute `$ref` is a reserved word. If you need this in your MongoDB collection, consider alternative solutions for populating an index.
4646

47-
4847
As an alternative to this connector, if your scenario has any of those requirements, you could use the [Push API/SDK](search-what-is-data-import.md) or consider [Azure Data Factory](../data-factory/connector-azure-cosmos-db.md) with an [Azure AI Search index](../data-factory/connector-azure-search.md) as the sink.
4948

5049
## Define the data source
5150

5251
The data source definition specifies the data to index, credentials, and policies for identifying changes in the data. A data source is defined as an independent resource so that it can be used by multiple indexers.
5352

54-
For this call, specify a [preview REST API version](search-api-preview.md) (2020-06-30-Preview or 2021-04-30-Preview) to create a data source that connects via the MongoDB API.
53+
For this call, specify a [preview REST API version](search-api-preview.md). You can use 2020-06-30-preview or later to create a data source that connects via the MongoDB API. We recommend using the latest preview REST API.
5554

56-
1. [Create or update a data source](/rest/api/searchservice/preview-api/create-or-update-data-source) to set its definition:
55+
1. [Create or update a data source](/rest/api/searchservice/data-sources/create-or-update?view=rest-searchservice-2024-05-01-preview&preserve-view=true) to set its definition:
5756

5857
```http
59-
POST https://[service name].search.windows.net/datasources?api-version=2021-04-30-Preview
58+
POST https://[service name].search.windows.net/datasources?api-version=2024-05-01-preview
6059
Content-Type: application/json
6160
api-key: [Search service admin key]
6261
{
@@ -111,10 +110,10 @@ Avoid port numbers in the endpoint URL. If you include the port number, the conn
111110
112111
In a [search index](search-what-is-an-index.md), add fields to accept the source JSON documents or the output of your custom query projection. Ensure that the search index schema is compatible with source data. For content in Azure Cosmos DB, your search index schema should correspond to the [Azure Cosmos DB items](../cosmos-db/resource-model.md#azure-cosmos-db-items) in your data source.
113112
114-
1. [Create or update an index](/rest/api/searchservice/create-index) to define search fields that will store data:
113+
1. [Create or update an index](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2024-05-01-preview&preserve-view=true) to define search fields that will store data:
115114
116115
```http
117-
POST https://[service name].search.windows.net/indexes?api-version=2020-06-30
116+
POST https://[service name].search.windows.net/indexes?api-version=2024-05-01-preview
118117
Content-Type: application/json
119118
api-key: [Search service admin key]
120119
@@ -165,10 +164,10 @@ In a [search index](search-what-is-an-index.md), add fields to accept the source
165164
166165
Once the index and data source have been created, you're ready to create the indexer. Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
167166
168-
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
167+
1. [Create or update an indexer](/rest/api/searchservice/indexers/create-or-update?view=rest-searchservice-2024-05-01-preview&preserve-view=true) by giving it a name and referencing the data source and target index:
169168
170169
```http
171-
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
170+
POST https://[service name].search.windows.net/indexers?api-version=2024-05-01-preview
172171
Content-Type: application/json
173172
api-key: [search service admin key]
174173
{
@@ -197,10 +196,10 @@ An indexer runs automatically when it's created. You can prevent this by setting
197196
198197
## Check indexer status
199198
200-
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/get-indexer-status) request:
199+
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/indexers/get-status?view=rest-searchservice-2024-05-01-preview&preserve-view=true) request:
201200
202201
```http
203-
GET https://myservice.search.windows.net/indexers/myindexer/status?api-version=2020-06-30
202+
GET https://myservice.search.windows.net/indexers/myindexer/status?api-version=2024-05-01-preview
204203
Content-Type: application/json
205204
api-key: [admin key]
206205
```
@@ -279,7 +278,7 @@ If you're using a custom query, make sure that the property referenced by `softD
279278
The following example creates a data source with a soft-deletion policy:
280279

281280
```http
282-
POST https://[service name].search.windows.net/datasources?api-version=2020-06-30
281+
POST https://[service name].search.windows.net/datasources?api-version=2024-05-01-preview
283282
Content-Type: application/json
284283
api-key: [Search service admin key]
285284

articles/search/search-howto-managed-identities-data-sources.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,12 +170,12 @@ Associating a user-assigned managed identity is supported in the Azure portal, i
170170
171171
### [**REST API**](#tab/rest-user)
172172
173-
You can use a preview Management REST API instead of the portal to assign a user-assigned managed identity. Use API versions `2021-04-01-preview` or later. This example uses `2024-03-01-preview`.
173+
You can use a preview Management REST API instead of the portal to assign a user-assigned managed identity. Use API versions `2021-04-01-preview` or later. This example uses `2024-06-01-preview`.
174174
175-
1. Formulate a request to [UPDATE](/rest/api/searchmanagement/services/update?view=rest-searchmanagement-2024-03-01-preview&preserve-view=true#identity) a search service.
175+
1. Formulate a request to [UPDATE](/rest/api/searchmanagement/services/update?view=rest-searchmanagement-2024-06-01-preview&preserve-view=true#identity) a search service.
176176
177177
```http
178-
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview
178+
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-06-01-preview
179179
{
180180
"location": "[region]",
181181
"sku": {

0 commit comments

Comments
 (0)