Skip to main content

databases_principals

Creates, updates, deletes, gets or lists a databases_principals resource.

Overview

Namedatabases_principals
TypeResource
Idazure.data_explorer.databases_principals

Fields

The following fields are returned by SELECT queries:

Successfully retrieved the list of database principals.

NameDatatypeDescription
namestringDatabase principal name.
appIdstringApplication id - relevant only for application principal type.
emailstringDatabase principal email if exists.
fqnstringDatabase principal fully qualified name.
rolestringDatabase principal role.
tenantNamestringThe tenant name of the principal
typestringDatabase principal type.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectresourceGroupName, clusterName, databaseName, subscriptionIdReturns a list of database principals of the given Kusto cluster and database.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
clusterNamestringThe name of the Kusto cluster.
databaseNamestringThe name of the database in the Kusto cluster.
resourceGroupNamestringThe name of the resource group. The name is case insensitive.
subscriptionIdstringThe ID of the target subscription.

SELECT examples

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

SELECT
name,
appId,
email,
fqn,
role,
tenantName,
type
FROM azure.data_explorer.databases_principals
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;