Security roles
Principals are granted access to resources through a role-based access control model, where their assigned security roles determine their resource access.
When a principal attempts an operation, the system performs an authorization check to make sure the principal is associated with at least one security role that grants permissions to perform the operation. Failing an authorization check aborts the operation.
The management commands listed in this article can be used to manage principals and their security roles on databases, tables, external tables, materialized views, and functions.
To learn how to configure them in the Azure portal, see Manage cluster permissions.
Management commands
The following table describes the commands used for managing security roles.
| Command | Description |
|---|---|
.show | Lists principals with the given role. |
.add | Adds one or more principals to the role. |
.drop | Removes one or more principals from the role. |
.set | Sets the role to the specific list of principals, removing all previous ones. |
Security roles
The following table describes the level of access granted for each role and shows a check if the role can be assigned within the given object type.
| Role | Permissions | Databases | Tables | External tables | Materialized views | Functions |
|---|---|---|---|---|---|---|
admins | View, modify, and remove the object and subobjects. | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
users | View the object and create new subobjects. | ✔️ | ||||
viewers | View the object where RestrictedViewAccess isn’t turned on. | ✔️ | ||||
unrestrictedviewers | View the object even where RestrictedViewAccess is turned on. The principal must also have admins, viewers or users permissions. | ✔️ | ||||
ingestors | Ingest data to the object without access to query. | ✔️ | ✔️ | |||
monitors | View metadata such as schemas, operations, and permissions. | ✔️ |
For a full description of the security roles at each scope, see Kusto role-based access control.
Common scenarios
Show your principal roles
To see your own roles on the cluster, run the following command:
To see your own roles on the eventhouse, run the following command:
.show cluster principal roles
Show your roles on a resource
To check the roles assigned to you on a specific resource, run the following command within the relevant database or the database that contains the resource:
// For a database:
.show database DatabaseName principal roles
// For a table:
.show table TableName principal roles
// For an external table:
.show external table ExternalTableName principal roles
// For a function:
.show function FunctionName principal roles
// For a materialized view:
.show materialized-view MaterializedViewName principal roles
Show the roles of all principals on a resource
To see the roles assigned to all principals for a particular resource, run the following command within the relevant database or the database that contains the resource:
// For a database:
.show database DatabaseName principals
// For a table:
.show table TableName principals
// For an external table:
.show external table ExternalTableName principals
// For a function:
.show function FunctionName principals
// For a materialized view:
.show materialized-view MaterializedViewName principals
Modify the role assignments
For details on how to modify your role assignments at the database and table levels, see Manage database security roles and Manage table security roles.
Related content
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.