Microsoft.Kusto clusters 2019-11-09

The clusters resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Kusto/clusters resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Kusto/clusters@2019-11-09' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'De
    tier: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    enableDiskEncryption: bool
    enableStreamingIngest: bool
    keyVaultProperties: {
      keyName: 'string'
      keyVaultUri: 'string'
      keyVersion: 'string'
    }
    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

For Bicep, set this value in the resource declaration.
'Microsoft.Kusto/clusters'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2019-11-09'
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku Azure SKU definition. AzureSku (required)
identity Identity for the resource. Identity
properties Class representing the Kusto cluster properties. ClusterProperties
zones An array represents the availability zones of the cluster. string[]

Identity

Name Description Value
type The identity type. 'None'
'SystemAssigned'
userAssignedIdentities 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}'. object

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
keyVaultProperties Properties of the key vault. KeyVaultProperties
optimizedAutoscale A class that contains the optimized auto scale definition. OptimizedAutoscale
trustedExternalTenants The cluster's external tenants. TrustedExternalTenant[]
virtualNetworkConfiguration A class that contains virtual network definition. VirtualNetworkConfiguration

KeyVaultProperties

Name Description Value
keyName The name of the key vault key. string (required)
keyVaultUri The Uri of the key vault. string (required)
keyVersion The version of the key vault key. string (required)

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. 'De
tier SKU tier. 'Basic'
'Standard'

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 and a database.
Deploy Azure Data Explorer cluster into your VNet.

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