Microsoft.Kusto clusters/attachedDatabaseConfigurations 2021-08-27

• Latest
• 2023-08-15
• 2023-05-02
• 2022-12-29
• 2022-11-11
• 2022-07-07
• 2022-02-01
• 2021-08-27
• 2021-01-01
• 2020-09-18
• 2020-06-14
• 2020-02-15
• 2019-11-09
• 2019-09-07

Bicep resource definition

The clusters/attachedDatabaseConfigurations 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.Kusto/clusters/attachedDatabaseConfigurations resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2021-08-27' = {
  name: 'string'
  location: 'string'
  parent: resourceSymbolicName
  properties: {
    clusterResourceId: 'string'
    databaseName: 'string'
    defaultPrincipalsModificationKind: 'string'
    tableLevelSharingProperties: {
      externalTablesToExclude: [
        'string'
      ]
      externalTablesToInclude: [
        'string'
      ]
      materializedViewsToExclude: [
        'string'
      ]
      materializedViewsToInclude: [
        'string'
      ]
      tablesToExclude: [
        'string'
      ]
      tablesToInclude: [
        'string'
      ]
    }
  }
}

Property values

clusters/attachedDatabaseConfigurations

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
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: clusters
properties	The properties of the attached database configuration.	AttachedDatabaseConfigurationProperties

AttachedDatabaseConfigurationProperties

Name	Description	Value
clusterResourceId	The resource id of the cluster where the databases you would like to attach reside.	string (required)
databaseName	The name of the database which you would like to attach, use * if you want to follow all current and future databases.	string (required)
defaultPrincipalsModificationKind	The default principals modification kind	'None' 'Replace' 'Union' (required)
tableLevelSharingProperties	Table level sharing specifications	TableLevelSharingProperties

TableLevelSharingProperties

Name	Description	Value
externalTablesToExclude	List of external tables exclude from the follower database	string[]
externalTablesToInclude	List of external tables to include in the follower database	string[]
materializedViewsToExclude	List of materialized views exclude from the follower database	string[]
materializedViewsToInclude	List of materialized views to include in the follower database	string[]
tablesToExclude	List of tables to exclude from the follower database	string[]
tablesToInclude	List of tables to include in the follower database	string[]

ARM template resource definition

The clusters/attachedDatabaseConfigurations 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.Kusto/clusters/attachedDatabaseConfigurations resource, add the following JSON to your template.

{
  "type": "Microsoft.Kusto/clusters/attachedDatabaseConfigurations",
  "apiVersion": "2021-08-27",
  "name": "string",
  "location": "string",
  "properties": {
    "clusterResourceId": "string",
    "databaseName": "string",
    "defaultPrincipalsModificationKind": "string",
    "tableLevelSharingProperties": {
      "externalTablesToExclude": [ "string" ],
      "externalTablesToInclude": [ "string" ],
      "materializedViewsToExclude": [ "string" ],
      "materializedViewsToInclude": [ "string" ],
      "tablesToExclude": [ "string" ],
      "tablesToInclude": [ "string" ]
    }
  }
}

Property values

clusters/attachedDatabaseConfigurations

Name	Description	Value
type	The resource type	'Microsoft.Kusto/clusters/attachedDatabaseConfigurations'
apiVersion	The resource api version	'2021-08-27'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
location	Resource location.	string
properties	The properties of the attached database configuration.	AttachedDatabaseConfigurationProperties

AttachedDatabaseConfigurationProperties

Name	Description	Value
clusterResourceId	The resource id of the cluster where the databases you would like to attach reside.	string (required)
databaseName	The name of the database which you would like to attach, use * if you want to follow all current and future databases.	string (required)
defaultPrincipalsModificationKind	The default principals modification kind	'None' 'Replace' 'Union' (required)
tableLevelSharingProperties	Table level sharing specifications	TableLevelSharingProperties

TableLevelSharingProperties

Name	Description	Value
externalTablesToExclude	List of external tables exclude from the follower database	string[]
externalTablesToInclude	List of external tables to include in the follower database	string[]
materializedViewsToExclude	List of materialized views exclude from the follower database	string[]
materializedViewsToInclude	List of materialized views to include in the follower database	string[]
tablesToExclude	List of tables to exclude from the follower database	string[]
tablesToInclude	List of tables to include in the follower database	string[]

Terraform (AzAPI provider) resource definition

The clusters/attachedDatabaseConfigurations 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.Kusto/clusters/attachedDatabaseConfigurations resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2021-08-27"
  name = "string"
  location = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      clusterResourceId = "string"
      databaseName = "string"
      defaultPrincipalsModificationKind = "string"
      tableLevelSharingProperties = {
        externalTablesToExclude = [
          "string"
        ]
        externalTablesToInclude = [
          "string"
        ]
        materializedViewsToExclude = [
          "string"
        ]
        materializedViewsToInclude = [
          "string"
        ]
        tablesToExclude = [
          "string"
        ]
        tablesToInclude = [
          "string"
        ]
      }
    }
  })
}

Property values

clusters/attachedDatabaseConfigurations

Name	Description	Value
type	The resource type	"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2021-08-27"
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: clusters
properties	The properties of the attached database configuration.	AttachedDatabaseConfigurationProperties

AttachedDatabaseConfigurationProperties

Name	Description	Value
clusterResourceId	The resource id of the cluster where the databases you would like to attach reside.	string (required)
databaseName	The name of the database which you would like to attach, use * if you want to follow all current and future databases.	string (required)
defaultPrincipalsModificationKind	The default principals modification kind	"None" "Replace" "Union" (required)
tableLevelSharingProperties	Table level sharing specifications	TableLevelSharingProperties

TableLevelSharingProperties

Name	Description	Value
externalTablesToExclude	List of external tables exclude from the follower database	string[]
externalTablesToInclude	List of external tables to include in the follower database	string[]
materializedViewsToExclude	List of materialized views exclude from the follower database	string[]
materializedViewsToInclude	List of materialized views to include in the follower database	string[]
tablesToExclude	List of tables to exclude from the follower database	string[]
tablesToInclude	List of tables to include in the follower database	string[]