Skip to content

azurermKustoDatabase

Manages a Kusto (also known as Azure Data Explorer) Database

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
  this,
  "example",
  {
    location: "West Europe",
    name: "my-kusto-rg",
  }
);
const azurermKustoClusterCluster = new azurerm.kustoCluster.KustoCluster(
  this,
  "cluster",
  {
    location: azurermResourceGroupExample.location,
    name: "kustocluster",
    resource_group_name: azurermResourceGroupExample.name,
    sku: [
      {
        capacity: 2,
        name: "Standard_D13_v2",
      },
    ],
  }
);
new azurerm.kustoDatabase.KustoDatabase(this, "database", {
  cluster_name: azurermKustoClusterCluster.name,
  hot_cache_period: "P7D",
  location: azurermResourceGroupExample.location,
  name: "my-kusto-database",
  resource_group_name: azurermResourceGroupExample.name,
  soft_delete_period: "P31D",
});

Argument Reference

The following arguments are supported:

  • name - (Required) The name of the Kusto Database to create. Changing this forces a new resource to be created.

  • location - (Required) The location where the Kusto Database should be created. Changing this forces a new resource to be created.

  • resourceGroupName - (Required) Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.

  • clusterName - (Required) Specifies the name of the Kusto Cluster this database will be added to. Changing this forces a new resource to be created.

  • hotCachePeriod - (Optional) The time the data that should be kept in cache for fast queries as ISO 8601 timespan. Default is unlimited. For more information see: ISO 8601 Timespan

  • softDeletePeriod - (Optional) The time the data should be kept before it stops being accessible to queries as ISO 8601 timespan. Default is unlimited. For more information see: ISO 8601 Timespan

Attributes Reference

The following attributes are exported:

  • id - The Kusto Cluster ID.

  • size - The size of the database in bytes.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 60 minutes) Used when creating the Kusto Database.
  • update - (Defaults to 60 minutes) Used when updating the Kusto Database.
  • read - (Defaults to 5 minutes) Used when retrieving the Kusto Database.
  • delete - (Defaults to 60 minutes) Used when deleting the Kusto Database.

Import

Kusto Clusters can be imported using the resourceId, e.g.

terraform import azurerm_kusto_database.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Kusto/clusters/cluster1/databases/database1