Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. synapse
  5. getReadOnlyFollowingDatabase
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.getReadOnlyFollowingDatabase

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

Returns a database. Azure REST API version: 2021-06-01-preview.

Using getReadOnlyFollowingDatabase

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 getReadOnlyFollowingDatabase(args: GetReadOnlyFollowingDatabaseArgs, opts?: InvokeOptions): Promise<GetReadOnlyFollowingDatabaseResult>
function getReadOnlyFollowingDatabaseOutput(args: GetReadOnlyFollowingDatabaseOutputArgs, opts?: InvokeOptions): Output<GetReadOnlyFollowingDatabaseResult>
Copy
def get_read_only_following_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) -> GetReadOnlyFollowingDatabaseResult
def get_read_only_following_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[GetReadOnlyFollowingDatabaseResult]
Copy
func LookupReadOnlyFollowingDatabase(ctx *Context, args *LookupReadOnlyFollowingDatabaseArgs, opts ...InvokeOption) (*LookupReadOnlyFollowingDatabaseResult, error)
func LookupReadOnlyFollowingDatabaseOutput(ctx *Context, args *LookupReadOnlyFollowingDatabaseOutputArgs, opts ...InvokeOption) LookupReadOnlyFollowingDatabaseResultOutput
Copy

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

public static class GetReadOnlyFollowingDatabase 
{
    public static Task<GetReadOnlyFollowingDatabaseResult> InvokeAsync(GetReadOnlyFollowingDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetReadOnlyFollowingDatabaseResult> Invoke(GetReadOnlyFollowingDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetReadOnlyFollowingDatabaseResult> getReadOnlyFollowingDatabase(GetReadOnlyFollowingDatabaseArgs args, InvokeOptions options)
public static Output<GetReadOnlyFollowingDatabaseResult> getReadOnlyFollowingDatabase(GetReadOnlyFollowingDatabaseArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:synapse:getReadOnlyFollowingDatabase
  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.

getReadOnlyFollowingDatabase Result

The following output properties are available:

AttachedDatabaseConfigurationName string
The name of the attached database configuration cluster
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LeaderClusterResourceId string
The name of the leader cluster
Name string
The name of the resource
PrincipalsModificationKind string
The principals modification kind of the database
ProvisioningState string
The provisioned state of the resource.
SoftDeletePeriod string
The time the data should be kept before it stops being accessible to queries in TimeSpan.
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.
AttachedDatabaseConfigurationName string
The name of the attached database configuration cluster
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LeaderClusterResourceId string
The name of the leader cluster
Name string
The name of the resource
PrincipalsModificationKind string
The principals modification kind of the database
ProvisioningState string
The provisioned state of the resource.
SoftDeletePeriod string
The time the data should be kept before it stops being accessible to queries in TimeSpan.
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.
attachedDatabaseConfigurationName String
The name of the attached database configuration cluster
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
leaderClusterResourceId String
The name of the leader cluster
name String
The name of the resource
principalsModificationKind String
The principals modification kind of the database
provisioningState String
The provisioned state of the resource.
softDeletePeriod String
The time the data should be kept before it stops being accessible to queries in TimeSpan.
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.
attachedDatabaseConfigurationName string
The name of the attached database configuration cluster
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
leaderClusterResourceId string
The name of the leader cluster
name string
The name of the resource
principalsModificationKind string
The principals modification kind of the database
provisioningState string
The provisioned state of the resource.
softDeletePeriod string
The time the data should be kept before it stops being accessible to queries in TimeSpan.
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.
attached_database_configuration_name str
The name of the attached database configuration cluster
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
leader_cluster_resource_id str
The name of the leader cluster
name str
The name of the resource
principals_modification_kind str
The principals modification kind of the database
provisioning_state str
The provisioned state of the resource.
soft_delete_period str
The time the data should be kept before it stops being accessible to queries in TimeSpan.
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.
attachedDatabaseConfigurationName String
The name of the attached database configuration cluster
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
leaderClusterResourceId String
The name of the leader cluster
name String
The name of the resource
principalsModificationKind String
The principals modification kind of the database
provisioningState String
The provisioned state of the resource.
softDeletePeriod String
The time the data should be kept before it stops being accessible to queries in TimeSpan.
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.

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