Skip to content

Commit c5d6b13

Browse files
committed
crosslinks, intro clean up
1 parent 7e13ab2 commit c5d6b13

File tree

5 files changed

+24
-25
lines changed

5 files changed

+24
-25
lines changed

articles/search/TOC.yml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -422,32 +422,18 @@
422422
items:
423423
- name: Configure network access
424424
href: service-configure-firewall.md
425+
- name: Authenticate with keys
426+
href: search-security-api-keys.md
425427
- name: Enable role-based access
426428
href: search-security-enable-roles.md
427429
- name: Assign roles (users)
428430
href: search-security-rbac.md
429431
- name: Assign roles (apps)
430432
href: keyless-connections.md
431-
- name: Authenticate using API keys
432-
href: search-security-api-keys.md
433-
- name: Advanced options
434-
items:
435-
- name: Create a private endpoint
436-
href: service-create-private-endpoint.md
437-
- name: Troubleshoot private connections
438-
href: troubleshoot-shared-private-link-resources.md
439-
- name: Data encryption
440-
items:
441-
- name: Customer-managed keys
442-
href: search-security-manage-encryption-keys.md
443-
- name: Find encrypted objects
444-
href: search-security-get-encryption-keys.md
445433
- name: Outbound connections
446434
items:
447435
- name: Configure a managed identity
448436
href: search-howto-managed-identities-data-sources.md
449-
- name: Connect as a trusted service
450-
href: search-indexer-howto-access-trusted-service-exception.md
451437
- name: Connect using a managed identity
452438
items:
453439
- name: Azure Storage
@@ -460,12 +446,26 @@
460446
href: search-index-azure-sql-managed-instance-with-managed-identity.md
461447
- name: Connect through a firewall
462448
href: search-indexer-howto-access-ip-restricted.md
449+
- name: Connect as a trusted service
450+
href: search-indexer-howto-access-trusted-service-exception.md
463451
- name: Connect through a shared private link
464452
href: search-indexer-howto-access-private.md
465453
- name: Connect to a SQL managed instance private endpoint
466454
href: search-indexer-how-to-access-private-sql.md
467455
- name: Document-level security
468456
href: search-security-trimming-for-azure-search.md
457+
- name: Advanced options
458+
items:
459+
- name: Create a private endpoint
460+
href: service-create-private-endpoint.md
461+
- name: Troubleshoot private connections
462+
href: troubleshoot-shared-private-link-resources.md
463+
- name: Data encryption
464+
items:
465+
- name: Customer-managed keys
466+
href: search-security-manage-encryption-keys.md
467+
- name: Find encrypted objects
468+
href: search-security-get-encryption-keys.md
469469
- name: Development
470470
items:
471471
- name: API versions

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

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,14 @@ ms.service: cognitive-search
1010
ms.custom:
1111
- ignite-2023
1212
ms.topic: how-to
13-
ms.date: 04/22/2024
13+
ms.date: 06/28/2024
1414
---
1515

1616
# Connect to Azure AI Search using key authentication
1717

1818
Azure AI Search offers key-based authentication that you can use on connections to your search service. An API key is a unique string composed of 52 randomly generated numbers and letters. A request made to a search service endpoint is accepted if both the request and the API key are valid.
1919

20-
Key-based authentication is the default. You can disable it if you opt in for role-based authentication.
21-
22-
> [!NOTE]
23-
> A quick note about *key* terminology. An *API key* is a GUID used for authentication. A separate term, *document key* is a unique string in your indexed content that uniquely identifies documents in a search index.
20+
Key-based authentication is the default. You can disable it if you opt in for [role-based authentication](search-security-enable-roles.md).
2421

2522
## Types of API keys
2623

articles/search/search-security-enable-roles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ms.date: 06/18/2024
1616

1717
If you want to use Azure role assignments for authorized access to Azure AI Search, this article explains how to enable role-based access for your search service.
1818

19-
Role-based access for data plane operations is optional, but recommended. The alternative is [key-based authentication](search-security-api-keys.md), which is the default.
19+
Role-based access for data plane operations is optional, but recommended as the more secure option. The alternative is [key-based authentication](search-security-api-keys.md), which is the default.
2020

2121
Roles for service administration (control plane) are built in and can't be enabled or disabled.
2222

articles/search/search-security-rbac.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,9 +180,11 @@ New-AzRoleAssignment -SignInName <email> `
180180

181181
### Assign roles for read-only queries
182182

183-
Use the Search Index Data Reader role for apps and processes that only need read-access to an index. This is a very specific role. It grants [GET or POST access](/rest/api/searchservice/documents) to the *documents collection of a search index* for search, autocomplete, and suggestions.
183+
Use the Search Index Data Reader role for apps and processes that only need read-access to an index.
184184

185-
It doesn't support GET or LIST operations on an index or other top-level objects, or GET service statistics.
185+
This is a very specific role. It grants [GET or POST access](/rest/api/searchservice/documents) to the *documents collection of a search index* for search, autocomplete, and suggestions. It doesn't support GET or LIST operations on an index or other top-level objects, or GET service statistics.
186+
187+
This section provides basic steps for setting up the role assignment and is here for completeness, but we recommend [Use Azure AI Search without keys ](keyless-connections.md) for comprehensive instructions on configuring your app for role-based access.
186188

187189
#### [**Azure portal**](#tab/roles-portal-query)
188190

articles/search/service-configure-firewall.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.date: 06/27/2024
1515

1616
# Configure network access and firewall rules for Azure AI Search
1717

18-
By default, Azure AI Search is configured to allow connections over a public endpoint. Access to a search service *through* the public endpoint is protected by authentication and authorization protocols, but the endpoint itself is open to the internet at the network layer.
18+
By default, Azure AI Search is configured to allow connections over a public endpoint. Access to a search service *through* the public endpoint is protected by authentication and authorization protocols, but the endpoint itself is open to the internet at the network layer for data plane requests.
1919

2020
If you aren't hosting a public web site, you might want to configure network access to automatically refuse requests unless they originate from an approved set of devices and cloud services. There are two mechanisms:
2121

0 commit comments

Comments
 (0)