Microsoft.Kusto clusters 2019-05-15

Bicep resource definition

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

resource symbolicname 'Microsoft.Kusto/clusters@2019-05-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  properties: {
    enableDiskEncryption: bool
    enableStreamingIngest: bool
    optimizedAutoscale: {
      isEnabled: bool
      maximum: int
      minimum: int
      version: int
    }
    trustedExternalTenants: [
      {
        value: 'string'
      }
    ]
    virtualNetworkConfiguration: {
      dataManagementPublicIpId: 'string'
      enginePublicIpId: 'string'
      subnetId: 'string'
    }
  }
  zones: [
    'string'
  ]
}

Property values

clusters

Name Description Value
name The resource name string (required)

Character limit: 4-22

Valid characters:
Lowercase letters and numbers.

Start with letter.

Resource name must be unique across Azure.
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The SKU of the cluster. AzureSku (required)
properties The cluster properties. ClusterProperties
zones The availability zones of the cluster. string[]

ClusterProperties

Name Description Value
enableDiskEncryption A boolean value that indicates if the cluster's disks are encrypted. bool
enableStreamingIngest A boolean value that indicates if the streaming ingest is enabled. bool
optimizedAutoscale Optimized auto scale definition. OptimizedAutoscale
trustedExternalTenants The cluster's external tenants. TrustedExternalTenant[]
virtualNetworkConfiguration Virtual network definition. VirtualNetworkConfiguration

OptimizedAutoscale

Name Description Value
isEnabled A boolean value that indicate if the optimized autoscale feature is enabled or not. bool (required)
maximum Maximum allowed instances count. int (required)
minimum Minimum allowed instances count. int (required)
version The version of the template defined, for instance 1. int (required)

TrustedExternalTenant

Name Description Value
value GUID representing an external tenant. string

VirtualNetworkConfiguration

Name Description Value
dataManagementPublicIpId Data management's service public IP address resource id. string (required)
enginePublicIpId Engine service's public IP address resource id. string (required)
subnetId The subnet resource id. string (required)

AzureSku

Name Description Value
capacity The number of instances of the cluster. int
name SKU name. 'Dev(No SLA)_Standard_D11_v2'
'Standard_D11_v2'
'Standard_D12_v2'
'Standard_D13_v2'
'Standard_D14_v2'
'Standard_DS13_v2+1TB_PS'
'Standard_DS13_v2+2TB_PS'
'Standard_DS14_v2+3TB_PS'
'Standard_DS14_v2+4TB_PS'
'Standard_L16s'
'Standard_L4s'
'Standard_L8s' (required)
tier SKU tier. 'Basic'
'Standard' (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Digital Twins with Time Data History Connection

Deploy to Azure
This template creates an Azure Digital Twins instance configured with a time series data history connection. In order to create a connection, other resources must be created such as an Event Hubs namespace, an event hub, Azure Data Explorer cluster, and a database. Data is sent to an event hub which eventually forwards the data to the Azure Data Explorer cluster. Data is stored in a database table in the cluster
Create a cluster a database

Deploy to Azure
This template allows you to create a cluster and a database.
Deploy Azure Data Explorer DB with Cosmos DB connection

Deploy to Azure
Deploy Azure Data Explorer DB with Cosmos DB connection.
Deploy Azure Data Explorer db with Event Hub connection

Deploy to Azure
Deploy Azure Data Explorer db with Event Hub connection.
Deploy Azure Data Explorer cluster into your VNet

Deploy to Azure
This template allows you deploy a cluster into your VNet.

ARM template resource definition

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

{
  "type": "Microsoft.Kusto/clusters",
  "apiVersion": "2019-05-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "properties": {
    "enableDiskEncryption": "bool",
    "enableStreamingIngest": "bool",
    "optimizedAutoscale": {
      "isEnabled": "bool",
      "maximum": "int",
      "minimum": "int",
      "version": "int"
    },
    "trustedExternalTenants": [
      {
        "value": "string"
      }
    ],
    "virtualNetworkConfiguration": {
      "dataManagementPublicIpId": "string",
      "enginePublicIpId": "string",
      "subnetId": "string"
    }
  },
  "zones": [ "string" ]
}

Property values

clusters

Name Description Value
type The resource type 'Microsoft.Kusto/clusters'
apiVersion The resource api version '2019-05-15'
name The resource name string (required)

Character limit: 4-22

Valid characters:
Lowercase letters and numbers.

Start with letter.

Resource name must be unique across Azure.
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The SKU of the cluster. AzureSku (required)
properties The cluster properties. ClusterProperties
zones The availability zones of the cluster. string[]

ClusterProperties

Name Description Value
enableDiskEncryption A boolean value that indicates if the cluster's disks are encrypted. bool
enableStreamingIngest A boolean value that indicates if the streaming ingest is enabled. bool
optimizedAutoscale Optimized auto scale definition. OptimizedAutoscale
trustedExternalTenants The cluster's external tenants. TrustedExternalTenant[]
virtualNetworkConfiguration Virtual network definition. VirtualNetworkConfiguration

