Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. kusto
  5. listDatabasePrincipals
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.kusto.listDatabasePrincipals

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Returns a list of database principals of the given Kusto cluster and database. Azure REST API version: 2022-12-29.

Other available API versions: 2022-07-07, 2023-05-02, 2023-08-15, 2024-04-13.

Using listDatabasePrincipals

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function listDatabasePrincipals(args: ListDatabasePrincipalsArgs, opts?: InvokeOptions): Promise<ListDatabasePrincipalsResult>
function listDatabasePrincipalsOutput(args: ListDatabasePrincipalsOutputArgs, opts?: InvokeOptions): Output<ListDatabasePrincipalsResult>
Copy
def list_database_principals(cluster_name: Optional[str] = None,
                             database_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> ListDatabasePrincipalsResult
def list_database_principals_output(cluster_name: Optional[pulumi.Input[str]] = None,
                             database_name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[ListDatabasePrincipalsResult]
Copy
func ListDatabasePrincipals(ctx *Context, args *ListDatabasePrincipalsArgs, opts ...InvokeOption) (*ListDatabasePrincipalsResult, error)
func ListDatabasePrincipalsOutput(ctx *Context, args *ListDatabasePrincipalsOutputArgs, opts ...InvokeOption) ListDatabasePrincipalsResultOutput
Copy

> Note: This function is named ListDatabasePrincipals in the Go SDK.

public static class ListDatabasePrincipals 
{
    public static Task<ListDatabasePrincipalsResult> InvokeAsync(ListDatabasePrincipalsArgs args, InvokeOptions? opts = null)
    public static Output<ListDatabasePrincipalsResult> Invoke(ListDatabasePrincipalsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListDatabasePrincipalsResult> listDatabasePrincipals(ListDatabasePrincipalsArgs args, InvokeOptions options)
public static Output<ListDatabasePrincipalsResult> listDatabasePrincipals(ListDatabasePrincipalsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:kusto:listDatabasePrincipals
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group containing the Kusto cluster.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group containing the Kusto cluster.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto cluster.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database in the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group containing the Kusto cluster.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group containing the Kusto cluster.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Kusto cluster.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database in the Kusto cluster.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group containing the Kusto cluster.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto cluster.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database in the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group containing the Kusto cluster.

listDatabasePrincipals Result

The following output properties are available:

Value []DatabasePrincipalResponse
The list of Kusto database principals.
value List<DatabasePrincipalResponse>
The list of Kusto database principals.
value DatabasePrincipalResponse[]
The list of Kusto database principals.
value Sequence[DatabasePrincipalResponse]
The list of Kusto database principals.
value List<Property Map>
The list of Kusto database principals.

Supporting Types

DatabasePrincipalResponse

Name This property is required. string
Database principal name.
Role This property is required. string
Database principal role.
TenantName This property is required. string
The tenant name of the principal
Type This property is required. string
Database principal type.
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 This property is required. string
Database principal name.
Role This property is required. string
Database principal role.
TenantName This property is required. string
The tenant name of the principal
Type This property is required. string
Database principal type.
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 This property is required. String
Database principal name.
role This property is required. String
Database principal role.
tenantName This property is required. String
The tenant name of the principal
type This property is required. String
Database principal type.
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 This property is required. string
Database principal name.
role This property is required. string
Database principal role.
tenantName This property is required. string
The tenant name of the principal
type This property is required. string
Database principal type.
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 This property is required. str
Database principal name.
role This property is required. str
Database principal role.
tenant_name This property is required. str
The tenant name of the principal
type This property is required. str
Database principal type.
app_id str
Application id - relevant only for application principal type.
email str
Database principal email if exists.
fqn str
Database principal fully qualified name.
name This property is required. String
Database principal name.
role This property is required. String
Database principal role.
tenantName This property is required. String
The tenant name of the principal
type This property is required. String
Database principal type.
appId String
Application id - relevant only for application principal type.
email String
Database principal email if exists.
fqn String
Database principal fully qualified name.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native