Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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@2022-02-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
principalId: 'string'
principalType: 'string'
role: 'string'
tenantId: 'string'
}
}
Property Values
Microsoft.Kusto/clusters/databases/principalAssignments
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (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 |
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 |
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying 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": "2022-02-01",
"name": "string",
"properties": {
"principalId": "string",
"principalType": "string",
"role": "string",
"tenantId": "string"
}
}
Property Values
Microsoft.Kusto/clusters/databases/principalAssignments
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-02-01' |
| name | The resource name | string (required) |
| properties | The database principal. | DatabasePrincipalProperties |
| type | The resource type | 'Microsoft.Kusto/clusters/databases/principalAssignments' |
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 |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | 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 |
Terraform (AzAPI provider) 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 Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Kusto/clusters/databases/principalAssignments@2022-02-01"
name = "string"
parent_id = "string"
body = {
properties = {
principalId = "string"
principalType = "string"
role = "string"
tenantId = "string"
}
}
}
Property Values
Microsoft.Kusto/clusters/databases/principalAssignments
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (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@2022-02-01" |
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 |
Usage Examples
Terraform Samples
A basic example of deploying Kusto / Data Explorer Database Principal Assignment.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
azurerm = {
source = "hashicorp/azurerm"
}
}
}
provider "azurerm" {
features {
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
data "azurerm_client_config" "current" {
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "cluster" {
type = "Microsoft.Kusto/clusters@2023-05-02"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
enableAutoStop = true
enableDiskEncryption = false
enableDoubleEncryption = false
enablePurge = false
enableStreamingIngest = false
engineType = "V2"
publicIPType = "IPv4"
publicNetworkAccess = "Enabled"
restrictOutboundNetworkAccess = "Disabled"
trustedExternalTenants = [
]
}
sku = {
capacity = 1
name = "Dev(No SLA)_Standard_D11_v2"
tier = "Basic"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "database" {
type = "Microsoft.Kusto/clusters/databases@2023-05-02"
parent_id = azapi_resource.cluster.id
name = var.resource_name
location = var.location
body = {
kind = "ReadWrite"
properties = {
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "principalAssignment" {
type = "Microsoft.Kusto/clusters/databases/principalAssignments@2023-05-02"
parent_id = azapi_resource.database.id
name = var.resource_name
body = {
properties = {
principalId = data.azurerm_client_config.current.client_id
principalType = "App"
role = "Viewer"
tenantId = data.azurerm_client_config.current.tenant_id
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}