Share via

Databases - List Principals

Service:
Azure Kusto
API Version:
2024-04-13

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

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

URI Parameters

Name In Required Type Description
clusterName
 path True

string

pattern: ^.*$

The name of the Kusto cluster.
databaseName
 path True

string

pattern: ^.*$

The name of the database in the Kusto cluster.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
subscriptionId
 path True

string

minLength: 1

The ID of the target subscription.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

DatabasePrincipalListResult

Successfully retrieved the list of database principals.
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Examples

KustoDatabaseListPrincipals

Sample request

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster/databases/KustoDatabase8/listPrincipals?api-version=2024-04-13

Sample response

Status code:
200 
{
  "value": [
    {
      "name": "Some User",
      "role": "Admin",
      "type": "User",
      "fqn": "aaduser=some_guid",
      "email": "[email protected]",
      "appId": ""
    },
    {
      "name": "Kusto",
      "role": "Viewer",
      "type": "Group",
      "fqn": "aadgroup=some_guid",
      "email": "[email protected]",
      "appId": ""
    },
    {
      "name": "SomeApp",
      "role": "Admin",
      "type": "App",
      "fqn": "aadapp=some_guid_app_id",
      "email": "",
      "appId": "some_guid_app_id"
    }
  ]
}

Definitions

Name Description
DatabasePrincipal

A class representing database principal entity.
DatabasePrincipalListResult

The list Kusto database principals operation response.
DatabasePrincipalRole

Database principal role.
DatabasePrincipalType

Database principal type.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response

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
User
UnrestrictedViewer
Viewer

DatabasePrincipalType

Enumeration

Database principal type.

Value Description
App
Group
User

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.