Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.getReadWriteDatabase

Explore with Pulumi AI

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Returns a database.

Uses Azure REST API version 2021-06-01-preview.

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(database_name: Optional[str] = None,
                            kusto_pool_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            workspace_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetReadWriteDatabaseResult
def get_read_write_database_output(database_name: Optional[pulumi.Input[str]] = None,
                            kusto_pool_name: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            workspace_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:synapse:getReadWriteDatabase
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto pool.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto pool.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the database in the Kusto pool.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto pool.
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.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database in the Kusto pool.
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.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database in the Kusto pool.
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.

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.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"
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.
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.
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"
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.
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.
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"
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.
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.
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"
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.
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.
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"
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.
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.
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"
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.

SystemDataResponse

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.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native