Skip to content

Commit 3e10403

Browse files
Merge pull request #223822 from HeidiSteen/heidist-rbac
[azure search] RBAC-related updates
2 parents 1a9f1ec + a911343 commit 3e10403

File tree

3 files changed

+53
-37
lines changed

3 files changed

+53
-37
lines changed

articles/search/search-manage.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.author: heidist
99
tags: azure-portal
1010
ms.service: cognitive-search
1111
ms.topic: conceptual
12-
ms.date: 12/21/2022
12+
ms.date: 01/12/2023
1313
---
1414
# Service administration for Azure Cognitive Search in the Azure portal
1515

@@ -62,8 +62,8 @@ Several aspects of a search service are determined when the service is provision
6262
Service administration includes the following tasks:
6363

6464
* [Adjust capacity](search-capacity-planning.md) by adding or removing replicas and partitions
65-
* [Rotate API keys](search-security-api-keys.md) used for admin and query operations
66-
* [Control access to admin operations](search-security-rbac.md) through role-based security
65+
* [Manage API keys](search-security-api-keys.md) used for admin and query operations
66+
* [Allow or deny access using Azure roles](search-security-rbac.md)
6767
* [Configure IP firewall rules](service-configure-firewall.md) to restrict access by IP address
6868
* [Configure a private endpoint](service-create-private-endpoint.md) using Azure Private Link and a private virtual network
6969
* [Monitor service health and operations](monitor-azure-cognitive-search.md): storage, query volumes, and latency
@@ -92,22 +92,24 @@ Internally, Microsoft collects telemetry data about your service and the platfor
9292
| Telemetry | One and a half years |
9393

9494
> [!NOTE]
95-
> This section is about monitoring data. For questions about customer data and privacy, see the ["Data residency"](search-security-overview.md#data-residency) section of the security overview article.
95+
> See the ["Data residency"](search-security-overview.md#data-residency) section of the security overview article for more information about data location and privacy.
9696
9797
## Administrator permissions
9898

9999
When you open the search service overview page, the Azure role assigned to your account determines what portal content is available to you. The overview page at the beginning of the article shows the portal content available to an Owner or Contributor.
100100

101-
Control plane roles include the following items:
101+
Azure roles used for service administration include:
102102

103103
* Owner
104104
* Contributor (same as Owner, minus the ability to assign roles)
105-
* Reader (access to service information and the Monitoring tab)
105+
* Reader (provides access to service information in the Essentials section and in the Monitoring tab)
106106

107-
If you want a combination of control plane and data plane permissions, consider Search Service Contributor. For more information, see [Built-in roles](search-security-rbac.md#built-in-roles-used-in-search).
107+
By default, all search services start with at least one Owner. Owners, service administrators, and co-administrators have permission to create other administrators and other role assignments.
108+
109+
Also by default, search services start with API keys for content-related tasks that an Owner or Contributor might perform in the portal. However, it's possible to turn off [API key authentication](search-security-api-keys.md) and use [Azure role-based access control](search-security-rbac.md#built-in-roles-used-in-search) exclusively. If you turn off API keys, be sure to set up data access role assignments so that all features in the portal remain operational.
108110

109111
> [!TIP]
110-
> By default, any Owner or Co-owner can create or delete services. To prevent accidental deletions, you can [lock resources](../azure-resource-manager/management/lock-resources.md).
112+
> By default, any owner or administrator can create or delete services. To prevent accidental deletions, you can [lock resources](../azure-resource-manager/management/lock-resources.md).
111113
112114
## Next steps
113115

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Connect with API keys
2+
title: Connect using API keys
33
titleSuffix: Azure Cognitive Search
44
description: Learn how to use an admin or query API key for inbound access to an Azure Cognitive Search service endpoint.
55

@@ -15,10 +15,10 @@ ms.date: 01/10/2023
1515

1616
Cognitive 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 will be accepted if both the request and the API key are valid.
1717

18-
API keys are frequently used when making REST API calls to a search service. You can also use them in search solutions if Azure Active Directory isn't an option.
18+
API keys are used for content-related requests, such as creating or querying an index. Upon service creation, it's the only authentication mechanism for data plane (content) operations, but you can replace or supplement key authentication with [Azure roles](search-security-rbac.md) if you can't use hard-coded keys in your code.
1919

2020
> [!NOTE]
21-
> A quick note about "key" terminology in Cognitive Search. An "API key", which is described in this article, refers to a GUID used for authenticating a request. A "document key" refers to a unique string in your indexed content that's used to uniquely identify documents in a search index. API keys and document keys are unrelated.
21+
> A quick note about how "key" terminology is used in Cognitive Search. An "API key", which is described in this article, refers to a GUID used for authenticating a request. A separate term, "document key", refers to a unique string in your indexed content that's used to uniquely identify documents in a search index.
2222
2323
## Types of API keys
2424

0 commit comments

Comments
 (0)