1. Packages
  2. Azure Native
  3. API Docs
  4. kusto
  5. ReadWriteDatabase
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi

azure-native.kusto.ReadWriteDatabase

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi

    Class representing a read write database. Azure REST API version: 2022-12-29. Prior API version in Azure Native 1.x: 2021-01-01.

    Example Usage

    Kusto ReadOnly database update

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var readWriteDatabase = new AzureNative.Kusto.ReadWriteDatabase("readWriteDatabase", new()
        {
            ClusterName = "kustoCluster",
            DatabaseName = "kustoReadOnlyDatabase",
            ResourceGroupName = "kustorptest",
        });
    
    });
    
    package main
    
    import (
    	kusto "github.com/pulumi/pulumi-azure-native-sdk/kusto/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := kusto.NewReadWriteDatabase(ctx, "readWriteDatabase", &kusto.ReadWriteDatabaseArgs{
    			ClusterName:       pulumi.String("kustoCluster"),
    			DatabaseName:      pulumi.String("kustoReadOnlyDatabase"),
    			ResourceGroupName: pulumi.String("kustorptest"),
    		})
    		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.azurenative.kusto.ReadWriteDatabase;
    import com.pulumi.azurenative.kusto.ReadWriteDatabaseArgs;
    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) {
            var readWriteDatabase = new ReadWriteDatabase("readWriteDatabase", ReadWriteDatabaseArgs.builder()
                .clusterName("kustoCluster")
                .databaseName("kustoReadOnlyDatabase")
                .resourceGroupName("kustorptest")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    read_write_database = azure_native.kusto.ReadWriteDatabase("readWriteDatabase",
        cluster_name="kustoCluster",
        database_name="kustoReadOnlyDatabase",
        resource_group_name="kustorptest")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const readWriteDatabase = new azure_native.kusto.ReadWriteDatabase("readWriteDatabase", {
        clusterName: "kustoCluster",
        databaseName: "kustoReadOnlyDatabase",
        resourceGroupName: "kustorptest",
    });
    
    resources:
      readWriteDatabase:
        type: azure-native:kusto:ReadWriteDatabase
        properties:
          clusterName: kustoCluster
          databaseName: kustoReadOnlyDatabase
          resourceGroupName: kustorptest
    

    Kusto ReadWrite database create or update

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var readWriteDatabase = new AzureNative.Kusto.ReadWriteDatabase("readWriteDatabase", new()
        {
            CallerRole = "Admin",
            ClusterName = "kustoCluster",
            DatabaseName = "KustoDatabase8",
            Kind = "ReadWrite",
            Location = "westus",
            ResourceGroupName = "kustorptest",
            SoftDeletePeriod = "P1D",
        });
    
    });
    
    package main
    
    import (
    	kusto "github.com/pulumi/pulumi-azure-native-sdk/kusto/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := kusto.NewReadWriteDatabase(ctx, "readWriteDatabase", &kusto.ReadWriteDatabaseArgs{
    			CallerRole:        pulumi.String("Admin"),
    			ClusterName:       pulumi.String("kustoCluster"),
    			DatabaseName:      pulumi.String("KustoDatabase8"),
    			Kind:              pulumi.String("ReadWrite"),
    			Location:          pulumi.String("westus"),
    			ResourceGroupName: pulumi.String("kustorptest"),
    			SoftDeletePeriod:  pulumi.String("P1D"),
    		})
    		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.azurenative.kusto.ReadWriteDatabase;
    import com.pulumi.azurenative.kusto.ReadWriteDatabaseArgs;
    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) {
            var readWriteDatabase = new ReadWriteDatabase("readWriteDatabase", ReadWriteDatabaseArgs.builder()
                .callerRole("Admin")
                .clusterName("kustoCluster")
                .databaseName("KustoDatabase8")
                .kind("ReadWrite")
                .location("westus")
                .resourceGroupName("kustorptest")
                .softDeletePeriod("P1D")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    read_write_database = azure_native.kusto.ReadWriteDatabase("readWriteDatabase",
        caller_role="Admin",
        cluster_name="kustoCluster",
        database_name="KustoDatabase8",
        kind="ReadWrite",
        location="westus",
        resource_group_name="kustorptest",
        soft_delete_period="P1D")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const readWriteDatabase = new azure_native.kusto.ReadWriteDatabase("readWriteDatabase", {
        callerRole: "Admin",
        clusterName: "kustoCluster",
        databaseName: "KustoDatabase8",
        kind: "ReadWrite",
        location: "westus",
        resourceGroupName: "kustorptest",
        softDeletePeriod: "P1D",
    });
    
    resources:
      readWriteDatabase:
        type: azure-native:kusto:ReadWriteDatabase
        properties:
          callerRole: Admin
          clusterName: kustoCluster
          databaseName: KustoDatabase8
          kind: ReadWrite
          location: westus
          resourceGroupName: kustorptest
          softDeletePeriod: P1D
    

    Create ReadWriteDatabase Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ReadWriteDatabase(name: string, args: ReadWriteDatabaseArgs, opts?: CustomResourceOptions);
    @overload
    def ReadWriteDatabase(resource_name: str,
                          args: ReadWriteDatabaseArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def ReadWriteDatabase(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          cluster_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          caller_role: Optional[str] = None,
                          database_name: Optional[str] = None,
                          hot_cache_period: Optional[str] = None,
                          location: Optional[str] = None,
                          soft_delete_period: Optional[str] = None)
    func NewReadWriteDatabase(ctx *Context, name string, args ReadWriteDatabaseArgs, opts ...ResourceOption) (*ReadWriteDatabase, error)
    public ReadWriteDatabase(string name, ReadWriteDatabaseArgs args, CustomResourceOptions? opts = null)
    public ReadWriteDatabase(String name, ReadWriteDatabaseArgs args)
    public ReadWriteDatabase(String name, ReadWriteDatabaseArgs args, CustomResourceOptions options)
    
    type: azure-native:kusto:ReadWriteDatabase
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ReadWriteDatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ReadWriteDatabaseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ReadWriteDatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReadWriteDatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReadWriteDatabaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var readWriteDatabaseResource = new AzureNative.Kusto.ReadWriteDatabase("readWriteDatabaseResource", new()
    {
        ClusterName = "string",
        Kind = "string",
        ResourceGroupName = "string",
        CallerRole = "string",
        DatabaseName = "string",
        HotCachePeriod = "string",
        Location = "string",
        SoftDeletePeriod = "string",
    });
    
    example, err := kusto.NewReadWriteDatabase(ctx, "readWriteDatabaseResource", &kusto.ReadWriteDatabaseArgs{
    ClusterName: pulumi.String("string"),
    Kind: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    CallerRole: pulumi.String("string"),
    DatabaseName: pulumi.String("string"),
    HotCachePeriod: pulumi.String("string"),
    Location: pulumi.String("string"),
    SoftDeletePeriod: pulumi.String("string"),
    })
    
    var readWriteDatabaseResource = new ReadWriteDatabase("readWriteDatabaseResource", ReadWriteDatabaseArgs.builder()
        .clusterName("string")
        .kind("string")
        .resourceGroupName("string")
        .callerRole("string")
        .databaseName("string")
        .hotCachePeriod("string")
        .location("string")
        .softDeletePeriod("string")
        .build());
    
    read_write_database_resource = azure_native.kusto.ReadWriteDatabase("readWriteDatabaseResource",
        cluster_name="string",
        kind="string",
        resource_group_name="string",
        caller_role="string",
        database_name="string",
        hot_cache_period="string",
        location="string",
        soft_delete_period="string")
    
    const readWriteDatabaseResource = new azure_native.kusto.ReadWriteDatabase("readWriteDatabaseResource", {
        clusterName: "string",
        kind: "string",
        resourceGroupName: "string",
        callerRole: "string",
        databaseName: "string",
        hotCachePeriod: "string",
        location: "string",
        softDeletePeriod: "string",
    });
    
    type: azure-native:kusto:ReadWriteDatabase
    properties:
        callerRole: string
        clusterName: string
        databaseName: string
        hotCachePeriod: string
        kind: string
        location: string
        resourceGroupName: string
        softDeletePeriod: string
    

    ReadWriteDatabase Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ReadWriteDatabase resource accepts the following input properties:

    ClusterName string
    The name of the Kusto cluster.
    ResourceGroupName string
    The name of the resource group containing the Kusto cluster.
    CallerRole string
    By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list.
    DatabaseName string
    The name of the database in the Kusto cluster.
    HotCachePeriod string
    The time the data should be kept in cache for fast queries in TimeSpan.
    Location string
    Resource location.
    SoftDeletePeriod string
    The time the data should be kept before it stops being accessible to queries in TimeSpan.
    ClusterName string
    The name of the Kusto cluster.
    ResourceGroupName string
    The name of the resource group containing the Kusto cluster.
    CallerRole string
    By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list.
    DatabaseName string
    The name of the database in the Kusto cluster.
    HotCachePeriod string
    The time the data should be kept in cache for fast queries in TimeSpan.
    Location string
    Resource location.
    SoftDeletePeriod string
    The time the data should be kept before it stops being accessible to queries in TimeSpan.
    clusterName String
    The name of the Kusto cluster.
    resourceGroupName String
    The name of the resource group containing the Kusto cluster.
    callerRole String
    By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list.
    databaseName String
    The name of the database in the Kusto cluster.
    hotCachePeriod String
    The time the data should be kept in cache for fast queries in TimeSpan.
    location String
    Resource location.
    softDeletePeriod String
    The time the data should be kept before it stops being accessible to queries in TimeSpan.
    clusterName string
    The name of the Kusto cluster.
    resourceGroupName string
    The name of the resource group containing the Kusto cluster.
    callerRole string
    By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list.
    databaseName string
    The name of the database in the Kusto cluster.
    hotCachePeriod string
    The time the data should be kept in cache for fast queries in TimeSpan.
    location string
    Resource location.
    softDeletePeriod string
    The time the data should be kept before it stops being accessible to queries in TimeSpan.
    cluster_name str
    The name of the Kusto cluster.
    resource_group_name str
    The name of the resource group containing the Kusto cluster.
    caller_role str
    By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list.
    database_name str
    The name of the database in the Kusto cluster.
    hot_cache_period str
    The time the data should be kept in cache for fast queries in TimeSpan.
    location str
    Resource location.
    soft_delete_period str
    The time the data should be kept before it stops being accessible to queries in TimeSpan.
    clusterName String
    The name of the Kusto cluster.
    resourceGroupName String
    The name of the resource group containing the Kusto cluster.
    callerRole String
    By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list.
    databaseName String
    The name of the database in the Kusto cluster.
    hotCachePeriod String
    The time the data should be kept in cache for fast queries in TimeSpan.
    location String
    Resource location.
    softDeletePeriod String
    The time the data should be kept before it stops being accessible to queries in TimeSpan.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ReadWriteDatabase resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IsFollowed bool
    Indicates whether the database is followed.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioned state of the resource.
    Statistics Pulumi.AzureNative.Kusto.Outputs.DatabaseStatisticsResponse
    The statistics of the database.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    IsFollowed bool
    Indicates whether the database is followed.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioned state of the resource.
    Statistics DatabaseStatisticsResponse
    The statistics of the database.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    isFollowed Boolean
    Indicates whether the database is followed.
    name String
    The name of the resource
    provisioningState String
    The provisioned state of the resource.
    statistics DatabaseStatisticsResponse
    The statistics of the database.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    isFollowed boolean
    Indicates whether the database is followed.
    name string
    The name of the resource
    provisioningState string
    The provisioned state of the resource.
    statistics DatabaseStatisticsResponse
    The statistics of the database.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    is_followed bool
    Indicates whether the database is followed.
    name str
    The name of the resource
    provisioning_state str
    The provisioned state of the resource.
    statistics DatabaseStatisticsResponse
    The statistics of the database.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    isFollowed Boolean
    Indicates whether the database is followed.
    name String
    The name of the resource
    provisioningState String
    The provisioned state of the resource.
    statistics Property Map
    The statistics of the database.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    DatabaseStatisticsResponse, DatabaseStatisticsResponseArgs

    Size double
    The database size - the total size of compressed data and index in bytes.
    Size float64
    The database size - the total size of compressed data and index in bytes.
    size Double
    The database size - the total size of compressed data and index in bytes.
    size number
    The database size - the total size of compressed data and index in bytes.
    size float
    The database size - the total size of compressed data and index in bytes.
    size Number
    The database size - the total size of compressed data and index in bytes.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:kusto:ReadWriteDatabase kustoCluster/KustoDatabase8 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi