1. Packages
  2. Azure Native
  3. API Docs
  4. kusto
  5. getReadWriteDatabase
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.3.0 published on Monday, Apr 28, 2025 by Pulumi

azure-native.kusto.getReadWriteDatabase

Explore with Pulumi AI

azure-native logo
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.3.0 published on Monday, Apr 28, 2025 by Pulumi

    Returns a database.

    Uses Azure REST API version 2024-04-13.

    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>
    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]
    func LookupReadWriteDatabase(ctx *Context, args *LookupReadWriteDatabaseArgs, opts ...InvokeOption) (*LookupReadWriteDatabaseResult, error)
    func LookupReadWriteDatabaseOutput(ctx *Context, args *LookupReadWriteDatabaseOutputArgs, opts ...InvokeOption) LookupReadWriteDatabaseResultOutput

    > 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)
    }
    public static CompletableFuture<GetReadWriteDatabaseResult> getReadWriteDatabase(GetReadWriteDatabaseArgs args, InvokeOptions options)
    public static Output<GetReadWriteDatabaseResult> getReadWriteDatabase(GetReadWriteDatabaseArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:kusto:getReadWriteDatabase
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterName string
    The name of the Kusto cluster.
    DatabaseName string
    The name of the database in the Kusto cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ClusterName string
    The name of the Kusto cluster.
    DatabaseName string
    The name of the database in the Kusto cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    clusterName String
    The name of the Kusto cluster.
    databaseName String
    The name of the database in the Kusto cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    clusterName string
    The name of the Kusto cluster.
    databaseName string
    The name of the database in the Kusto cluster.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    cluster_name str
    The name of the Kusto cluster.
    database_name str
    The name of the database in the Kusto cluster.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    clusterName String
    The name of the Kusto cluster.
    databaseName String
    The name of the database in the Kusto cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getReadWriteDatabase Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    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.
    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"
    HotCachePeriod string
    The time the data should be kept in cache for fast queries in TimeSpan.
    KeyVaultProperties Pulumi.AzureNative.Kusto.Outputs.KeyVaultPropertiesResponse
    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.
    AzureApiVersion string
    The Azure API version of the resource.
    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.
    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"
    HotCachePeriod string
    The time the data should be kept in cache for fast queries in TimeSpan.
    KeyVaultProperties KeyVaultPropertiesResponse
    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.
    azureApiVersion String
    The Azure API version of the resource.
    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.
    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"
    hotCachePeriod String
    The time the data should be kept in cache for fast queries in TimeSpan.
    keyVaultProperties KeyVaultPropertiesResponse
    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.
    azureApiVersion string
    The Azure API version of the resource.
    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.
    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"
    hotCachePeriod string
    The time the data should be kept in cache for fast queries in TimeSpan.
    keyVaultProperties KeyVaultPropertiesResponse
    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.
    azure_api_version str
    The Azure API version of the resource.
    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.
    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"
    hot_cache_period str
    The time the data should be kept in cache for fast queries in TimeSpan.
    key_vault_properties KeyVaultPropertiesResponse
    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.
    azureApiVersion String
    The Azure API version of the resource.
    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.
    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"
    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.

    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.

    KeyVaultPropertiesResponse

    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

    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.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi