Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The workspaces/kustoPools/databases resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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' = {
location: 'string'
name: 'string'
kind: 'string'
// For remaining properties, see Microsoft.Synapse/workspaces/kustoPools/databases objects
}
Microsoft.Synapse/workspaces/kustoPools/databases objects
Set the kind property to specify the type of object.
For ReadOnlyFollowing, use:
{
kind: 'ReadOnlyFollowing'
properties: {
hotCachePeriod: 'string'
}
}
For ReadWrite, use:
{
kind: 'ReadWrite'
properties: {
hotCachePeriod: 'string'
softDeletePeriod: 'string'
}
}
Property Values
Microsoft.Synapse/workspaces/kustoPools/databases
| Name | Description | Value |
|---|---|---|
| kind | Set to 'ReadOnlyFollowing' for type ReadOnlyFollowingDatabase. Set to 'ReadWrite' for type ReadWriteDatabase. | 'ReadOnlyFollowing' 'ReadWrite' (required) |
| location | Resource location. | string |
| name | The resource name | string (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: workspaces/kustoPools |
ReadOnlyFollowingDatabase
| Name | Description | Value |
|---|---|---|
| kind | Kind of the database | 'ReadOnlyFollowing' (required) |
| properties | The database properties. | ReadOnlyFollowingDatabaseProperties |
ReadOnlyFollowingDatabaseProperties
| Name | Description | Value |
|---|---|---|
| hotCachePeriod | The time the data should be kept in cache for fast queries in TimeSpan. | string |
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 with operations that target:
- Resource groups - See resource group deployment commands
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.
{
"location": "string",
"name": "string",
"kind": "string"
// For remaining properties, see Microsoft.Synapse/workspaces/kustoPools/databases objects
}
Microsoft.Synapse/workspaces/kustoPools/databases objects
Set the kind property to specify the type of object.
For ReadOnlyFollowing, use:
{
"kind": "ReadOnlyFollowing",
"properties": {
"hotCachePeriod": "string"
}
}
For ReadWrite, use:
{
"kind": "ReadWrite",
"properties": {
"hotCachePeriod": "string",
"softDeletePeriod": "string"
}
}
Property Values
Microsoft.Synapse/workspaces/kustoPools/databases
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-06-01-preview' |
| kind | Set to 'ReadOnlyFollowing' for type ReadOnlyFollowingDatabase. Set to 'ReadWrite' for type ReadWriteDatabase. | 'ReadOnlyFollowing' 'ReadWrite' (required) |
| location | Resource location. | string |
| name | The resource name | string (required) |
| type | The resource type | 'Microsoft.Synapse/workspaces/kustoPools/databases' |
ReadOnlyFollowingDatabase
| Name | Description | Value |
|---|---|---|
| kind | Kind of the database | 'ReadOnlyFollowing' (required) |
| properties | The database properties. | ReadOnlyFollowingDatabaseProperties |
ReadOnlyFollowingDatabaseProperties
| Name | Description | Value |
|---|---|---|
| hotCachePeriod | The time the data should be kept in cache for fast queries in TimeSpan. | string |
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 |
Usage Examples
Terraform (AzAPI provider) resource definition
The workspaces/kustoPools/databases resource type can be deployed with operations that target:
- 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" {
location = "string"
name = "string"
kind = "string"
// For remaining properties, see Microsoft.Synapse/workspaces/kustoPools/databases objects
}
Microsoft.Synapse/workspaces/kustoPools/databases objects
Set the kind property to specify the type of object.
For ReadOnlyFollowing, use:
{
kind = "ReadOnlyFollowing"
properties = {
hotCachePeriod = "string"
}
}
For ReadWrite, use:
{
kind = "ReadWrite"
properties = {
hotCachePeriod = "string"
softDeletePeriod = "string"
}
}
Property Values
Microsoft.Synapse/workspaces/kustoPools/databases
| Name | Description | Value |
|---|---|---|
| kind | Set to 'ReadOnlyFollowing' for type ReadOnlyFollowingDatabase. Set to 'ReadWrite' for type ReadWriteDatabase. | 'ReadOnlyFollowing' 'ReadWrite' (required) |
| location | Resource location. | string |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: workspaces/kustoPools |
| type | The resource type | "Microsoft.Synapse/workspaces/kustoPools/databases@2021-06-01-preview" |
ReadOnlyFollowingDatabase
| Name | Description | Value |
|---|---|---|
| kind | Kind of the database | 'ReadOnlyFollowing' (required) |
| properties | The database properties. | ReadOnlyFollowingDatabaseProperties |
ReadOnlyFollowingDatabaseProperties
| Name | Description | Value |
|---|---|---|
| hotCachePeriod | The time the data should be kept in cache for fast queries in TimeSpan. | string |
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 |