Skip to content

Commit 8e6231d

Browse files
Merge pull request #277830 from HeidiSteen/heidst-june7
Restored preview labeling for user-managed identity assignment
2 parents 98725c1 + 753a315 commit 8e6231d

File tree

2 files changed

+39
-7
lines changed

2 files changed

+39
-7
lines changed

articles/search/search-api-preview.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.service: cognitive-search
1010
ms.custom:
1111
- build-2024
1212
ms.topic: conceptual
13-
ms.date: 05/21/2024
13+
ms.date: 06/11/2024
1414
---
1515

1616
# Preview features in Azure AI Search
@@ -19,6 +19,8 @@ This article identifies all features in public preview. This list is helpful for
1919

2020
Preview features are removed from this list if they're retired or transition to general availability. For announcements regarding general availability and retirement, see [Service Updates](https://azure.microsoft.com/updates/?product=search) or [What's New](whats-new.md).
2121

22+
Data plane preview features are listed in the following table.
23+
2224
|Feature                         | Category | Description | Availability |
2325
|---------|------------------|-------------|---------------|
2426
| [**Scalar quantization**](vector-search-how-to-configure-compression-storage.md#option-3-configure-scalar-quantization) | Index | Compress vector index size in memory and on disk using built-in scalar quantization. | [Create or Update Index (preview)](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2024-03-01-preview&preserve-view=true) to add a `compressions` section to a vector profile. |
@@ -46,6 +48,13 @@ Preview features are removed from this list if they're retired or transition to
4648
| [**featuresMode parameter**](/rest/api/searchservice/preview-api/search-documents#query-parameters) | Relevance (scoring) | Relevance score expansion to include details: per field similarity score, per field term frequency, and per field number of unique tokens matched. You can consume these data points in [custom scoring solutions](https://github.com/Azure-Samples/search-ranking-tutorial). | [Search Documents (preview)](/rest/api/searchservice/preview-api/search-documents), 2019-05-06-Preview or later.|
4749
| [**moreLikeThis**](search-more-like-this.md) | Query | Finds documents that are relevant to a specific document. This feature has been in earlier previews. | [Search Documents (preview)](/rest/api/searchservice/preview-api/search-documents) calls, in all supported API versions: 2023-10-10-Preview, 2023-07-01-Preview, 2021-04-30-Preview, 2020-06-30-Preview, 2019-05-06-Preview, 2016-09-01-Preview, 2017-11-11-Preview. |
4850

51+
Control plane preview features are listed in the following table.
52+
53+
|Feature                         | Category | Description | Availability |
54+
|---------|------------------|-------------|---------------|
55+
| [**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. | [UPDATE](/rest/api/searchmanagement/services/update?view=rest-searchmanagement-2024-03-01-preview&preserve-view=true#identity), 2021-04-01-preview or a later. |
56+
57+
4958
## Preview features in Azure SDKs
5059

5160
Each Azure SDK team releases beta packages on their own timeline. Check the change log for mentions of new features in beta packages:

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

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,14 @@ ms.custom:
1111
- ignite-2023
1212
- build-2024
1313
ms.topic: how-to
14-
ms.date: 06/10/2024
14+
ms.date: 06/11/2024
1515
---
1616

1717
# Configure a search service to connect using a managed identity in Azure AI Search
1818

19+
> [!IMPORTANT]
20+
> User-assigned managed identity is in public preview under [Supplemental Terms of Use](https://azure.microsoft.com/support/legal/preview-supplemental-terms/). The [Management 2024-03-01-Preview REST API](/rest/api/searchmanagement/services/update?view=rest-searchmanagement-2024-03-01-preview&preserve-view=true#identity) provides user-assigned managed identities for Azure AI Search. Support for a system-assigned managed identity is generally available.
21+
1922
You can use Microsoft Entra ID and role assignments for outbound connections from Azure AI Search to resources providing data, applied AI, or vectorization during indexing or queries.
2023

2124
To use roles on an outbound connection, first configure your search service to use either a [system-assigned or user-assigned managed identity](../active-directory/managed-identities-azure-resources/overview.md) as the security principle for your search service in a Microsoft Entra tenant. Once you have a managed identity, you can assign roles for authorized access. Managed identities and role assignments eliminate the need for passing secrets and credentials in a connection string or code.
@@ -28,7 +31,13 @@ To use roles on an outbound connection, first configure your search service to u
2831

2932
## Supported scenarios
3033

31-
Azure AI Search can use a system-assigned or user-assigned managed identity on outbound connections to Azure resources. A system managed identity is indicated when a connection string is the unique resource ID of a Microsoft Entra ID-aware service or application. A user-assigned managed identity is specified through an "identity" property.
34+
Azure AI Search can connect to other Azure resources under its system-assigned or a user-assigned managed identity.
35+
36+
+ Search service configuration of a system-assigned managed identity is generally available.
37+
+ Search service configuration of a user-assigned managed identity is in public preview, under supplemental terms of use.
38+
+ Data plane usage of a managed identity, whether system or user-assigned, is generally available. For example, if you want a user-assigned managed identity on an indexer data source connection, key vault, debug session, or enrichment cache, you can use a generally available REST API version to create the connection, assuming the feature you're using is also generally available.
39+
40+
A system managed identity is indicated when a connection string is the unique resource ID of a Microsoft Entra ID-aware service or application. A user-assigned managed identity is specified through an "identity" property.
3241

3342
A search service uses Azure Storage as an indexer data source and as a data sink for debug sessions, enrichment caching, and knowledge store. For search features that write back to storage, the managed identity needs a contributor role assignment as described in the ["Assign a role"](#assign-a-role) section.
3443

@@ -121,10 +130,22 @@ For more information, see [Create or Update Service (Management REST API)](/rest
121130
122131
## Create a user-assigned managed identity
123132
133+
> [!IMPORTANT]
134+
> Part of this scenario is in public preview under [Supplemental Terms of Use](https://azure.microsoft.com/support/legal/preview-supplemental-terms/). The [Management preview REST API](/rest/api/searchmanagement/services/update?view=rest-searchmanagement-2024-03-01-preview&preserve-view=true#identity) provides user-assigned managed identity configuration for Azure AI Search.
135+
124136
A user-assigned managed identity is a resource on Azure. You can create multiple user-assigned managed identities if you want more granularity in role assignments. For example, you might want separate identities for different applications and scenarios.
125137
138+
Steps are:
139+
140+
+ In your Azure subscription, create a user-assigned managed identity.
141+
+ On your search service, update a search service to use the user-assigned managed identity (this step is in preview).
142+
+ On other Azure services you want to connect to, create a role assignment.
143+
+ In data source connections on Azure AI Search, such as an indexer data source, specify a connection that references the user-managed identity (this step is generally available if support for the feature is generally available).
144+
126145
A user-assigned managed identity can be scoped to subscriptions, resource groups, or resource types.
127146
147+
Associating a user-assigned managed identity is supported in the Azure portal, in preview versions of the Management REST APIs, and in beta SDK packages that provide the feature.
148+
128149
### [**Azure portal**](#tab/portal-user)
129150
130151
1. Sign in to the [Azure portal](https://portal.azure.com)
@@ -149,12 +170,12 @@ A user-assigned managed identity can be scoped to subscriptions, resource groups
149170
150171
### [**REST API**](#tab/rest-user)
151172
152-
You can use the Management REST API instead of the portal to assign a user-assigned managed identity.
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`.
153174
154-
1. Formulate a request to [Create or Update a search service](/rest/api/searchmanagement/services/create-or-update).
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.
155176
156177
```http
157-
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01
178+
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview
158179
{
159180
"location": "[region]",
160181
"sku": {
@@ -178,7 +199,7 @@ You can use the Management REST API instead of the portal to assign a user-assig
178199
179200
+ "type" is the type of identity. Valid values are "SystemAssigned", "UserAssigned", or "SystemAssigned, UserAssigned" for both. A value of "None" clears any previously assigned identities from the search service.
180201
181-
+ "userAssignedIdentities" includes the details of the user assigned managed identity. This identity [must already exist](../active-directory/managed-identities-azure-resources/how-manage-user-assigned-managed-identities.md) before you can specify it in the Create or Update Service request.
202+
+ "userAssignedIdentities" includes the details of the user assigned managed identity. This identity [must already exist](../active-directory/managed-identities-azure-resources/how-manage-user-assigned-managed-identities.md) before you can specify it in the Update Service request.
182203
183204
---
184205
@@ -210,6 +231,8 @@ The following steps illustrate the role assignment workflow. This example is for
210231
211232
Once a managed identity is defined for the search service and given a role assignment, outbound connections can be modified to use the unique resource ID of the other Azure resource. Here are some examples of connection strings for various scenarios.
212233
234+
You can use generally available REST API versions and Azure SDK packages for these connections.
235+
213236
> [!TIP]
214237
> You can create most of these objects in the Azure portal, specifying either a system or user-assigned managed identity, and then view the JSON definition to get the connection string.
215238

0 commit comments

Comments
 (0)