Skip to content

Commit c9474e2

Browse files
authored
Merge pull request #176514 from dereklegenzoff/rbac-how-to
updating rbac signup instructions
2 parents 5cccf6a + 1c8b5de commit c9474e2

File tree

5 files changed

+29
-13
lines changed

5 files changed

+29
-13
lines changed
58.5 KB
Loading

articles/search/search-api-preview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Preview features that transition to general availability are removed from this l
1919
|Feature                         | Category | Description | Availability |
2020
|---------|------------------|-------------|---------------|
2121
| [**Search REST API 2021-04-30-Preview**](/rest/api/searchservice/index-preview) | Security | Modifies [Create or Update Data Source](/rest/api/searchservice/preview-api/create-or-update-data-source) to support managed identities under Azure Active Directory, for indexers that connect to external data sources. | Public preview, [Search REST API 2021-04-30-Preview](/rest/api/searchservice/index-preview) |
22-
| [**Azure RBAC support**](search-security-rbac.md) | Security | Use new built-in roles to control access to indexes and indexing, eliminating or reducing the dependency on API keys. | Public preview ([by request](https://aka.ms/azure-cognitive-search/rbac-preview)). After your subscription is on-boarded, use Azure portal or the Management REST API version 2021-04-01-Preview to configure a search service for data plane authentication. |
22+
| [**Azure RBAC support**](search-security-rbac.md) | Security | Use new built-in roles to control access to indexes and indexing, eliminating or reducing the dependency on API keys. | Public preview ([by request](/azure/search/search-security-rbac?tabs=config-svc-portal%2Croles-portal%2Ctest-portal#step-1-preview-sign-up)). After your subscription is on-boarded, use Azure portal or the Management REST API version 2021-04-01-Preview to configure a search service for data plane authentication. |
2323
| [**Management REST API 2021-04-01-Preview**](/rest/api/searchmanagement/) | Security | Modifies [Create or Update Service](/rest/api/searchmanagement/2021-04-01-preview/services/create-or-update) to support new [DataPlaneAuthOptions](/rest/api/searchmanagement/2021-04-01-preview/services/create-or-update#dataplaneauthoptions). | Public preview, [Management REST API ](/rest/api/searchmanagement/), API version 2021-04-01-Preview.|
2424
| [**Reset Documents**](search-howto-run-reset-indexers.md) | Indexer | Reprocesses individually selected search documents in indexer workloads. | Use the [Reset Documents REST API](/rest/api/searchservice/preview-api/reset-documents), API versions 2021-04-30-Preview or 2020-06-30-Preview. |
2525
| [**Power Query connectors**](search-how-to-index-power-query-data-sources.md) | Indexer data source | Indexers can now index from other cloud platforms. If you are using an indexer to crawl external data sources for indexing, you can now use Power Query connectors to connect to Amazon Redshift, Elasticsearch, PostgreSQL, Salesforce Objects, Salesforce Reports, Smartsheet, and Snowflake. | [Sign up](https://aka.ms/azure-cognitive-search/indexer-preview) is required so that support can be enabled for your subscription on the backend. Configure this data source using [Create or Update Data Source](/rest/api/searchservice/preview-api/create-or-update-data-source), API versions 2021-04-30-Preview or 2020-06-30-Preview, or the Azure portal.|

articles/search/search-howto-aad.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,20 @@ As a first step, [create a search service](search-create-service-portal.md) and
2525

2626
### Sign up for the preview
2727

28-
The parts of Azure Cognitive Search's RBAC capabilities required to use Azure AD for querying the search service are still in a gated preview.
28+
The parts of Azure Cognitive Search's RBAC capabilities required to use Azure AD for querying the search service are still in preview. To use these capabilities, you'll need to add the preview feature to your Azure subscription.
2929

30-
For enrollment into the preview, [fill out this form](https://aka.ms/azure-cognitive-search/rbac-preview).
30+
To add your subscription to the preview:
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.
37+
38+
![sign up for rbac on afec](media/search-howto-aad/rbac-signup-afec.png)
39+
40+
For more information on adding preview features, see [Set up preview features in Azure subscription](/azure/azure-resource-manager/management/preview-features?tabs=azure-portal).
3141

32-
It may take a few business days to process your request.
3342

3443
### Enable RBAC for data plane operations
3544

@@ -38,7 +47,7 @@ Once your subscription is onboarded to the preview, you'll still need to enable
3847
To enable role-based access control:
3948

4049
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).
41-
1. On the left navigation pane, select **Keys**
50+
1. On the left navigation pane, select **Keys**.
4251
1. Determine if you'd like to allow both key-based and role-based access control, or only role-based access control.
4352

4453
![authentication options for azure cognitive search in the portal](media/search-howto-aad/portal-api-access-control.png)
@@ -65,7 +74,7 @@ At this point, you've created your Azure AD application and service principal. M
6574

6675
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.
6776

68-
1. Navigate to the app registration you just created
77+
1. Navigate to the app registration you just created.
6978
1. Select **Certificates and secrets**.
7079
1. Under **Client secrets**, click **New client secret**.
7180
1. Provide a description of the secret and select the desired expiration interval.
@@ -87,7 +96,7 @@ To assign a role to your app registration:
8796
1. On the right side under **Grant access to this resource**, select **Add role assignment**.
8897
1. Select the role you'd like to use and then click **Next**.
8998
1. On the next page, click **Select members** and find the application you created previously.
90-
1. Finally, click **Review + assign**
99+
1. Finally, click **Review + assign**.
91100

92101
![Add role assignment in the azure portal](media/search-howto-aad/role-assignment.png)
93102

articles/search/search-security-rbac.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ Azure provides a global [role-based access control (RBAC) authorization system](
1717

1818
+ Use generally available roles for service administration.
1919

20-
+ Use new preview roles for content management (creating and managing indexes and other top-level objects), [**available by request**](https://aka.ms/azure-cognitive-search/rbac-preview).
20+
+ Use new preview roles for content management (creating and managing indexes and other top-level objects), [**available in preview**](#step-1-preview-sign-up).
2121

2222
> [!NOTE]
23-
> Search Service Contributor is a "generally available" role that has "preview" capabilities. It's the only role that supports a true hybrid of service and content management tasks, allowing all operations on a given search service. To get the preview capabilities of content management on this role, [**sign up for the preview**](https://aka.ms/azure-cognitive-search/rbac-preview).
23+
> Search Service Contributor is a "generally available" role that has "preview" capabilities. It's the only role that supports a true hybrid of service and content management tasks, allowing all operations on a given search service. To get the preview capabilities of content management on this role, [**sign up for the preview**](#step-1-preview-sign-up).
2424
2525
A few RBAC scenarios are **not** supported, or not covered in this article:
2626

@@ -58,11 +58,18 @@ Skip this step if you are using generally available roles (Owner, Contributor, R
5858

5959
New built-in preview roles provide a granular set of permissions over content on the search service. Although built-in roles are always visible in the Azure portal, service enrollment is required to make them operational.
6060

61-
For enrollment into the preview program:
61+
To add your subscription to the preview:
6262

63-
+ [Fill out this form](https://aka.ms/azure-cognitive-search/rbac-preview)
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.
68+
69+
![sign up for rbac on afec](media/search-howto-aad/rbac-signup-afec.png)
70+
71+
For more information on adding preview features, see [Set up preview features in Azure subscription](/azure/azure-resource-manager/management/preview-features?tabs=azure-portal).
6472

65-
It can take up to two business days to process enrollment requests. You'll receive an email when your service is ready.
6673

6774
## Step 2: Preview configuration
6875

articles/search/whats-new.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Learn what's new in the service. Bookmark this page to keep up to date with the
1919
|Feature                         | Description | Availability |
2020
|------------------------------------|--------------|---------------|
2121
| [Search REST API 2021-04-30-Preview](/rest/api/searchservice/index-preview) | Adds REST API support for indexer connections made using [managed identities](search-howto-managed-identities-data-sources.md) and Azure Active Directory (Azure AD) authentication. | Public preview |
22-
| [Role-based authorization (preview)](search-security-rbac.md) | Authenticate using Azure Active Directory and new built-in roles for data plane access to indexes and indexing, eliminating or reducing the dependency on API keys. | Public preview ([by request](https://aka.ms/azure-cognitive-search/rbac-preview)). After your subscription is on-boarded, use Azure portal or the Management REST API version 2021-04-01-Preview to configure a search service for data plane authentication.|
22+
| [Role-based authorization (preview)](search-security-rbac.md) | Authenticate using Azure Active Directory and new built-in roles for data plane access to indexes and indexing, eliminating or reducing the dependency on API keys. | Public preview ([by request](/azure/search/search-security-rbac?tabs=config-svc-portal%2Croles-portal%2Ctest-portal#step-1-preview-sign-up)). After your subscription is on-boarded, use Azure portal or the Management REST API version 2021-04-01-Preview to configure a search service for data plane authentication.|
2323
| [Management REST API 2021-04-01-Preview](/rest/api/searchmanagement/) | Modifies [Create or Update Service](/rest/api/searchmanagement/2021-04-01-preview/services/create-or-update) to support new [DataPlaneAuthOptions](/rest/api/searchmanagement/2021-04-01-preview/services/create-or-update#dataplaneauthoptions). | Public preview |
2424

2525
## May 2021

0 commit comments

Comments
 (0)