Microsoft.Kusto clusters/databases 2023-05-02
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-05-02' = {
name: 'string'
location: 'string'
kind: 'string'
parent: resourceSymbolicName
// For remaining properties, see clusters/databases objects
}
clusters/databases objects
Set the kind property to specify the type of object.
For ReadOnlyFollowing, use:
kind: 'ReadOnlyFollowing'
For ReadWrite, use:
kind: 'ReadWrite'
properties: {
hotCachePeriod: 'string'
keyVaultProperties: {
keyName: 'string'
keyVaultUri: 'string'
keyVersion: 'string'
userIdentity: 'string'
}
softDeletePeriod: 'string'
}
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 | Resource location. | string |
| kind | Set the object type | ReadOnlyFollowing ReadWrite (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 |
ReadOnlyFollowingDatabase
| Name | Description | Value |
|---|---|---|
| kind | Kind of the database | 'ReadOnlyFollowing' (required) |
ReadWriteDatabase
| Name | Description | Value |
|---|---|---|
| kind | Kind of the database | 'ReadWrite' (required) |
| properties | The database properties. | ReadWriteDatabaseProperties |
ReadWriteDatabaseProperties
| Name | Description | Value |
|---|---|---|
| hotCachePeriod | The time the data should be kept in cache for fast queries in TimeSpan. | string |
| keyVaultProperties | KeyVault properties for the database encryption. | KeyVaultProperties |
| softDeletePeriod | The time the data should be kept before it stops being accessible to queries in TimeSpan. | string |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The name of the key vault key. | string |
| keyVaultUri | The Uri of the key vault. | string |
| keyVersion | The version of the key vault key. | string |
| userIdentity | The user assigned identity (ARM resource id) that has access to the key. | string |
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": "2023-05-02",
"name": "string",
"location": "string",
"kind": "string",
// For remaining properties, see clusters/databases objects
}
clusters/databases objects
Set the kind property to specify the type of object.
For ReadOnlyFollowing, use:
"kind": "ReadOnlyFollowing"
For ReadWrite, use:
"kind": "ReadWrite",
"properties": {
"hotCachePeriod": "string",
"keyVaultProperties": {
"keyName": "string",
"keyVaultUri": "string",
"keyVersion": "string",
"userIdentity": "string"
},
"softDeletePeriod": "string"
}
Property values
clusters/databases
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Kusto/clusters/databases' |
| apiVersion | The resource api version | '2023-05-02' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| location | Resource location. | string |
| kind | Set the object type | ReadOnlyFollowing ReadWrite (required) |
ReadOnlyFollowingDatabase
| Name | Description | Value |
|---|---|---|
| kind | Kind of the database | 'ReadOnlyFollowing' (required) |
ReadWriteDatabase
| Name | Description | Value |
|---|---|---|
| kind | Kind of the database | 'ReadWrite' (required) |
| properties | The database properties. | ReadWriteDatabaseProperties |
ReadWriteDatabaseProperties
| Name | Description | Value |
|---|---|---|
| hotCachePeriod | The time the data should be kept in cache for fast queries in TimeSpan. | string |
| keyVaultProperties | KeyVault properties for the database encryption. | KeyVaultProperties |
| softDeletePeriod | The time the data should be kept before it stops being accessible to queries in TimeSpan. | string |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The name of the key vault key. | string |
| keyVaultUri | The Uri of the key vault. | string |
| keyVersion | The version of the key vault key. | string |
| userIdentity | The user assigned identity (ARM resource id) that has access to the key. | string |
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@2023-05-02"
name = "string"
location = "string"
parent_id = "string"
// For remaining properties, see clusters/databases objects
body = jsonencode({
kind = "string"
})
}
clusters/databases objects
Set the kind property to specify the type of object.
For ReadOnlyFollowing, use:
kind = "ReadOnlyFollowing"
For ReadWrite, use:
kind = "ReadWrite"
properties = {
hotCachePeriod = "string"
keyVaultProperties = {
keyName = "string"
keyVaultUri = "string"
keyVersion = "string"
userIdentity = "string"
}
softDeletePeriod = "string"
}
Property values
clusters/databases
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Kusto/clusters/databases@2023-05-02" |
| name | The resource name | string (required) |
| location | Resource location. | string |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: clusters |
| kind | Set the object type | ReadOnlyFollowing ReadWrite (required) |
ReadOnlyFollowingDatabase
| Name | Description | Value |
|---|---|---|
| kind | Kind of the database | "ReadOnlyFollowing" (required) |
ReadWriteDatabase
| Name | Description | Value |
|---|---|---|
| kind | Kind of the database | "ReadWrite" (required) |
| properties | The database properties. | ReadWriteDatabaseProperties |
ReadWriteDatabaseProperties
| Name | Description | Value |
|---|---|---|
| hotCachePeriod | The time the data should be kept in cache for fast queries in TimeSpan. | string |
| keyVaultProperties | KeyVault properties for the database encryption. | KeyVaultProperties |
| softDeletePeriod | The time the data should be kept before it stops being accessible to queries in TimeSpan. | string |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The name of the key vault key. | string |
| keyVaultUri | The Uri of the key vault. | string |
| keyVersion | The version of the key vault key. | string |
| userIdentity | The user assigned identity (ARM resource id) that has access to the key. | string |