1. Packages
  2. Azure Native v2
  3. API Docs
  4. kusto
  5. getReadWriteDatabase
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

azure-native-v2.kusto.getReadWriteDatabase

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

Returns a database. Azure REST API version: 2022-12-29.

Using getReadWriteDatabase

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 getReadWriteDatabase(args: GetReadWriteDatabaseArgs, opts?: InvokeOptions): Promise<GetReadWriteDatabaseResult>
function getReadWriteDatabaseOutput(args: GetReadWriteDatabaseOutputArgs, opts?: InvokeOptions): Output<GetReadWriteDatabaseResult>
Copy
def get_read_write_database(cluster_name: Optional[str] = None,
                            database_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetReadWriteDatabaseResult
def get_read_write_database_output(cluster_name: Optional[pulumi.Input[str]] = None,
                            database_name: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetReadWriteDatabaseResult]
Copy
func LookupReadWriteDatabase(ctx *Context, args *LookupReadWriteDatabaseArgs, opts ...InvokeOption) (*LookupReadWriteDatabaseResult, error)
func LookupReadWriteDatabaseOutput(ctx *Context, args *LookupReadWriteDatabaseOutputArgs, opts ...InvokeOption) LookupReadWriteDatabaseResultOutput
Copy

> Note: This function is named LookupReadWriteDatabase in the Go SDK.

public static class GetReadWriteDatabase 
{
    public static Task<GetReadWriteDatabaseResult> InvokeAsync(GetReadWriteDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetReadWriteDatabaseResult> Invoke(GetReadWriteDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetReadWriteDatabaseResult> getReadWriteDatabase(GetReadWriteDatabaseArgs args, InvokeOptions options)
public static Output<GetReadWriteDatabaseResult> getReadWriteDatabase(GetReadWriteDatabaseArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:kusto:getReadWriteDatabase
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group containing the Kusto cluster.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group containing the Kusto cluster.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto cluster.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database in the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group containing the Kusto cluster.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group containing the Kusto cluster.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Kusto cluster.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database in the Kusto cluster.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group containing the Kusto cluster.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto cluster.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database in the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group containing the Kusto cluster.

getReadWriteDatabase Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
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.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
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.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
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.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
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.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
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.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
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.

Supporting Types

DatabaseStatisticsResponse

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.

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