Share via

Microsoft.Kusto clusters/databases 2019-01-21

  • 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@2019-01-21' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    hotCachePeriod: 'string'
    softDeletePeriod: 'string'
  }
}

Property values

DatabaseProperties

Name Description Value
hotCachePeriod The time the data that should be kept in cache for fast queries in TimeSpan. string
softDeletePeriod The time the data should be kept before it stops being accessible to queries in TimeSpan. string

Microsoft.Kusto/clusters/databases

Name Description Value
location Resource location. string
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 The database properties. DatabaseProperties

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
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.

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": "2019-01-21",
  "name": "string",
  "location": "string",
  "properties": {
    "hotCachePeriod": "string",
    "softDeletePeriod": "string"
  }
}

Property values

DatabaseProperties

Name Description Value
hotCachePeriod The time the data that should be kept in cache for fast queries in TimeSpan. string
softDeletePeriod The time the data should be kept before it stops being accessible to queries in TimeSpan. string

Microsoft.Kusto/clusters/databases

Name Description Value
apiVersion The api version '2019-01-21'
location Resource location. string
name The resource name string (required)
properties The database properties. DatabaseProperties
type The resource type 'Microsoft.Kusto/clusters/databases'

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 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.

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@2019-01-21"
  name = "string"
  location = "string"
  body = jsonencode({
    properties = {
      hotCachePeriod = "string"
      softDeletePeriod = "string"
    }
  })
}

Property values

DatabaseProperties

Name Description Value
hotCachePeriod The time the data that should be kept in cache for fast queries in TimeSpan. string
softDeletePeriod The time the data should be kept before it stops being accessible to queries in TimeSpan. string

Microsoft.Kusto/clusters/databases

Name Description Value
location Resource location. string
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 The database properties. DatabaseProperties
type The resource type "Microsoft.Kusto/clusters/databases@2019-01-21"