Microsoft.Synapse workspaces/kustoPools/databases

ARM template resource definition

The workspaces/kustoPools/databases resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Synapse/workspaces/kustoPools/databases resource, add the following JSON to your template.

{
  "type": "Microsoft.Synapse/workspaces/kustoPools/databases",
  "apiVersion": "2021-06-01-preview",
  "name": "string",
  "location": "string",
  "kind": "string",
  // For remaining properties, see workspaces/kustoPools/databases objects
}

workspaces/kustoPools/databases objects

Set the kind property to specify the type of object.

For ReadOnlyFollowing, use:

  "kind": "ReadOnlyFollowing"

For ReadWrite, use:

  "kind": "ReadWrite",
  "properties": {
    "hotCachePeriod": "string",
    "softDeletePeriod": "string"
  }

Property values

workspaces/kustoPools/databases

Name Description Value
type The resource type 'Microsoft.Synapse/workspaces/kustoPools/databases'
apiVersion The resource api version '2021-06-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
location Resource location. string
kind Set the object type ReadOnlyFollowing
ReadWrite (required)

ReadOnlyFollowingDatabase

Name Description Value
kind Kind of the database 'ReadOnlyFollowing' (required)

ReadWriteDatabase

Name Description Value
kind Kind of the database 'ReadWrite' (required)
properties The database properties. ReadWriteDatabaseProperties

ReadWriteDatabaseProperties

Name Description Value
hotCachePeriod The time the data should be kept in cache for fast queries in TimeSpan. string
softDeletePeriod The time the data should be kept before it stops being accessible to queries in TimeSpan. string