Share via

Microsoft.Kusto clusters/databases 2018-09-07-preview

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.Kusto/clusters/databases@2018-09-07-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    hotCachePeriodInDays: int
    softDeletePeriodInDays: int
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

DatabaseProperties

Name Description Value
hotCachePeriodInDays The number of days of data that should be kept in cache for fast queries. int
softDeletePeriodInDays The number of days data should be kept before it stops being accessible to queries. int (required)

Microsoft.Kusto/clusters/databases

Name Description Value
location The geo-location where the resource lives string (required)
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
properties Class representing the Kusto database properties. DatabaseProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

TrackedResourceTags

Name Description Value

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
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.
FinOps hub This template creates a new FinOps hub instance, including Data Explorer, Data Lake storage, and Data Factory.

ARM template resource definition

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

{
  "type": "Microsoft.Kusto/clusters/databases",
  "apiVersion": "2018-09-07-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "hotCachePeriodInDays": "int",
    "softDeletePeriodInDays": "int"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

DatabaseProperties

Name Description Value
hotCachePeriodInDays The number of days of data that should be kept in cache for fast queries. int
softDeletePeriodInDays The number of days data should be kept before it stops being accessible to queries. int (required)

Microsoft.Kusto/clusters/databases

Name Description Value
apiVersion The api version '2018-09-07-preview'
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Class representing the Kusto database properties. DatabaseProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Kusto/clusters/databases'

TrackedResourceTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure 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 cluster a database

Deploy to Azure		 This template allows you to create a cluster and a database.
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
Deploy Azure Data Explorer DB with Cosmos DB connection

Deploy to Azure		 Deploy Azure Data Explorer DB with Cosmos DB connection.
Deploy Azure Data Explorer db with Event Grid connection

Deploy to Azure		 Deploy Azure Data Explorer db with Event Grid connection.
Deploy Azure Data Explorer db with Event Hub connection

Deploy to Azure		 Deploy Azure Data Explorer db with Event Hub connection.
FinOps hub

Deploy to Azure		 This template creates a new FinOps hub instance, including Data Explorer, Data Lake storage, and Data Factory.

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" {
  type = "Microsoft.Kusto/clusters/databases@2018-09-07-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      hotCachePeriodInDays = int
      softDeletePeriodInDays = int
    }
  })
}

Property Values

DatabaseProperties

Name Description Value
hotCachePeriodInDays The number of days of data that should be kept in cache for fast queries. int
softDeletePeriodInDays The number of days data should be kept before it stops being accessible to queries. int (required)

Microsoft.Kusto/clusters/databases

Name Description Value
location The geo-location where the resource lives string (required)
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
properties Class representing the Kusto database properties. DatabaseProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Kusto/clusters/databases@2018-09-07-preview"

TrackedResourceTags

Name Description Value