Microsoft.Kusto clusters/databases 2023-08-15

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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

Resource format

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

resource symbolicname 'Microsoft.Kusto/clusters/databases@2023-08-15' = {
  location: 'string'
  name: 'string'
  kind: 'string'
  // For remaining properties, see Microsoft.Kusto/clusters/databases objects
}

Microsoft.Kusto/clusters/databases objects

Set the kind property to specify the type of object.

For ReadOnlyFollowing, use:

{
  kind: 'ReadOnlyFollowing'
  properties: {
    hotCachePeriod: 'string'
  }
}

For ReadWrite, use:

{
  kind: 'ReadWrite'
  properties: {
    hotCachePeriod: 'string'
    keyVaultProperties: {
      keyName: 'string'
      keyVaultUri: 'string'
      keyVersion: 'string'
      userIdentity: 'string'
    }
    softDeletePeriod: 'string'
  }
}

Property values

KeyVaultProperties

Microsoft.Kusto/clusters/databases

ReadOnlyFollowingDatabase

ReadOnlyFollowingDatabaseProperties

ReadWriteDatabase

ReadWriteDatabaseProperties

Quickstart samples

The following quickstart samples deploy this resource type.

ARM template resource definition

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

• Resource groups - See resource group deployment commands

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

Resource format

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

{
  "location": "string",
  "name": "string",
  "kind": "string"
  // For remaining properties, see Microsoft.Kusto/clusters/databases objects
}

Microsoft.Kusto/clusters/databases objects

Set the kind property to specify the type of object.

For ReadOnlyFollowing, use:

{
  "kind": "ReadOnlyFollowing",
  "properties": {
    "hotCachePeriod": "string"
  }
}

For ReadWrite, use:

{
  "kind": "ReadWrite",
  "properties": {
    "hotCachePeriod": "string",
    "keyVaultProperties": {
      "keyName": "string",
      "keyVaultUri": "string",
      "keyVersion": "string",
      "userIdentity": "string"
    },
    "softDeletePeriod": "string"
  }
}

Property values

KeyVaultProperties

Microsoft.Kusto/clusters/databases

ReadOnlyFollowingDatabase

ReadOnlyFollowingDatabaseProperties

ReadWriteDatabase

ReadWriteDatabaseProperties

Quickstart templates

The following 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 cluster a database	This template allows you to create a cluster and a database.
Create a database watcher	This sample creates a database watcher for Azure SQL and configures its data store, SQL targets, and managed private endpoints
Deploy Azure Data Explorer DB with Cosmos DB connection	Deploy Azure Data Explorer DB with Cosmos DB connection.
Deploy Azure Data Explorer db with Event Grid connection	Deploy Azure Data Explorer db with Event Grid connection.
Deploy Azure Data Explorer db with Event Hub connection	Deploy Azure Data Explorer db with Event Hub connection.

Terraform (AzAPI provider) resource definition

The clusters/databases 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 resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  location = "string"
  name = "string"
  kind = "string"
  // For remaining properties, see Microsoft.Kusto/clusters/databases objects
}

Microsoft.Kusto/clusters/databases objects

Set the kind property to specify the type of object.

For ReadOnlyFollowing, use:

{
  kind = "ReadOnlyFollowing"
  properties = {
    hotCachePeriod = "string"
  }
}

For ReadWrite, use:

{
  kind = "ReadWrite"
  properties = {
    hotCachePeriod = "string"
    keyVaultProperties = {
      keyName = "string"
      keyVaultUri = "string"
      keyVersion = "string"
      userIdentity = "string"
    }
    softDeletePeriod = "string"
  }
}

Property values

KeyVaultProperties

Microsoft.Kusto/clusters/databases

ReadOnlyFollowingDatabase

ReadOnlyFollowingDatabaseProperties

ReadWriteDatabase

ReadWriteDatabaseProperties