1. Packages
  2. Azure Classic
  3. API Docs
  4. kusto
  5. getDatabase

We recommend using Azure Native.

Azure Classic v5.43.0 published on Saturday, May 6, 2023 by Pulumi

azure.kusto.getDatabase

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.43.0 published on Saturday, May 6, 2023 by Pulumi

    Use this data source to access information about an existing Kusto Database

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Azure.Kusto.GetDatabase.Invoke(new()
        {
            ClusterName = "test_cluster",
            Name = "my-kusto-database",
            ResourceGroupName = "test_resource_group",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/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{
    			ClusterName:       "test_cluster",
    			Name:              "my-kusto-database",
    			ResourceGroupName: "test_resource_group",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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()
                .clusterName("test_cluster")
                .name("my-kusto-database")
                .resourceGroupName("test_resource_group")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.kusto.get_database(cluster_name="test_cluster",
        name="my-kusto-database",
        resource_group_name="test_resource_group")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.kusto.getDatabase({
        clusterName: "test_cluster",
        name: "my-kusto-database",
        resourceGroupName: "test_resource_group",
    });
    
    variables:
      example:
        fn::invoke:
          Function: azure:kusto:getDatabase
          Arguments:
            clusterName: test_cluster
            name: my-kusto-database
            resourceGroupName: test_resource_group
    

    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure:kusto/getDatabase:getDatabase
      arguments:
        # arguments dictionary

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

    ResourceGroupName string

    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.

    ResourceGroupName string

    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.

    resourceGroupName String

    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.

    resourceGroupName string

    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_name str

    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.

    resourceGroupName String

    The Resource Group where the Kusto Database exists.

    getDatabase Result

    The following output properties are available:

    ClusterName string
    HotCachePeriod string

    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
    ResourceGroupName string
    Size double

    The size of the database in bytes.

    SoftDeletePeriod string

    The time the data should be kept before it stops being accessible to queries as ISO 8601 timespan.

    ClusterName string
    HotCachePeriod string

    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
    ResourceGroupName string
    Size float64

    The size of the database in bytes.

    SoftDeletePeriod string

    The time the data should be kept before it stops being accessible to queries as ISO 8601 timespan.

    clusterName String
    hotCachePeriod String

    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
    resourceGroupName String
    size Double

    The size of the database in bytes.

    softDeletePeriod String

    The time the data should be kept before it stops being accessible to queries as ISO 8601 timespan.

    clusterName string
    hotCachePeriod string

    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
    resourceGroupName string
    size number

    The size of the database in bytes.

    softDeletePeriod string

    The time the data should be kept before it stops being accessible to queries as ISO 8601 timespan.

    cluster_name str
    hot_cache_period str

    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_name str
    size float

    The size of the database in bytes.

    soft_delete_period str

    The time the data should be kept before it stops being accessible to queries as ISO 8601 timespan.

    clusterName String
    hotCachePeriod String

    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
    resourceGroupName String
    size Number

    The size of the database in bytes.

    softDeletePeriod String

    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 azurerm Terraform Provider.

    azure logo

    We recommend using Azure Native.

    Azure Classic v5.43.0 published on Saturday, May 6, 2023 by Pulumi