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

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 only following 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 readOnlyFollowingDatabase = new AzureNative.Synapse.ReadOnlyFollowingDatabase("readOnlyFollowingDatabase", new()
    {
        DatabaseName = "KustoDatabase8",
        KustoPoolName = "kustoclusterrptest4",
        ResourceGroupName = "kustorptest",
        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.NewReadOnlyFollowingDatabase(ctx, "readOnlyFollowingDatabase", &synapse.ReadOnlyFollowingDatabaseArgs{
			DatabaseName:      pulumi.String("KustoDatabase8"),
			KustoPoolName:     pulumi.String("kustoclusterrptest4"),
			ResourceGroupName: pulumi.String("kustorptest"),
			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.ReadOnlyFollowingDatabase;
import com.pulumi.azurenative.synapse.ReadOnlyFollowingDatabaseArgs;
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 readOnlyFollowingDatabase = new ReadOnlyFollowingDatabase("readOnlyFollowingDatabase", ReadOnlyFollowingDatabaseArgs.builder()
            .databaseName("KustoDatabase8")
            .kustoPoolName("kustoclusterrptest4")
            .resourceGroupName("kustorptest")
            .workspaceName("synapseWorkspaceName")
            .build());

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

const readOnlyFollowingDatabase = new azure_native.synapse.ReadOnlyFollowingDatabase("readOnlyFollowingDatabase", {
    databaseName: "KustoDatabase8",
    kustoPoolName: "kustoclusterrptest4",
    resourceGroupName: "kustorptest",
    workspaceName: "synapseWorkspaceName",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

read_only_following_database = azure_native.synapse.ReadOnlyFollowingDatabase("readOnlyFollowingDatabase",
    database_name="KustoDatabase8",
    kusto_pool_name="kustoclusterrptest4",
    resource_group_name="kustorptest",
    workspace_name="synapseWorkspaceName")
Copy
resources:
  readOnlyFollowingDatabase:
    type: azure-native:synapse:ReadOnlyFollowingDatabase
    properties:
      databaseName: KustoDatabase8
      kustoPoolName: kustoclusterrptest4
      resourceGroupName: kustorptest
      workspaceName: synapseWorkspaceName
Copy

Create ReadOnlyFollowingDatabase Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ReadOnlyFollowingDatabase(name: string, args: ReadOnlyFollowingDatabaseArgs, opts?: CustomResourceOptions);
@overload
def ReadOnlyFollowingDatabase(resource_name: str,
                              args: ReadOnlyFollowingDatabaseArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def ReadOnlyFollowingDatabase(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)
func NewReadOnlyFollowingDatabase(ctx *Context, name string, args ReadOnlyFollowingDatabaseArgs, opts ...ResourceOption) (*ReadOnlyFollowingDatabase, error)
public ReadOnlyFollowingDatabase(string name, ReadOnlyFollowingDatabaseArgs args, CustomResourceOptions? opts = null)
public ReadOnlyFollowingDatabase(String name, ReadOnlyFollowingDatabaseArgs args)
public ReadOnlyFollowingDatabase(String name, ReadOnlyFollowingDatabaseArgs args, CustomResourceOptions options)

type: azure-native:synapse:ReadOnlyFollowingDatabase
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. ReadOnlyFollowingDatabaseArgs
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. ReadOnlyFollowingDatabaseArgs
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. ReadOnlyFollowingDatabaseArgs
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. ReadOnlyFollowingDatabaseArgs
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. ReadOnlyFollowingDatabaseArgs
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_nativeReadOnlyFollowingDatabaseResource = new AzureNative.Synapse.ReadOnlyFollowingDatabase("azure-nativeReadOnlyFollowingDatabaseResource", new()
{
    Kind = "string",
    KustoPoolName = "string",
    ResourceGroupName = "string",
    WorkspaceName = "string",
    DatabaseName = "string",
    HotCachePeriod = "string",
    Location = "string",
});
Copy
example, err := synapse.NewReadOnlyFollowingDatabase(ctx, "azure-nativeReadOnlyFollowingDatabaseResource", &synapse.ReadOnlyFollowingDatabaseArgs{
	Kind:              "string",
	KustoPoolName:     "string",
	ResourceGroupName: "string",
	WorkspaceName:     "string",
	DatabaseName:      "string",
	HotCachePeriod:    "string",
	Location:          "string",
})
Copy
var azure_nativeReadOnlyFollowingDatabaseResource = new ReadOnlyFollowingDatabase("azure-nativeReadOnlyFollowingDatabaseResource", ReadOnlyFollowingDatabaseArgs.builder()
    .kind("string")
    .kustoPoolName("string")
    .resourceGroupName("string")
    .workspaceName("string")
    .databaseName("string")
    .hotCachePeriod("string")
    .location("string")
    .build());
Copy
azure_native_read_only_following_database_resource = azure_native.synapse.ReadOnlyFollowingDatabase("azure-nativeReadOnlyFollowingDatabaseResource",
    kind=string,
    kusto_pool_name=string,
    resource_group_name=string,
    workspace_name=string,
    database_name=string,
    hot_cache_period=string,
    location=string)
Copy
const azure_nativeReadOnlyFollowingDatabaseResource = new azure_native.synapse.ReadOnlyFollowingDatabase("azure-nativeReadOnlyFollowingDatabaseResource", {
    kind: "string",
    kustoPoolName: "string",
    resourceGroupName: "string",
    workspaceName: "string",
    databaseName: "string",
    hotCachePeriod: "string",
    location: "string",
});
Copy
type: azure-native:synapse:ReadOnlyFollowingDatabase
properties:
    databaseName: string
    hotCachePeriod: string
    kind: string
    kustoPoolName: string
    location: string
    resourceGroupName: string
    workspaceName: string
Copy

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

Outputs

All input properties are implicitly available as output properties. Additionally, the ReadOnlyFollowingDatabase resource produces the following output properties:

AttachedDatabaseConfigurationName string
The name of the attached database configuration cluster
Id string
The provider-assigned unique ID for this managed resource.
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"
AttachedDatabaseConfigurationName string
The name of the attached database configuration cluster
Id string
The provider-assigned unique ID for this managed resource.
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"
attachedDatabaseConfigurationName String
The name of the attached database configuration cluster
id String
The provider-assigned unique ID for this managed resource.
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"
attachedDatabaseConfigurationName string
The name of the attached database configuration cluster
id string
The provider-assigned unique ID for this managed resource.
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"
attached_database_configuration_name str
The name of the attached database configuration cluster
id str
The provider-assigned unique ID for this managed resource.
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"
attachedDatabaseConfigurationName String
The name of the attached database configuration cluster
id String
The provider-assigned unique ID for this managed resource.
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"

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