We recommend using Azure Native.
Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
azure.kusto.getDatabase
Explore with Pulumi AI
Use this data source to access information about an existing Kusto Database
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.kusto.getDatabase({
    name: "my-kusto-database",
    resourceGroupName: "test_resource_group",
    clusterName: "test_cluster",
});
import pulumi
import pulumi_azure as azure
example = azure.kusto.get_database(name="my-kusto-database",
    resource_group_name="test_resource_group",
    cluster_name="test_cluster")
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/kusto"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kusto.LookupDatabase(ctx, &kusto.LookupDatabaseArgs{
			Name:              "my-kusto-database",
			ResourceGroupName: "test_resource_group",
			ClusterName:       "test_cluster",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() => 
{
    var example = Azure.Kusto.GetDatabase.Invoke(new()
    {
        Name = "my-kusto-database",
        ResourceGroupName = "test_resource_group",
        ClusterName = "test_cluster",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.kusto.KustoFunctions;
import com.pulumi.azure.kusto.inputs.GetDatabaseArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var example = KustoFunctions.getDatabase(GetDatabaseArgs.builder()
            .name("my-kusto-database")
            .resourceGroupName("test_resource_group")
            .clusterName("test_cluster")
            .build());
    }
}
variables:
  example:
    fn::invoke:
      function: azure:kusto:getDatabase
      arguments:
        name: my-kusto-database
        resourceGroupName: test_resource_group
        clusterName: test_cluster
Using getDatabase
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDatabase(args: GetDatabaseArgs, opts?: InvokeOptions): Promise<GetDatabaseResult>
function getDatabaseOutput(args: GetDatabaseOutputArgs, opts?: InvokeOptions): Output<GetDatabaseResult>def get_database(cluster_name: Optional[str] = None,
                 name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDatabaseResult
def get_database_output(cluster_name: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseResult]func LookupDatabase(ctx *Context, args *LookupDatabaseArgs, opts ...InvokeOption) (*LookupDatabaseResult, error)
func LookupDatabaseOutput(ctx *Context, args *LookupDatabaseOutputArgs, opts ...InvokeOption) LookupDatabaseResultOutput> Note: This function is named LookupDatabase in the Go SDK.
public static class GetDatabase 
{
    public static Task<GetDatabaseResult> InvokeAsync(GetDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseResult> Invoke(GetDatabaseInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)
public static Output<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)
fn::invoke:
  function: azure:kusto/getDatabase:getDatabase
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ClusterName string
- The name of the Kusto Cluster this database is added to.
- Name string
- The name of the Kusto Database.
- ResourceGroup stringName 
- The Resource Group where the Kusto Database exists.
- ClusterName string
- The name of the Kusto Cluster this database is added to.
- Name string
- The name of the Kusto Database.
- ResourceGroup stringName 
- The Resource Group where the Kusto Database exists.
- clusterName String
- The name of the Kusto Cluster this database is added to.
- name String
- The name of the Kusto Database.
- resourceGroup StringName 
- The Resource Group where the Kusto Database exists.
- clusterName string
- The name of the Kusto Cluster this database is added to.
- name string
- The name of the Kusto Database.
- resourceGroup stringName 
- The Resource Group where the Kusto Database exists.
- cluster_name str
- The name of the Kusto Cluster this database is added to.
- name str
- The name of the Kusto Database.
- resource_group_ strname 
- The Resource Group where the Kusto Database exists.
- clusterName String
- The name of the Kusto Cluster this database is added to.
- name String
- The name of the Kusto Database.
- resourceGroup StringName 
- The Resource Group where the Kusto Database exists.
getDatabase Result
The following output properties are available:
- ClusterName string
- HotCache stringPeriod 
- The time the data that should be kept in cache for fast queries as ISO 8601 timespan.
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- The Azure Region in which the managed Kusto Database exists.
- Name string
- ResourceGroup stringName 
- Size double
- The size of the database in bytes.
- SoftDelete stringPeriod 
- The time the data should be kept before it stops being accessible to queries as ISO 8601 timespan.
- ClusterName string
- HotCache stringPeriod 
- The time the data that should be kept in cache for fast queries as ISO 8601 timespan.
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- The Azure Region in which the managed Kusto Database exists.
- Name string
- ResourceGroup stringName 
- Size float64
- The size of the database in bytes.
- SoftDelete stringPeriod 
- The time the data should be kept before it stops being accessible to queries as ISO 8601 timespan.
- clusterName String
- hotCache StringPeriod 
- The time the data that should be kept in cache for fast queries as ISO 8601 timespan.
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- The Azure Region in which the managed Kusto Database exists.
- name String
- resourceGroup StringName 
- size Double
- The size of the database in bytes.
- softDelete StringPeriod 
- The time the data should be kept before it stops being accessible to queries as ISO 8601 timespan.
- clusterName string
- hotCache stringPeriod 
- The time the data that should be kept in cache for fast queries as ISO 8601 timespan.
- id string
- The provider-assigned unique ID for this managed resource.
- location string
- The Azure Region in which the managed Kusto Database exists.
- name string
- resourceGroup stringName 
- size number
- The size of the database in bytes.
- softDelete stringPeriod 
- The time the data should be kept before it stops being accessible to queries as ISO 8601 timespan.
- cluster_name str
- hot_cache_ strperiod 
- The time the data that should be kept in cache for fast queries as ISO 8601 timespan.
- id str
- The provider-assigned unique ID for this managed resource.
- location str
- The Azure Region in which the managed Kusto Database exists.
- name str
- resource_group_ strname 
- size float
- The size of the database in bytes.
- soft_delete_ strperiod 
- The time the data should be kept before it stops being accessible to queries as ISO 8601 timespan.
- clusterName String
- hotCache StringPeriod 
- The time the data that should be kept in cache for fast queries as ISO 8601 timespan.
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- The Azure Region in which the managed Kusto Database exists.
- name String
- resourceGroup StringName 
- size Number
- The size of the database in bytes.
- softDelete StringPeriod 
- The time the data should be kept before it stops being accessible to queries as ISO 8601 timespan.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the azurermTerraform Provider.