Skip to content

Commit 4a05c33

Browse files
Create Language-RBAC.md
1 parent 540042a commit 4a05c33

File tree

1 file changed

+143
-0
lines changed

1 file changed

+143
-0
lines changed
Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
---
2+
title: Language RBAC
3+
titleSuffix: Azure Cognitive Services
4+
description: Langauge RBAC
5+
services: cognitive-services
6+
author: aahill
7+
manager: nitinme
8+
ms.service: cognitive-services
9+
ms.subservice: language-service
10+
ms.topic: conceptual
11+
ms.date: 06/30/2022
12+
ms.author: aahi
13+
---
14+
15+
16+
# Language role-based access control
17+
18+
Azure Cognative Service for Language supports Azure role-based access control (Azure RBAC), an authorization system for managing individual access to Azure resources. Using Azure RBAC, you assign different team members different levels of permissions for your projects authoring resources. See the [Azure RBAC documentation](/azure/role-based-access-control/) for more information.
19+
20+
## Enable Azure Active Directory authentication
21+
22+
To use Azure RBAC, you must enable Azure Active Directory authentication. You can [create a new resource with a custom subdomain](../authentication.md#create-a-resource-with-a-custom-subdomain) or [create a custom subdomain for your existing resource](../cognitive-services-custom-subdomains.md#how-does-this-impact-existing-resources).
23+
24+
## Add role assignment to Language Authoring resource
25+
26+
Azure RBAC can be assigned to a Language Authoring resource. To grant access to an Azure resource, you add a role assignment.
27+
1. In the [Azure portal](https://ms.portal.azure.com/), select **All services**.
28+
2. Select **Cognitive Services**, and navigate to your specific Language Authoring resource.
29+
1.
30+
> [!NOTE]
31+
> You can also set up Azure RBAC for whole resource groups, subscriptions, or management groups. Do this by selecting the desired scope level and then navigating to the desired item. For example, selecting **Resource groups** and then navigating to a specific resource group.
32+
33+
1. Select **Access control (IAM)** on the left navigation pane.
34+
1. Select **Add**, then select **Add role assignment**.
35+
1. On the **Role** tab on the next screen, select a role you want to add.
36+
1. On the **Members** tab, select a user, group, service principal, or managed identity.
37+
1. On the **Review + assign** tab, select **Review + assign** to assign the role.
38+
39+
Within a few minutes, the target will be assigned the selected role at the selected scope. For help with these steps, see [Assign Azure roles using the Azure portal](/azure/role-based-access-control/role-assignments-portal).
40+
41+
## Language role types
42+
43+
Use the following table to determine access needs for your Language projects.
44+
45+
These custom roles only apply to Language authoring resources.
46+
> [!NOTE]
47+
> All prebuilt capabilities are accessible to all roles
48+
> 'Owner' and 'Contibutor' roles take priority over the custom language roles
49+
> AAD is only used in case of custom Language roles
50+
51+
### Cognitive Services Language reader
52+
53+
A user that should only be validating and reviewing the Language apps, typically a tester to ensure the application is performing well before deploying the project. They may want to review the application’s assets to notify the app developers of any changes that need to be made, but do not have direct access to make them. Readers will have access to view the evaluation results.
54+
55+
56+
:::row:::
57+
:::column span="":::
58+
**Capabilities**
59+
:::column-end:::
60+
:::column span="":::
61+
**API Access**
62+
:::column-end:::
63+
:::row-end:::
64+
:::row:::
65+
:::column span="":::
66+
* Read
67+
* Test
68+
:::column-end:::
69+
:::column span="":::
70+
* All GET APIs under:
71+
* [Language Authoring CLU APIs](https://docs.microsoft.com/en-us/rest/api/language/conversational-analysis-authoring)
72+
* [Language Authoring Text Analysis APIs](https://docs.microsoft.com/en-us/rest/api/language/text-analysis-authoring)
73+
* [Question Answering Projects](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/questionanswering/question-answering-projects)
74+
* Only TriggerExportProjectJob POST operation under:
75+
* [Language Authoring CLU export API](https://docs.microsoft.com/en-us/rest/api/language/conversational-analysis-authoring/export?tabs=HTTP)
76+
* [Language Authoring Text Analysis export API](https://docs.microsoft.com/en-us/rest/api/language/text-analysis-authoring/export?tabs=HTTP)
77+
* Only Export POST operation under:
78+
* [Question Answering Projects](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/questionanswering/question-answering-projects/export)
79+
* All the Batch Testing Web APIs
80+
*[Language Runtime CLU APIs](https://docs.microsoft.com/en-us/rest/api/language/conversation-analysis-runtime)
81+
*[Language Runtime Text Analysis APIs](https://docs.microsoft.com/en-us/rest/api/language/text-analysis-runtime)
82+
:::column-end:::
83+
:::row-end:::
84+
85+
### Cognitive Services Language writer
86+
87+
A user that is responsible for building and modifying an application, as a collaborator in a larger team. The collaborator can modify the Language apps in any way, train those changes, and validate/test those changes in the portal. However, this user shouldn’t have access to deploying this application to the runtime, as they may accidentally reflect their changes in production. They also shouldn’t be able to delete the application or alter its prediction resources and endpoint settings (assigning or unassigning prediction resources, making the endpoint public). This restricts this role from altering an application currently being used in production. They may also create new applications under this resource, but with the restrictions mentioned.
88+
89+
:::row:::
90+
:::column span="":::
91+
**Capabilities**
92+
:::column-end:::
93+
:::column span="":::
94+
**API Access**
95+
:::column-end:::
96+
:::row-end:::
97+
:::row:::
98+
:::column span="":::
99+
* All functionalties under Cognitive Services Language Reader.
100+
* Ability to:
101+
* Train
102+
* Write
103+
:::column-end:::
104+
:::column span="":::
105+
* All APIs under Language reader
106+
* All POST, PUT and PATCH APIs under:
107+
* [Language Authoring CLU APIs](https://docs.microsoft.com/en-us/rest/api/language/conversational-analysis-authoring)
108+
* [Language Authoring Text Analysis APIs](https://docs.microsoft.com/en-us/rest/api/language/text-analysis-authoring)
109+
* [Question Answering Projects](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/questionanswering/question-answering-projects)
110+
Except for
111+
* Delete deployment
112+
* Delete trained model
113+
* Delete Project
114+
* Deploy Model
115+
:::column-end:::
116+
:::row-end:::
117+
118+
### Cognitive Services Language owner
119+
120+
These users are the gatekeepers for the Language applications in production environments. They should have full access to any of the underlying functions and thus can view everything in the application and have direct access to edit any changes for both authoring and runtime environments
121+
122+
:::row:::
123+
:::column span="":::
124+
**Functionality**
125+
:::column-end:::
126+
:::column span="":::
127+
**API Access**
128+
:::column-end:::
129+
:::row-end:::
130+
:::row:::
131+
:::column span="":::
132+
* All functionalties under Cognitive Services Language Writer
133+
* Deploy
134+
* Delete
135+
:::column-end:::
136+
:::column span="":::
137+
* All APIs available under:
138+
* [Language Authoring CLU APIs](https://docs.microsoft.com/en-us/rest/api/language/conversational-analysis-authoring)
139+
* [Language Authoring Text Analysis APIs](https://docs.microsoft.com/en-us/rest/api/language/text-analysis-authoring)
140+
* [Question Answering Projects](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/questionanswering/question-answering-projects)
141+
142+
:::column-end:::
143+
:::row-end:::

0 commit comments

Comments
 (0)