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-howto-aad.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ ms.date: 10/04/2021
13
13
# Authorize search requests using Azure AD (preview)
14
14
15
15
> [!IMPORTANT]
16
-
> Role-based access control for data plane operations such as creating an index or querying an index is currently in public preview and available under [supplemental terms of use](https://azure.microsoft.com/support/legal/preview-supplemental-terms/). This functionality is only available in public clouds and may impact the latency of your operations while the functionality is in preview.
16
+
> Role-based access control for data plane operations, such as creating an index or querying an index, is currently in public preview and available under [supplemental terms of use](https://azure.microsoft.com/support/legal/preview-supplemental-terms/). This functionality is only available in public cloud regions and may impact the latency of your operations while the functionality is in preview.
17
17
18
18
With Azure Active Directory (Azure AD), you can use role-based access control (RBAC) to grant access to your Azure Cognitive Search services. A key advantage of using Azure AD is that your credentials no longer need to be stored in your code. Azure AD authenticates the security principal (a user, group, or service principal) running the application. If authentication succeeds, Azure AD returns the access token to the application, and the application can then use the access token to authorize requests to Azure Cognitive Search. To learn more about the advantages of using Azure AD in your applications, see [Integrating with Azure Active Directory](../active-directory/develop/active-directory-how-to-integrate.md#benefits-of-integration).
19
19
@@ -29,28 +29,28 @@ The parts of Azure Cognitive Search's RBAC capabilities required to use Azure AD
29
29
30
30
To add your subscription to the preview:
31
31
32
-
1. Navigate to the **Subscriptions** page in the [Azure portal](https://portal.azure.com/).
33
-
1. Select the subscription you want to use.
34
-
1. On the left-hand side of the subscription page, select **Preview Features**.
35
-
1. Use the search bar or filters to find and select **Role Based Access Control for Search Service (Preview)**
36
-
1. Select **Register** to add the feature to your subscription.
32
+
1. Navigate to your search service in the [Azure portal](https://portal.azure.com/).
33
+
1. On the left-hand side of the page, select **Keys**.
34
+
1. In the blue banner that mentions the preview, select **Register** to add the feature to your subscription.
37
35
38
-

36
+

39
37
40
-
For more information on adding preview features, see [Set up preview features in Azure subscription](../azure-resource-manager/management/preview-features.md?tabs=azure-portal).
38
+
You can also sign up for the preview using Azure Feature Exposure Control (AFEC) and searching for *Role Based Access Control for Search Service (Preview)*. For more information on adding preview features, see [Set up preview features in Azure subscription](../azure-resource-manager/management/preview-features.md?tabs=azure-portal).
41
39
40
+
> [!NOTE]
41
+
> Once you add the preview to your subscription, all services in the subscription will be permanently enrolled in the preview. If you don't want RBAC on a given service, you can disable RBAC for data plane operations as shown in the next step.
42
42
43
43
### Enable RBAC for data plane operations
44
44
45
-
Once your subscription is onboarded to the preview, you'll still need to enable RBAC for data plane operations so that you can use Azure AD authentication. By default, Azure Cognitive Search uses key-based authentication for data plane operations but you can change the setting to allow role-based access control.
45
+
Once your subscription is added to the preview, you'll still need to enable RBAC for data plane operations so that you can use Azure AD authentication. By default, Azure Cognitive Search uses key-based authentication for data plane operations but you can change the setting to allow role-based access control.
46
46
47
47
To enable role-based access control:
48
48
49
-
1. Navigate to the Azure portal with this preview link: [https://ms.portal.azure.com/?feature.enableRbac=true](https://ms.portal.azure.com/?feature.enableRbac=true).
49
+
1. Navigate to your search service in the [Azure portal](https://portal.azure.com/).
50
50
1. On the left navigation pane, select **Keys**.
51
51
1. Determine if you'd like to allow both key-based and role-based access control, or only role-based access control.
52
52
53
-

53
+

54
54
55
55
You can also change these settings programatically as described in the [Azure Cognitive Search RBAC Documentation](./search-security-rbac.md?tabs=config-svc-rest%2croles-powershell%2ctest-rest#step-2-preview-configuration).
56
56
@@ -66,20 +66,20 @@ To register an application with Azure AD:
66
66
1. Select **New Registration**.
67
67
1. Give your application a name and select a supported account type, which determines who can use the application. Then, select **Register**.
68
68
69
-

69
+

70
70
71
71
At this point, you've created your Azure AD application and service principal. Make a note of tenant (or directory) ID and the client (or application) ID on the overview page of your app registration. You'll need those values in a future step.
72
72
73
73
## Create a client secret
74
74
75
75
The application will also need a client secret or certificate to prove its identity when requesting a token. In this document, we'll show how to use a client secret.
76
76
77
-
1. Navigate to the app registration you just created.
77
+
1. Navigate to the app registration you created.
78
78
1. Select **Certificates and secrets**.
79
-
1. Under **Client secrets**, click**New client secret**.
79
+
1. Under **Client secrets**, select**New client secret**.
80
80
1. Provide a description of the secret and select the desired expiration interval.
81
81
82
-

82
+

83
83
84
84
Make sure to save the value of the secret in a secure location as you won't be able to access the value again.
85
85
@@ -94,11 +94,11 @@ To assign a role to your app registration:
94
94
1. Open the Azure portal and navigate to your search service.
95
95
1. Select **Access Control (IAM)** in the left navigation pane.
96
96
1. On the right side under **Grant access to this resource**, select **Add role assignment**.
97
-
1. Select the role you'd like to use and then click**Next**.
98
-
1. On the next page, click**Select members** and find the application you created previously.
99
-
1. Finally, click**Review + assign**.
97
+
1. Select the role you'd like to use and then select**Next**.
98
+
1. On the next page, select**Select members** and find the application you created previously.
99
+
1. Finally, select**Review + assign**.
100
100
101
-

101
+

102
102
103
103
You can also [assign roles using PowerShell](./search-security-rbac.md?tabs=config-svc-rest%2croles-powershell%2ctest-rest#step-3-assign-roles).
Copy file name to clipboardExpand all lines: articles/search/search-security-rbac.md
+11-17Lines changed: 11 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,16 +60,16 @@ New built-in preview roles provide a granular set of permissions over content on
60
60
61
61
To add your subscription to the preview:
62
62
63
-
1. Navigate to the **Subscriptions** page in the [Azure portal](https://portal.azure.com/).
64
-
1. Select the subscription you want to use.
65
-
1. On the left-hand side of the subscription page, select **Preview Features**.
66
-
1. Use the search bar or filters to find and select **Role Based Access Control for Search Service (Preview)**
67
-
1. Select **Register** to add the feature to your subscription.
63
+
1. Navigate to your search service in the [Azure portal](https://portal.azure.com/).
64
+
1. On the left-hand side of the page, select **Keys**.
65
+
1. In the blue banner that mentions the preview, select **Register** to add the feature to your subscription.
68
66
69
-

67
+

70
68
71
-
For more information on adding preview features, see [Set up preview features in Azure subscription](../azure-resource-manager/management/preview-features.md?tabs=azure-portal).
69
+
You can also sign up for the preview using Azure Feature Exposure Control (AFEC) and searching for *Role Based Access Control for Search Service (Preview)*. For more information on adding preview features, see [Set up preview features in Azure subscription](../azure-resource-manager/management/preview-features.md?tabs=azure-portal).
72
70
71
+
> [!NOTE]
72
+
> Once you add the preview to your subscription, all services in the subscription will be permanently enrolled in the preview. If you don't want RBAC on a given service, you can disable RBAC for data plane operations as shown in the next step.
73
73
74
74
## Step 2: Preview configuration
75
75
@@ -81,7 +81,7 @@ In this step, configure your search service to recognize an **authorization** he
81
81
82
82
### [**Azure portal**](#tab/config-svc-portal)
83
83
84
-
1. Open the portal with this syntax: [https://ms.portal.azure.com/?feature.enableRbac=true](https://ms.portal.azure.com/?feature.enableRbac=true).
84
+
1. Open the [Azure portal](https://ms.portal.azure.com).
85
85
86
86
1. Navigate to your search service.
87
87
@@ -144,10 +144,7 @@ You must be an **Owner** or have [Microsoft.Authorization/roleAssignments/write]
144
144
145
145
### [**Azure portal**](#tab/roles-portal)
146
146
147
-
1. For preview roles, open the portal with this syntax: [https://ms.portal.azure.com/?feature.enableRbac=true](https://ms.portal.azure.com/?feature.enableRbac=true). You should see `feature.enableRbac=true` in the URL.
148
-
149
-
> [!NOTE]
150
-
> For users and groups assigned to a preview role, portal content such as indexes and indexers will only be visible if you open the portal with the feature flag.
147
+
1. Open the [Azure portal](https://ms.portal.azure.com).
151
148
152
149
1. Navigate to your search service.
153
150
@@ -200,10 +197,7 @@ Recall that you can only scope access to top-level resources, such as indexes, s
200
197
201
198
### [**Azure portal**](#tab/test-portal)
202
199
203
-
1. For preview roles, open the portal with this syntax: [https://ms.portal.azure.com/?feature.enableRbac=true](https://ms.portal.azure.com/?feature.enableRbac=true).
204
-
205
-
> [!NOTE]
206
-
> For users and groups assigned to a preview role, portal content such as indexes and indexers will only be visible if you open the portal with the feature flag.
200
+
1. Open the [Azure portal](https://ms.portal.azure.com).
207
201
208
202
1. Navigate to your search service.
209
203
@@ -310,4 +304,4 @@ To enable a Conditional Access policy for Azure Cognitive Search, follow the bel
310
304
1. Save the policy.
311
305
312
306
> [!IMPORTANT]
313
-
> If your search service has a managed identity assigned to it, the specific search service will show up as a cloud app that can be included or excluded as part of the Conditional Access policy. Conditional Access policies cannot be enforced on a specific search service. Instead make sure you select the general **Azure Cognitive Search** cloud app.
307
+
> If your search service has a managed identity assigned to it, the specific search service will show up as a cloud app that can be included or excluded as part of the Conditional Access policy. Conditional Access policies cannot be enforced on a specific search service. Instead make sure you select the general **Azure Cognitive Search** cloud app.
0 commit comments