Microsoft.Kusto clusters/databases 2018-09-07-preview
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@2018-09-07-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
hotCachePeriodInDays: int
softDeletePeriodInDays: int
}
}
Property values
clusters/databases
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| location | The geo-location where the resource lives | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| 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 |
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) |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create a database watcher |
This sample creates a database watcher for Azure SQL and configures its data store, SQL targets, and managed private endpoints |
| 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. |
| 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:
- 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.
{
"type": "Microsoft.Kusto/clusters/databases",
"apiVersion": "2018-09-07-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"hotCachePeriodInDays": "int",
"softDeletePeriodInDays": "int"
}
}
Property values
clusters/databases
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Kusto/clusters/databases' |
| apiVersion | The resource api version | '2018-09-07-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| location | The geo-location where the resource lives | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| properties | Class representing the Kusto database properties. | DatabaseProperties |
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) |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create a database watcher |
This sample creates a database watcher for Azure SQL and configures its data store, SQL targets, and managed private endpoints |
| 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. |
| 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" {
type = "Microsoft.Kusto/clusters/databases@2018-09-07-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
hotCachePeriodInDays = int
softDeletePeriodInDays = int
}
})
}
Property values
clusters/databases
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Kusto/clusters/databases@2018-09-07-preview" |
| name | The resource name | string (required) |
| location | The geo-location where the resource lives | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: clusters |
| tags | Resource tags. | Dictionary of tag names and values. |
| properties | Class representing the Kusto database properties. | DatabaseProperties |
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) |