Skip to content

Commit 74a0186

Browse files
Merge pull request #224008 from HeidiSteen/heidist-rbac
Small updates for readability
2 parents 6eb1f84 + df2b10f commit 74a0186

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ ms.date: 01/14/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 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.
19-
2018
> [!NOTE]
2119
> 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.
2220
@@ -35,6 +33,8 @@ Visually, there's no distinction between an admin key or query key. Both keys ar
3533

3634
## Use API keys on connections
3735

36+
API keys are used for data plane (content) requests, such as creating or accessing an index or any other request that's represented in the [Search REST APIs](/rest/api/searchservice/). Upon service creation, an API key is the only authentication mechanism for data plane 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.
37+
3838
API keys are specified on client requests to a search service. Passing a valid API key on the request is considered proof that the request is from an authorized client. If you're creating, modifying, or deleting objects, you'll need an admin API key. Otherwise, query keys are typically distributed to client applications that issue queries.
3939

4040
You can specify API keys in a request header for REST API calls, or in code that calls the azure.search.documents client libraries in the Azure SDKs. If you're using the Azure portal to perform tasks, your role assignment determines the [level of access](#permissions-to-view-or-manage-api-keys).

articles/search/search-security-rbac.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,13 +224,13 @@ This approach assumes Postman as the REST client and uses a Postman collection a
224224
az login
225225
```
226226

227-
1. Get your subscription ID. You'll provide this value as variable in a future step.
227+
1. Get your subscription ID. You'll provide this value as variable in a future step.
228228

229229
```azurecli
230230
az account show --query id -o tsv
231231
````
232232
233-
1. Create a resource group for your security principal, specifying a location and name. This example uses the West US region. You'll provide this value as variable in a future step.
233+
1. Create a resource group for your security principal, specifying a location and name. This example uses the West US region. You'll provide this value as variable in a future step. The role you'll create will be scoped to the resource group.
234234
235235
```azurecli
236236
az group create -l westus -n MyResourceGroup

0 commit comments

Comments
 (0)