Microsoft.Synapse workspaces/kustoPools/databases

Bicep resource definition

The workspaces/kustoPools/databases resource type can be deployed to:

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 Bicep to your template.

resource symbolicname 'Microsoft.Synapse/workspaces/kustoPools/databases@2021-06-01-preview' = {
  name: 'string'
  location: 'string'
  kind: 'string'
  parent: resourceSymbolicName
  // 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
name The resource name

See how to set names and types for child resources in Bicep.
string (required)
location Resource location. string
kind Set the object type ReadOnlyFollowing
ReadWrite (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: kustoPools

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

ARM template resource definition

The workspaces/kustoPools/databases resource type can be deployed to:

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

Terraform (AzAPI provider) resource definition

The workspaces/kustoPools/databases resource type can be deployed to:

  • Resource groups

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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/kustoPools/databases@2021-06-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  // For remaining properties, see workspaces/kustoPools/databases objects
  body = jsonencode({
    kind = "string"
  })
}

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@2021-06-01-preview"
name The resource name string (required)
location Resource location. string
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: kustoPools
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