You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/search/search-get-started-rest.md
+12-13Lines changed: 12 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ If you don't have an Azure subscription, create a [free account](https://azure.m
28
28
29
29
## Download files
30
30
31
-
[Download a REST sample](https://github.com/Azure-Samples/azure-search-rest-samples/tree/main/Quickstart) from GitHub to send the requests in this quickstart. For more information, see[Downloading files from GitHub](https://docs.github.com/get-started/start-your-journey/downloading-files-from-github).
31
+
[Download a REST sample](https://github.com/Azure-Samples/azure-search-rest-samples/tree/main/Quickstart) from GitHub to send the requests in this quickstart. Instructions can be found at[Downloading files from GitHub](https://docs.github.com/get-started/start-your-journey/downloading-files-from-github).
32
32
33
33
You can also start a new file on your local system and create requests manually by using the instructions in this article.
34
34
@@ -40,33 +40,29 @@ You can find the search service endpoint in the Azure portal.
40
40
41
41
1. On the **Overview** home page, find the URL. An example endpoint might look like `https://mydemo.search.windows.net`.
42
42
43
-
You're pasting this endpoint into the `.rest` or `.http` file that you create in a later step.
43
+
:::image type="content" source="media/search-get-started-rest/get-endpoint.png" alt-text="Screenshot of the URL property on the overview page.":::
44
+
45
+
You're pasting this endpoint into the `.rest` or `.http` file in a later step.
44
46
45
47
## Configure access
46
48
47
49
Requests to the search endpoint must be authenticated and authorized. You can use API keys or roles for this task. Keys are easier to start with, but roles are more secure.
48
50
49
51
### Use API keys
50
52
51
-
Select **Settings** > **Keys** and then copy an admin key. Admin keys are used to add, modify, and delete objects. There are two interchangeable admin keys. Copy either one
53
+
Select **Settings** > **Keys** and then copy an admin key. Admin keys are used to add, modify, and delete objects. There are two interchangeable admin keys. Copy either one.
52
54
53
-
You're pasting this key into the `.rest` or `.http` file that you create in a later step.
55
+
You're pasting this key into the `.rest` or `.http` file in a later step.
54
56
55
-
:::image type="content" source="media/search-get-started-rest/get-url-key.png" alt-text="Screenshot that shows the URL and API keys in the Azure portal.":::
57
+
:::image type="content" source="media/search-get-started-rest/get-api-key.png" alt-text="Screenshot that shows the API keys in the Azure portal.":::
56
58
57
59
For more information, see [Connect to Azure AI Search using key authentication](search-security-api-keys.md).
58
60
59
61
### Use roles
60
62
61
-
Make sure your search service is [configured for role-based access](search-security-enable-roles.md).
62
-
63
-
You must have preconfigured [role-assignments for developer access](search-security-rbac.md#assign-roles-for-development). Your role assignments must grant permission to create, load, and query a search index.
64
-
65
-
Obtain your personal identity token using either the Azure CLI, Azure PowerShell, or the Azure portal.
63
+
Make sure your search service is [configured for role-based access](search-security-enable-roles.md). You must have preconfigured [role-assignments for developer access](search-security-rbac.md#assign-roles-for-development). Your role assignments must grant permission to create, load, and query a search index.
66
64
67
-
This section assumes you're using a local client that connects to Azure AI Search on your behalf. An alternative approach is [getting a token for the client app](/entra/identity-platform/v2-oauth2-client-creds-grant-flow), assuming your application is [registered](/entra/identity-platform/quickstart-register-app) with Microsoft Entra ID.
68
-
69
-
You're pasting your personal identity token into the `.rest` or `.http` file that you create in a later step.
65
+
In this section, obtain your personal identity token using either the Azure CLI, Azure PowerShell, or the Azure portal. You're pasting your personal identity token into the `.rest` or `.http` file in a later step.
70
66
71
67
#### [Azure CLI](#tab/azure-cli)
72
68
@@ -103,6 +99,9 @@ Use the steps found here: [find the user object ID](/partner-center/find-ids-and
103
99
104
100
---
105
101
102
+
> [!NOTE]
103
+
> This section assumes you're using a local client that connects to Azure AI Search on your behalf. An alternative approach is [getting a token for the client app](/entra/identity-platform/v2-oauth2-client-creds-grant-flow), assuming your application is [registered](/entra/identity-platform/quickstart-register-app) with Microsoft Entra ID.
104
+
106
105
## Set up Visual Studio Code
107
106
108
107
If you're not familiar with the REST client for Visual Studio Code, this section includes setup so that you can complete the tasks in this quickstart.
0 commit comments