Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. synapse
  5. ReadWriteDatabase
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.synapse.ReadWriteDatabase

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Class representing a read write database. Azure REST API version: 2021-06-01-preview.

Example Usage

KustoPoolDatabasesCreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var readWriteDatabase = new AzureNative.Synapse.ReadWriteDatabase("readWriteDatabase", new()
    {
        DatabaseName = "KustoDatabase8",
        Kind = "ReadWrite",
        KustoPoolName = "kustoclusterrptest4",
        Location = "westus",
        ResourceGroupName = "kustorptest",
        SoftDeletePeriod = "P1D",
        WorkspaceName = "synapseWorkspaceName",
    });

});
Copy
package main

import (
	synapse "github.com/pulumi/pulumi-azure-native-sdk/synapse/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synapse.NewReadWriteDatabase(ctx, "readWriteDatabase", &synapse.ReadWriteDatabaseArgs{
			DatabaseName:      pulumi.String("KustoDatabase8"),
			Kind:              pulumi.String("ReadWrite"),
			KustoPoolName:     pulumi.String("kustoclusterrptest4"),
			Location:          pulumi.String("westus"),
			ResourceGroupName: pulumi.String("kustorptest"),
			SoftDeletePeriod:  pulumi.String("P1D"),
			WorkspaceName:     pulumi.String("synapseWorkspaceName"),
		})
		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.synapse.ReadWriteDatabase;
import com.pulumi.azurenative.synapse.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()
            .databaseName("KustoDatabase8")
            .kind("ReadWrite")
            .kustoPoolName("kustoclusterrptest4")
            .location("westus")
            .resourceGroupName("kustorptest")
            .softDeletePeriod("P1D")
            .workspaceName("synapseWorkspaceName")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const readWriteDatabase = new azure_native.synapse.ReadWriteDatabase("readWriteDatabase", {
    databaseName: "KustoDatabase8",
    kind: "ReadWrite",
    kustoPoolName: "kustoclusterrptest4",
    location: "westus",
    resourceGroupName: "kustorptest",
    softDeletePeriod: "P1D",
    workspaceName: "synapseWorkspaceName",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

read_write_database = azure_native.synapse.ReadWriteDatabase("readWriteDatabase",
    database_name="KustoDatabase8",
    kind="ReadWrite",
    kusto_pool_name="kustoclusterrptest4",
    location="westus",
    resource_group_name="kustorptest",
    soft_delete_period="P1D",
    workspace_name="synapseWorkspaceName")
Copy
resources:
  readWriteDatabase:
    type: azure-native:synapse:ReadWriteDatabase
    properties:
      databaseName: KustoDatabase8
      kind: ReadWrite
      kustoPoolName: kustoclusterrptest4
      location: westus
      resourceGroupName: kustorptest
      softDeletePeriod: P1D
      workspaceName: synapseWorkspaceName
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,
                      kusto_pool_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      workspace_name: 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:synapse: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 azure_nativeReadWriteDatabaseResource = new AzureNative.Synapse.ReadWriteDatabase("azure-nativeReadWriteDatabaseResource", new()
{
    Kind = "string",
    KustoPoolName = "string",
    ResourceGroupName = "string",
    WorkspaceName = "string",
    DatabaseName = "string",
    HotCachePeriod = "string",
    Location = "string",
    SoftDeletePeriod = "string",
});
Copy
example, err := synapse.NewReadWriteDatabase(ctx, "azure-nativeReadWriteDatabaseResource", &synapse.ReadWriteDatabaseArgs{
	Kind:              "string",
	KustoPoolName:     "string",
	ResourceGroupName: "string",
	WorkspaceName:     "string",
	DatabaseName:      "string",
	HotCachePeriod:    "string",
	Location:          "string",
	SoftDeletePeriod:  "string",
})
Copy
var azure_nativeReadWriteDatabaseResource = new ReadWriteDatabase("azure-nativeReadWriteDatabaseResource", ReadWriteDatabaseArgs.builder()
    .kind("string")
    .kustoPoolName("string")
    .resourceGroupName("string")
    .workspaceName("string")
    .databaseName("string")
    .hotCachePeriod("string")
    .location("string")
    .softDeletePeriod("string")
    .build());
Copy
azure_native_read_write_database_resource = azure_native.synapse.ReadWriteDatabase("azure-nativeReadWriteDatabaseResource",
    kind=string,
    kusto_pool_name=string,
    resource_group_name=string,
    workspace_name=string,
    database_name=string,
    hot_cache_period=string,
    location=string,
    soft_delete_period=string)
Copy
const azure_nativeReadWriteDatabaseResource = new azure_native.synapse.ReadWriteDatabase("azure-nativeReadWriteDatabaseResource", {
    kind: "string",
    kustoPoolName: "string",
    resourceGroupName: "string",
    workspaceName: "string",
    databaseName: "string",
    hotCachePeriod: "string",
    location: "string",
    softDeletePeriod: "string",
});
Copy
type: azure-native:synapse:ReadWriteDatabase
properties:
    databaseName: string
    hotCachePeriod: string
    kind: string
    kustoPoolName: string
    location: string
    resourceGroupName: string
    softDeletePeriod: string
    workspaceName: 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:

KustoPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto pool.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
DatabaseName Changes to this property will trigger replacement. string
The name of the database in the Kusto pool.
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.
KustoPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto pool.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
DatabaseName Changes to this property will trigger replacement. string
The name of the database in the Kusto pool.
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.
kustoPoolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto pool.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
databaseName Changes to this property will trigger replacement. String
The name of the database in the Kusto pool.
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.
kustoPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto pool.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
databaseName Changes to this property will trigger replacement. string
The name of the database in the Kusto pool.
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.
kusto_pool_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Kusto pool.
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.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
database_name Changes to this property will trigger replacement. str
The name of the database in the Kusto pool.
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.
kustoPoolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto pool.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
databaseName Changes to this property will trigger replacement. String
The name of the database in the Kusto pool.
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.Synapse.Outputs.DatabaseStatisticsResponse
The statistics of the database.
SystemData Pulumi.AzureNative.Synapse.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

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

$ pulumi import azure-native:synapse:ReadWriteDatabase KustoClusterRPTest4/KustoDatabase8 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native