OptimizedAutoscale

Name Description Value
isEnabled A boolean value that indicate if the optimized autoscale feature is enabled or not. bool (required)
maximum Maximum allowed instances count. int (required)
minimum Minimum allowed instances count. int (required)
version The version of the template defined, for instance 1. int (required)

TrustedExternalTenant

Name Description Value
value GUID representing an external tenant. string

VirtualNetworkConfiguration

Name Description Value
dataManagementPublicIpId Data management's service public IP address resource id. string (required)
enginePublicIpId Engine service's public IP address resource id. string (required)
subnetId The subnet resource id. string (required)

AzureSku

Name Description Value
capacity The number of instances of the cluster. int
name SKU name. 'Dev(No SLA)_Standard_D11_v2'
'Standard_D11_v2'
'Standard_D12_v2'
'Standard_D13_v2'
'Standard_D14_v2'
'Standard_DS13_v2+1TB_PS'
'Standard_DS13_v2+2TB_PS'
'Standard_DS14_v2+3TB_PS'
'Standard_DS14_v2+4TB_PS'
'Standard_L16s'
'Standard_L4s'
'Standard_L8s' (required)
tier SKU tier. 'Basic'
'Standard' (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Digital Twins with Time Data History Connection

Deploy to Azure
This template creates an Azure Digital Twins instance configured with a time series data history connection. In order to create a connection, other resources must be created such as an Event Hubs namespace, an event hub, Azure Data Explorer cluster, and a database. Data is sent to an event hub which eventually forwards the data to the Azure Data Explorer cluster. Data is stored in a database table in the cluster
Create a cluster a database

Deploy to Azure
This template allows you to create a cluster and a database.
Deploy Azure Data Explorer DB with Cosmos DB connection

Deploy to Azure
Deploy Azure Data Explorer DB with Cosmos DB connection.
Deploy Azure Data Explorer db with Event Hub connection

Deploy to Azure
Deploy Azure Data Explorer db with Event Hub connection.
Deploy Azure Data Explorer cluster into your VNet

Deploy to Azure
This template allows you deploy a cluster into your VNet.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Kusto/clusters@2019-05-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      enableDiskEncryption = bool
      enableStreamingIngest = bool
      optimizedAutoscale = {
        isEnabled = bool
        maximum = int
        minimum = int
        version = int
      }
      trustedExternalTenants = [
        {
          value = "string"
        }
      ]
      virtualNetworkConfiguration = {
        dataManagementPublicIpId = "string"
        enginePublicIpId = "string"
        subnetId = "string"
      }
    }
    zones = [
      "string"
    ]
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  })
}

Property values

clusters

Name Description Value
type The resource type "Microsoft.Kusto/clusters@2019-05-15"
name The resource name string (required)

Character limit: 4-22

Valid characters:
Lowercase letters and numbers.

Start with letter.

Resource name must be unique across Azure.
location The geo-location where the resource lives string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
sku The SKU of the cluster. AzureSku (required)
properties The cluster properties. ClusterProperties
zones The availability zones of the cluster. string[]

ClusterProperties

Name Description Value
enableDiskEncryption A boolean value that indicates if the cluster's disks are encrypted. bool
enableStreamingIngest A boolean value that indicates if the streaming ingest is enabled. bool
optimizedAutoscale Optimized auto scale definition. OptimizedAutoscale
trustedExternalTenants The cluster's external tenants. TrustedExternalTenant[]
virtualNetworkConfiguration Virtual network definition. VirtualNetworkConfiguration

OptimizedAutoscale

Name Description Value
isEnabled A boolean value that indicate if the optimized autoscale feature is enabled or not. bool (required)
maximum Maximum allowed instances count. int (required)
minimum Minimum allowed instances count. int (required)
version The version of the template defined, for instance 1. int (required)

TrustedExternalTenant

Name Description Value
value GUID representing an external tenant. string

VirtualNetworkConfiguration

Name Description Value
dataManagementPublicIpId Data management's service public IP address resource id. string (required)
enginePublicIpId Engine service's public IP address resource id. string (required)
subnetId The subnet resource id. string (required)

AzureSku

Name Description Value
capacity The number of instances of the cluster. int
name SKU name. "Dev(No SLA)_Standard_D11_v2"
"Standard_D11_v2"
"Standard_D12_v2"
"Standard_D13_v2"
"Standard_D14_v2"
"Standard_DS13_v2+1TB_PS"
"Standard_DS13_v2+2TB_PS"
"Standard_DS14_v2+3TB_PS"
"Standard_DS14_v2+4TB_PS"
"Standard_L16s"
"Standard_L4s"
"Standard_L8s" (required)
tier SKU tier. "Basic"
"Standard" (required)