Databases - List Principals

Service:

Azure Kusto

API Version:

2021-01-01

Returns a list of database principals of the given Kusto cluster and database.

HTTP

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/listPrincipals?api-version=2021-01-01

URI Parameters

Name	In	Required	Type	Description
clusterName	path	True	string	The name of the Kusto cluster.
databaseName	path	True	string	The name of the database in the Kusto cluster.
resourceGroupName	path	True	string	The name of the resource group containing the Kusto cluster.
subscriptionId	path	True	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API Version.

Responses

Name	Type	Description
200 OK	DatabasePrincipalListResult	Successfully retrieved the list of database principals.
Other Status Codes	CloudError	Error response describing why the operation failed.

Examples

KustoDatabaseListPrincipals

Sample request

HTTP

HTTP

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoclusterrptest4/databases/KustoDatabase8/listPrincipals?api-version=2021-01-01

Sample response

Status code:

200

JSON

{
  "value": [
    {
      "name": "Some User",
      "role": "Admin",
      "type": "User",
      "fqn": "aaduser=some_guid",
      "email": "user@microsoft.com",
      "appId": ""
    },
    {
      "name": "Kusto",
      "role": "Viewer",
      "type": "Group",
      "fqn": "aadgroup=some_guid",
      "email": "kusto@microsoft.com",
      "appId": ""
    },
    {
      "name": "SomeApp",
      "role": "Admin",
      "type": "App",
      "fqn": "aadapp=some_guid_app_id",
      "email": "",
      "appId": "some_guid_app_id"
    }
  ]
}

Definitions

Name	Description
CloudError	An error response from Kusto.
CloudErrorBody	An error response from Kusto.
DatabasePrincipal	A class representing database principal entity.
DatabasePrincipalListResult	The list Kusto database principals operation response.
DatabasePrincipalRole	Database principal role.
DatabasePrincipalType	Database principal type.

CloudError

Object

An error response from Kusto.

Name	Type	Description
error	CloudErrorBody	An error response from Kusto.

CloudErrorBody

Object

An error response from Kusto.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for displaying in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

DatabasePrincipal

Object

A class representing database principal entity.

Name	Type	Description
appId	string	Application id - relevant only for application principal type.
email	string	Database principal email if exists.
fqn	string	Database principal fully qualified name.
name	string	Database principal name.
role	DatabasePrincipalRole	Database principal role.
tenantName	string	The tenant name of the principal
type	DatabasePrincipalType	Database principal type.

DatabasePrincipalListResult

Object

The list Kusto database principals operation response.

Name	Type	Description
value	DatabasePrincipal[]	The list of Kusto database principals.

DatabasePrincipalRole

Enumeration

Database principal role.

Value	Description
Admin
Ingestor
Monitor
UnrestrictedViewer
User
Viewer

DatabasePrincipalType

Enumeration

Database principal type.

Value	Description
App
Group
User