1. Packages
  2. Azure Native
  3. API Docs
  4. kusto
  5. ReadWriteDatabase
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.kusto.ReadWriteDatabase

Explore with Pulumi AI

Class representing a read write database.

Uses Azure REST API version 2024-04-13. In version 2.x of the Azure Native provider, it used API version 2022-12-29.

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",
    });

});
Copy
package main

import (
	kusto "github.com/pulumi/pulumi-azure-native-sdk/kusto/v3"
	"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
	})
}
Copy
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());

    }
}
Copy
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",
});
Copy
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")
Copy
resources:
  readWriteDatabase:
    type: azure-native:kusto:ReadWriteDatabase
    properties:
      clusterName: kustoCluster
      databaseName: kustoReadOnlyDatabase
      resourceGroupName: kustorptest
Copy

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",
    });

});
Copy
package main

import (
	kusto "github.com/pulumi/pulumi-azure-native-sdk/kusto/v3"
	"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
	})
}
Copy
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());

    }
}
Copy
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",
});
Copy
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")
Copy
resources:
  readWriteDatabase:
    type: azure-native:kusto:ReadWriteDatabase
    properties:
      callerRole: Admin
      clusterName: kustoCluster
      databaseName: KustoDatabase8
      kind: ReadWrite
      location: westus
      resourceGroupName: kustorptest
      softDeletePeriod: P1D
Copy

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,
                      key_vault_properties: Optional[KeyVaultPropertiesArgs] = 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 This property is required. string
The unique name of the resource.
args This property is required. ReadWriteDatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ReadWriteDatabaseArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ReadWriteDatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
    KeyVaultProperties = new AzureNative.Kusto.Inputs.KeyVaultPropertiesArgs
    {
        KeyName = "string",
        KeyVaultUri = "string",
        KeyVersion = "string",
        UserIdentity = "string",
    },
    Location = "string",
    SoftDeletePeriod = "string",
});
Copy
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"),
	KeyVaultProperties: &kusto.KeyVaultPropertiesArgs{
		KeyName:      pulumi.String("string"),
		KeyVaultUri:  pulumi.String("string"),
		KeyVersion:   pulumi.String("string"),
		UserIdentity: pulumi.String("string"),
	},
	Location:         pulumi.String("string"),
	SoftDeletePeriod: pulumi.String("string"),
})
Copy
var readWriteDatabaseResource = new ReadWriteDatabase("readWriteDatabaseResource", ReadWriteDatabaseArgs.builder()
    .clusterName("string")
    .kind("string")
    .resourceGroupName("string")
    .callerRole("string")
    .databaseName("string")
    .hotCachePeriod("string")
    .keyVaultProperties(KeyVaultPropertiesArgs.builder()
        .keyName("string")
        .keyVaultUri("string")
        .keyVersion("string")
        .userIdentity("string")
        .build())
    .location("string")
    .softDeletePeriod("string")
    .build());
Copy
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",
    key_vault_properties={
        "key_name": "string",
        "key_vault_uri": "string",
        "key_version": "string",
        "user_identity": "string",
    },
    location="string",
    soft_delete_period="string")
Copy
const readWriteDatabaseResource = new azure_native.kusto.ReadWriteDatabase("readWriteDatabaseResource", {
    clusterName: "string",
    kind: "string",
    resourceGroupName: "string",
    callerRole: "string",
    databaseName: "string",
    hotCachePeriod: "string",
    keyVaultProperties: {
        keyName: "string",
        keyVaultUri: "string",
        keyVersion: "string",
        userIdentity: "string",
    },
    location: "string",
    softDeletePeriod: "string",
});
Copy
type: azure-native:kusto:ReadWriteDatabase
properties:
    callerRole: string
    clusterName: string
    databaseName: string
    hotCachePeriod: string
    keyVaultProperties:
        keyName: string
        keyVaultUri: string
        keyVersion: string
        userIdentity: string
    kind: string
    location: string
    resourceGroupName: string
    softDeletePeriod: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ReadWriteDatabase resource accepts the following input properties:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
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 Changes to this property will trigger replacement. 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.
KeyVaultProperties Pulumi.AzureNative.Kusto.Inputs.KeyVaultProperties
KeyVault properties for the database encryption.
Location string
Resource location.
SoftDeletePeriod string
The time the data should be kept before it stops being accessible to queries in TimeSpan.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
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 Changes to this property will trigger replacement. 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.
KeyVaultProperties KeyVaultPropertiesArgs
KeyVault properties for the database encryption.
Location string
Resource location.
SoftDeletePeriod string
The time the data should be kept before it stops being accessible to queries in TimeSpan.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
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 Changes to this property will trigger replacement. 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.
keyVaultProperties KeyVaultProperties
KeyVault properties for the database encryption.
location String
Resource location.
softDeletePeriod String
The time the data should be kept before it stops being accessible to queries in TimeSpan.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
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 Changes to this property will trigger replacement. 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.
keyVaultProperties KeyVaultProperties
KeyVault properties for the database encryption.
location string
Resource location.
softDeletePeriod string
The time the data should be kept before it stops being accessible to queries in TimeSpan.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Kusto cluster.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
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 Changes to this property will trigger replacement. 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.
key_vault_properties KeyVaultPropertiesArgs
KeyVault properties for the database encryption.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
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 Changes to this property will trigger replacement. 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.
keyVaultProperties Property Map
KeyVault properties for the database encryption.
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:

