Microsoft.Kusto clusters template reference

Template format

To create a Microsoft.Kusto/clusters resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Kusto/clusters",
  "apiVersion": "2020-06-14",
  "tags": {},
  "location": "string",
  "sku": {
    "name": "string",
    "capacity": "integer",
    "tier": "string"
  },
  "zones": [
    "string"
  ],
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "trustedExternalTenants": [
      {
        "value": "string"
      }
    ],
    "optimizedAutoscale": {
      "version": "integer",
      "isEnabled": "boolean",
      "minimum": "integer",
      "maximum": "integer"
    },
    "enableDiskEncryption": "boolean",
    "enableStreamingIngest": "boolean",
    "virtualNetworkConfiguration": {
      "subnetId": "string",
      "enginePublicIpId": "string",
      "dataManagementPublicIpId": "string"
    },
    "keyVaultProperties": {
      "keyName": "string",
      "keyVersion": "string",
      "keyVaultUri": "string"
    },
    "enablePurge": "boolean",
    "enableDoubleEncryption": "boolean"
  },
  "resources": []
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Kusto/clusters object

Name Type Required Value
name string Yes The name of the Kusto cluster.
type enum Yes Microsoft.Kusto/clusters
apiVersion enum Yes 2020-06-14
tags object No Resource tags.
location string Yes The geo-location where the resource lives
sku object Yes The SKU of the cluster. - AzureSku object
zones array No The availability zones of the cluster. - string
identity object No The identity of the cluster, if configured. - Identity object
properties object Yes The cluster properties. - ClusterProperties object
resources array No attachedDatabaseConfigurations databases principalAssignments

AzureSku object

Name Type Required Value
name enum Yes SKU name. - Standard_DS13_v2+1TB_PS, Standard_DS13_v2+2TB_PS, Standard_DS14_v2+3TB_PS, Standard_DS14_v2+4TB_PS, Standard_D13_v2, Standard_D14_v2, Standard_L8s, Standard_L16s, Standard_D11_v2, Standard_D12_v2, Standard_L4s, Dev(No SLA)_Standard_D11_v2, Standard_E2a_v4, Standard_E4a_v4, Standard_E8a_v4, Standard_E16a_v4, Standard_E8as_v4+1TB_PS, Standard_E8as_v4+2TB_PS, Standard_E16as_v4+3TB_PS, Standard_E16as_v4+4TB_PS, Dev(No SLA)_Standard_E2a_v4
capacity integer No The number of instances of the cluster.
tier enum Yes SKU tier. - Basic or Standard

Identity object

Name Type Required Value
type enum Yes The identity type. - None or SystemAssigned
userAssignedIdentities object No The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ClusterProperties object

Name Type Required Value
trustedExternalTenants array No The cluster's external tenants. - TrustedExternalTenant object
optimizedAutoscale object No Optimized auto scale definition. - OptimizedAutoscale object
enableDiskEncryption boolean No A boolean value that indicates if the cluster's disks are encrypted.
enableStreamingIngest boolean No A boolean value that indicates if the streaming ingest is enabled.
virtualNetworkConfiguration object No Virtual network definition. - VirtualNetworkConfiguration object
keyVaultProperties object No KeyVault properties for the cluster encryption. - KeyVaultProperties object
enablePurge boolean No A boolean value that indicates if the purge operations are enabled.
enableDoubleEncryption boolean No A boolean value that indicates if double encryption is enabled.

TrustedExternalTenant object

Name Type Required Value
value string No GUID representing an external tenant.

OptimizedAutoscale object

Name Type Required Value
version integer Yes The version of the template defined, for instance 1.
isEnabled boolean Yes A boolean value that indicate if the optimized autoscale feature is enabled or not.
minimum integer Yes Minimum allowed instances count.
maximum integer Yes Maximum allowed instances count.

VirtualNetworkConfiguration object

Name Type Required Value
subnetId string Yes The subnet resource id.
enginePublicIpId string Yes Engine service's public IP address resource id.
dataManagementPublicIpId string Yes Data management's service public IP address resource id.

KeyVaultProperties object

Name Type Required Value
keyName string Yes The name of the key vault key.
keyVersion string Yes The version of the key vault key.
keyVaultUri string Yes The Uri of the key vault.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a cluster a database

Deploy to Azure
This template allows you to create a cluster a database.
Deploy Azure Data Explorer cluster into your VNet.

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