Share via

Microsoft.Kusto clusters/databases/principalAssignments

  • Article

Bicep resource definition

The clusters/databases/principalAssignments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Kusto/clusters/databases/principalAssignments resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Kusto/clusters/databases/principalAssignments@2024-04-13' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    principalId: 'string'
    principalType: 'string'
    role: 'string'
    tenantId: 'string'
  }
}

Property values

DatabasePrincipalProperties

Name Description Value
principalId The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. string (required)
principalType Principal type. 'App'
'Group'
'User' (required)
role Database principal role. 'Admin'
'Ingestor'
'Monitor'
'UnrestrictedViewer'
'User'
'Viewer' (required)
tenantId The tenant id of the principal string

Microsoft.Kusto/clusters/databases/principalAssignments

Name Description Value
name The resource name string

Constraints:
Pattern = ^.*$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: clusters/databases
properties The database principal. DatabasePrincipalProperties

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Azure Digital Twins with Time Data History Connection This template creates an Azure Digital Twins instance configured with a time series data history connection. In order to create a connection, other resources must be created such as an Event Hubs namespace, an event hub, Azure Data Explorer cluster, and a database. Data is sent to an event hub which eventually forwards the data to the Azure Data Explorer cluster. Data is stored in a database table in the cluster
Create a database watcher This sample creates a database watcher for Azure SQL and configures its data store, SQL targets, and managed private endpoints

ARM template resource definition

The clusters/databases/principalAssignments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Kusto/clusters/databases/principalAssignments resource, add the following JSON to your template.

{
  "type": "Microsoft.Kusto/clusters/databases/principalAssignments",
  "apiVersion": "2024-04-13",
  "name": "string",
  "properties": {
    "principalId": "string",
    "principalType": "string",
    "role": "string",
    "tenantId": "string"
  }
}

Property values

DatabasePrincipalProperties

Name Description Value
principalId The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. string (required)
principalType Principal type. 'App'
'Group'
'User' (required)
role Database principal role. 'Admin'
'Ingestor'
'Monitor'
'UnrestrictedViewer'
'User'
'Viewer' (required)
tenantId The tenant id of the principal string

Microsoft.Kusto/clusters/databases/principalAssignments

Name Description Value
apiVersion The api version '2024-04-13'
name The resource name string

Constraints:
Pattern = ^.*$ (required)
properties The database principal. DatabasePrincipalProperties
type The resource type 'Microsoft.Kusto/clusters/databases/principalAssignments'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Digital Twins with Time Data History Connection

Deploy to Azure		 This template creates an Azure Digital Twins instance configured with a time series data history connection. In order to create a connection, other resources must be created such as an Event Hubs namespace, an event hub, Azure Data Explorer cluster, and a database. Data is sent to an event hub which eventually forwards the data to the Azure Data Explorer cluster. Data is stored in a database table in the cluster
Create a database watcher

Deploy to Azure		 This sample creates a database watcher for Azure SQL and configures its data store, SQL targets, and managed private endpoints

Terraform (AzAPI provider) resource definition

The clusters/databases/principalAssignments resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Kusto/clusters/databases/principalAssignments resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Kusto/clusters/databases/principalAssignments@2024-04-13"
  name = "string"
  body = jsonencode({
    properties = {
      principalId = "string"
      principalType = "string"
      role = "string"
      tenantId = "string"
    }
  })
}

Property values

DatabasePrincipalProperties

Name Description Value
principalId The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. string (required)
principalType Principal type. 'App'
'Group'
'User' (required)
role Database principal role. 'Admin'
'Ingestor'
'Monitor'
'UnrestrictedViewer'
'User'
'Viewer' (required)
tenantId The tenant id of the principal string

Microsoft.Kusto/clusters/databases/principalAssignments

Name Description Value
name The resource name string

Constraints:
Pattern = ^.*$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: clusters/databases
properties The database principal. DatabasePrincipalProperties
type The resource type "Microsoft.Kusto/clusters/databases/principalAssignments@2024-04-13"