AzureApiVersion string
The Azure API version of the resource.
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.
SuspensionDetails Pulumi.AzureNative.Kusto.Outputs.SuspensionDetailsResponse
The database suspension details. If the database is suspended, this object contains information related to the database's suspension state.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
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.
SuspensionDetails SuspensionDetailsResponse
The database suspension details. If the database is suspended, this object contains information related to the database's suspension state.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
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.
suspensionDetails SuspensionDetailsResponse
The database suspension details. If the database is suspended, this object contains information related to the database's suspension state.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
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.
suspensionDetails SuspensionDetailsResponse
The database suspension details. If the database is suspended, this object contains information related to the database's suspension state.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
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.
suspension_details SuspensionDetailsResponse
The database suspension details. If the database is suspended, this object contains information related to the database's suspension state.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
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.
suspensionDetails Property Map
The database suspension details. If the database is suspended, this object contains information related to the database's suspension state.
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.

KeyVaultProperties
, KeyVaultPropertiesArgs

KeyName string
The name of the key vault key.
KeyVaultUri string
The Uri of the key vault.
KeyVersion string
The version of the key vault key.
UserIdentity string
The user assigned identity (ARM resource id) that has access to the key.
KeyName string
The name of the key vault key.
KeyVaultUri string
The Uri of the key vault.
KeyVersion string
The version of the key vault key.
UserIdentity string
The user assigned identity (ARM resource id) that has access to the key.
keyName String
The name of the key vault key.
keyVaultUri String
The Uri of the key vault.
keyVersion String
The version of the key vault key.
userIdentity String
The user assigned identity (ARM resource id) that has access to the key.
keyName string
The name of the key vault key.
keyVaultUri string
The Uri of the key vault.
keyVersion string
The version of the key vault key.
userIdentity string
The user assigned identity (ARM resource id) that has access to the key.
key_name str
The name of the key vault key.
key_vault_uri str
The Uri of the key vault.
key_version str
The version of the key vault key.
user_identity str
The user assigned identity (ARM resource id) that has access to the key.
keyName String
The name of the key vault key.
keyVaultUri String
The Uri of the key vault.
keyVersion String
The version of the key vault key.
userIdentity String
The user assigned identity (ARM resource id) that has access to the key.

KeyVaultPropertiesResponse
, KeyVaultPropertiesResponseArgs

KeyName string
The name of the key vault key.
KeyVaultUri string
The Uri of the key vault.
KeyVersion string
The version of the key vault key.
UserIdentity string
The user assigned identity (ARM resource id) that has access to the key.
KeyName string
The name of the key vault key.
KeyVaultUri string
The Uri of the key vault.
KeyVersion string
The version of the key vault key.
UserIdentity string
The user assigned identity (ARM resource id) that has access to the key.
keyName String
The name of the key vault key.
keyVaultUri String
The Uri of the key vault.
keyVersion String
The version of the key vault key.
userIdentity String
The user assigned identity (ARM resource id) that has access to the key.
keyName string
The name of the key vault key.
keyVaultUri string
The Uri of the key vault.
keyVersion string
The version of the key vault key.
userIdentity string
The user assigned identity (ARM resource id) that has access to the key.
key_name str
The name of the key vault key.
key_vault_uri str
The Uri of the key vault.
key_version str
The version of the key vault key.
user_identity str
The user assigned identity (ARM resource id) that has access to the key.
keyName String
The name of the key vault key.
keyVaultUri String
The Uri of the key vault.
keyVersion String
The version of the key vault key.
userIdentity String
The user assigned identity (ARM resource id) that has access to the key.

SuspensionDetailsResponse
, SuspensionDetailsResponseArgs

SuspensionStartDate string
The starting date and time of the suspension state.
SuspensionStartDate string
The starting date and time of the suspension state.
suspensionStartDate String
The starting date and time of the suspension state.
suspensionStartDate string
The starting date and time of the suspension state.
suspension_start_date str
The starting date and time of the suspension state.
suspensionStartDate String
The starting date and time of the suspension state.

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} 
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0