Skip to content

Commit 4135a6f

Browse files
authored
Merge pull request #1702 from HeidiSteen/heidist-uuf
[azure search] network security perimeter filename typo + managed identity clarification
2 parents 06ea361 + c852ff2 commit 4135a6f

6 files changed

+29
-13
lines changed

articles/search/.openpublishing.redirection.search.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
{
22
"redirections": [
3+
{
4+
"source_path_from_root": "/articles/search/search-security-network-security-perimiter.md",
5+
"redirect_url": "/azure/search/search-security-network-security-perimeter",
6+
"redirect_document_id": true
7+
},
38
{
49
"source_path_from_root": "/articles/search/cognitive-search-quickstart-blob.md",
510
"redirect_url": "/azure/search/search-get-started-skillset",

articles/search/search-api-preview.md

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

5858
|Feature                         | Category | Description | Availability |
5959
|---------|------------------|-------------|---------------|
60-
| [**Network security perimeter**](search-security-network-security-perimiter.md) | Service | Join a search service to a [network security perimeter](/azure/private-link/network-security-perimeter-concepts) to control network access to your search service. | The Azure portal and the [Network Security Perimeter APIs 2024-06-01-preview](/rest/api/searchmanagement/network-security-perimeter-configurations?view=rest-searchmanagement-2024-06-01-preview&preserve-view=true). |
60+
| [**Network security perimeter**](search-security-network-security-perimeter.md) | Service | Join a search service to a [network security perimeter](/azure/private-link/network-security-perimeter-concepts) to control network access to your search service. | The Azure portal and the [Network Security Perimeter APIs 2024-06-01-preview](/rest/api/searchmanagement/network-security-perimeter-configurations?view=rest-searchmanagement-2024-06-01-preview&preserve-view=true). |
6161
| [**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. |
6262

6363
## Preview features in Azure SDKs

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

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ ms.custom:
1111
- ignite-2023
1212
- build-2024
1313
ms.topic: how-to
14-
ms.date: 09/11/2024
14+
ms.date: 11/22/2024
1515
---
1616

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

1919
> [!IMPORTANT]
20-
> User-assigned managed identity assignment 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 assignment for Azure AI Search. Support for a system-assigned managed identity is generally available.
20+
> User-assigned managed identity assignment 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 assignment for Azure AI Search. Support for a *system-assigned* managed identity is generally available.
2121
2222
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.
2323

24-
To use roles on an outbound connection, first configure your search service to use either a [system-assigned or user-assigned managed identity](/azure/active-directory/managed-identities-azure-resources/overview) 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.
24+
To use roles on an outbound connection, first configure your search service to use either a [system-assigned or user-assigned managed identity](/azure/active-directory/managed-identities-azure-resources/overview) as the security principal 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.
2525

2626
## Prerequisites
2727

@@ -201,7 +201,6 @@ You can use a preview Management REST API instead of the portal to assign a user
201201
202202
+ "userAssignedIdentities" includes the details of the user assigned managed identity. This identity [must already exist](/azure/active-directory/managed-identities-azure-resources/how-manage-user-assigned-managed-identities) before you can specify it in the Update Service request.
203203
204-
205204
---
206205
207206
## Assign a role
@@ -295,7 +294,11 @@ A debug session runs in the portal and takes a connection string when you start
295294

296295
[**Custom skill:**](cognitive-search-custom-skill-interface.md)
297296

298-
A custom skill targets the endpoint of an Azure function or app hosting custom code. The endpoint is specified in the [custom skill definition](cognitive-search-custom-skill-web-api.md). The presence of the "authResourceId" tells the search service to connect using a managed identity, passing the application ID of the target function or app in the property.
297+
A [custom skill](cognitive-search-custom-skill-web-api.md) targets the endpoint of an Azure function or app hosting custom code.
298+
299+
+ `uri` is the endpoint of the function or app.
300+
301+
+ `authResourceId` tells the search service to connect using a managed identity, passing the application ID of the target function or app in the property.
299302

300303
```json
301304
{
@@ -312,7 +315,9 @@ A custom skill targets the endpoint of an Azure function or app hosting custom c
312315

313316
[**Azure OpenAI embedding skill**](cognitive-search-skill-azure-openai-embedding.md) and [**Azure OpenAI vectorizer:**](vector-search-how-to-configure-vectorizer.md)
314317

315-
An Azure OpenAI embedding skill and vectorizer in AI Search target the endpoint of an Azure OpenAI service hosting an embedding model. The endpoint is specified in the [Azure OpenAI embedding skill definition](cognitive-search-skill-azure-openai-embedding.md) and/or in the [Azure OpenAI vectorizer definition](vector-search-how-to-configure-vectorizer.md). The system-managed identity is used if configured and if the "apikey" and "authIdentity" are empty. The "authIdentity" property is used for user-assigned managed identity only.
318+
An Azure OpenAI embedding skill and vectorizer in AI Search target the endpoint of an Azure OpenAI service hosting an embedding model. The endpoint is specified in the [Azure OpenAI embedding skill definition](cognitive-search-skill-azure-openai-embedding.md) and/or in the [Azure OpenAI vectorizer definition](vector-search-how-to-configure-vectorizer.md).
319+
320+
The system-managed identity is used automatically if `"apikey"` and `"authIdentity"` are empty, as demonstrated in the following example. The `"authIdentity"` property is used for user-assigned managed identity only.
316321

317322
**System-managed identity example:**
318323

@@ -337,6 +342,8 @@ A custom skill targets the endpoint of an Azure function or app hosting custom c
337342
}
338343
```
339344

345+
Here's a [vectorizer example](vector-search-how-to-configure-vectorizer.md) configured for a system-assigned managed identity. A vectorizer is specified in a search index.
346+
340347
```json
341348
"vectorizers": [
342349
{
@@ -353,6 +360,8 @@ A custom skill targets the endpoint of an Azure function or app hosting custom c
353360

354361
**User-assigned managed identity example:**
355362

363+
A user-assigned managed identity is used if `"apiKey"` is empty and a valid `"authIdentity"` is provided.
364+
356365
```json
357366
{
358367
"@odata.type": "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill",
@@ -378,6 +387,8 @@ A custom skill targets the endpoint of an Azure function or app hosting custom c
378387
}
379388
```
380389

390+
Here's a [vectorizer example](vector-search-how-to-configure-vectorizer.md) configured for a user-assigned managed identity. A vectorizer is specified in a search index.
391+
381392
```json
382393
"vectorizers": [
383394
{
@@ -398,11 +409,11 @@ A custom skill targets the endpoint of an Azure function or app hosting custom c
398409

399410
## Check for firewall access
400411

401-
If your Azure resource is behind a firewall, make sure there's an inbound rule that admits requests from your search service.
412+
If your Azure resource is behind a firewall, make sure there's an inbound rule that admits requests from your search service and from the Azure portal.
402413

403414
+ For same-region connections to Azure Blob Storage or Azure Data Lake Storage Gen2, use a system managed identity and the [trusted service exception](search-indexer-howto-access-trusted-service-exception.md). Optionally, you can configure a [resource instance rule](/azure/storage/common/storage-network-security#grant-access-from-azure-resource-instances) to admit requests.
404415

405-
+ For all other resources and connections, [configure an IP firewall rule](search-indexer-howto-access-ip-restricted.md) that admits requests from Search. See [Indexer access to content protected by Azure network security features](search-indexer-securing-resources.md) for details.
416+
+ For all other resources and connections, [configure an IP firewall rule](search-indexer-howto-access-ip-restricted.md) that admits requests from Azure AI Search. See [Indexer access to content protected by Azure network security features](search-indexer-securing-resources.md) for details.
406417

407418
## See also
408419

articles/search/search-security-network-security-perimiter.md renamed to articles/search/search-security-network-security-perimeter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ You can add a search service to a network security perimeter in the Azure portal
4545

4646
Azure Network Security Perimeter allows administrators to define a logical network isolation boundary for PaaS resources (for example, Azure Storage and Azure SQL Database) that are deployed outside virtual networks. It restricts communication to resources within the perimeter, and it allows non-perimeter public traffic through inbound and outbound access rules.
4747

48-
You can add Azure AI Search to a network security perimiter so that all indexing and query requests occur within the security boundary.
48+
You can add Azure AI Search to a network security perimeter so that all indexing and query requests occur within the security boundary.
4949

5050
1. In the Azure portal, create or find the network security perimeter service for your subscription.
5151

@@ -269,7 +269,7 @@ In order to test your connection through network security perimeter, you need ac
269269

270270
## View and manage network security perimeter configuration
271271

272-
You can use the [Network Security Perimiter Configuration REST APIs](/rest/api/searchmanagement/network-security-perimeter-configurations?view=rest-searchmanagement-2024-06-01-preview&preserve-view=true) to review and reconcile perimeter configurations.
272+
You can use the [Network Security Perimeter Configuration REST APIs](/rest/api/searchmanagement/network-security-perimeter-configurations?view=rest-searchmanagement-2024-06-01-preview&preserve-view=true) to review and reconcile perimeter configurations.
273273

274274
Be sure to use preview API version `2024-06-01-preview`. [Learn how to call the Management REST APIs](search-manage-rest.md).
275275

articles/search/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@ items:
469469
- name: Connect through a firewall
470470
href: search-indexer-howto-access-ip-restricted.md
471471
- name: Connect using Network Security Perimeter
472-
href: search-security-network-security-perimiter.md
472+
href: search-security-network-security-perimeter.md
473473
- name: Connect as a trusted service
474474
href: search-indexer-howto-access-trusted-service-exception.md
475475
- name: Connect through a shared private link

articles/search/whats-new.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ ms.custom:
2424

2525
| Item                         | Type | Description |
2626
|-----------------------------|------|--------------|
27-
| [**Network security perimeter**](search-security-network-security-perimiter.md) | Security | Join a search service to a [network security perimeter](/azure/private-link/network-security-perimeter-concepts) to control network access to your search service. The Azure portal and the Management REST APIs in the [2024-06-01-preview](/rest/api/searchmanagement/network-security-perimeter-configurations?view=rest-searchmanagement-2024-06-01-preview&preserve-view=true) can be used to view and reconcile network security perimeter configurations. |
27+
| [**Network security perimeter**](search-security-network-security-perimeter.md) | Security | Join a search service to a [network security perimeter](/azure/private-link/network-security-perimeter-concepts) to control network access to your search service. The Azure portal and the Management REST APIs in the [2024-06-01-preview](/rest/api/searchmanagement/network-security-perimeter-configurations?view=rest-searchmanagement-2024-06-01-preview&preserve-view=true) can be used to view and reconcile network security perimeter configurations. |
2828
| [**Shared private link support for Azure AI service connections**](search-indexer-howto-access-private.md) | Security | Connections to Azure AI for built-in skills processing can now be private using a shared private link on the connection. |
2929
| [**Rescoring options for compressed vectors**](/azure/search/vector-search-how-to-quantization?tabs=2024-11-01-preview%2Cquery-2024-07-01#add-compressions-to-a-search-index) | Relevance | You can set options to rescore with original vectors instead of compressed vectors. Applies to HNSW and exhaustive KNN vector algorithms, using binary and scalar compression. Available in the [Create or Update Index (2024-11-01-preview)](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2024-09-01-preview&preserve-view=true), the Azure portal, and in the Azure SDK beta packages that provide this feature. |
3030
| [**Store fewer vector instances**](vector-search-how-to-storage-options.md) | vector search | In vector compression scenarios, you can omit storage of full precision vectors if you don't need them for rescoring. Available in the [Create or Update Index (2024-11-01-preview)](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2024-09-01-preview&preserve-view=true), the Azure portal, and in the Azure SDK beta packages that provide this feature. |

0 commit comments

Comments
 (0)