Microsoft.Kusto clusters 2022-12-29

Bicep resource definition

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

resource symbolicname 'Microsoft.Kusto/clusters@2022-12-29' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    acceptedAudiences: [
      {
        value: 'string'
      }
    ]
    allowedFqdnList: [
      'string'
    ]
    allowedIpRangeList: [
      'string'
    ]
    enableAutoStop: bool
    enableDiskEncryption: bool
    enableDoubleEncryption: bool
    enablePurge: bool
    enableStreamingIngest: bool
    engineType: 'string'
    keyVaultProperties: {
      keyName: 'string'
      keyVaultUri: 'string'
      keyVersion: 'string'
      userIdentity: 'string'
    }
    languageExtensions: {
      value: [
        {
          languageExtensionImageName: 'string'
          languageExtensionName: 'string'
        }
      ]
    }
    optimizedAutoscale: {
      isEnabled: bool
      maximum: int
      minimum: int
      version: int
    }
    publicIPType: 'string'
    publicNetworkAccess: 'string'
    restrictOutboundNetworkAccess: 'string'
    trustedExternalTenants: [
      {
        value: 'string'
      }
    ]
    virtualClusterGraduationProperties: 'string'
    virtualNetworkConfiguration: {
      dataManagementPublicIpId: 'string'
      enginePublicIpId: 'string'
      subnetId: 'string'
    }
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Property values

AcceptedAudiences

AzureSku

ClusterProperties

ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties

Identity

IdentityUserAssignedIdentities

KeyVaultProperties

LanguageExtension

LanguageExtensionsList

Microsoft.Kusto/clusters

OptimizedAutoscale

TrackedResourceTags

TrustedExternalTenant

VirtualNetworkConfiguration

Quickstart samples

The following quickstart samples deploy this resource type.

ARM template resource definition

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

{
  "type": "Microsoft.Kusto/clusters",
  "apiVersion": "2022-12-29",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "acceptedAudiences": [
      {
        "value": "string"
      }
    ],
    "allowedFqdnList": [ "string" ],
    "allowedIpRangeList": [ "string" ],
    "enableAutoStop": "bool",
    "enableDiskEncryption": "bool",
    "enableDoubleEncryption": "bool",
    "enablePurge": "bool",
    "enableStreamingIngest": "bool",
    "engineType": "string",
    "keyVaultProperties": {
      "keyName": "string",
      "keyVaultUri": "string",
      "keyVersion": "string",
      "userIdentity": "string"
    },
    "languageExtensions": {
      "value": [
        {
          "languageExtensionImageName": "string",
          "languageExtensionName": "string"
        }
      ]
    },
    "optimizedAutoscale": {
      "isEnabled": "bool",
      "maximum": "int",
      "minimum": "int",
      "version": "int"
    },
    "publicIPType": "string",
    "publicNetworkAccess": "string",
    "restrictOutboundNetworkAccess": "string",
    "trustedExternalTenants": [
      {
        "value": "string"
      }
    ],
    "virtualClusterGraduationProperties": "string",
    "virtualNetworkConfiguration": {
      "dataManagementPublicIpId": "string",
      "enginePublicIpId": "string",
      "subnetId": "string"
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Property values

AcceptedAudiences

AzureSku

ClusterProperties

ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties

Identity

IdentityUserAssignedIdentities

KeyVaultProperties

LanguageExtension

LanguageExtensionsList

Microsoft.Kusto/clusters

OptimizedAutoscale

TrackedResourceTags

TrustedExternalTenant

VirtualNetworkConfiguration

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Azure Digital Twins with Time Data History Connection	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	This template allows you to create a cluster and a database.
Create a database watcher	This sample creates a database watcher for Azure SQL and configures its data store, SQL targets, and managed private endpoints
Deploy Azure Data Explorer cluster into your VNet	This template allows you deploy a cluster into your VNet.
Deploy Azure Data Explorer DB with Cosmos DB connection	Deploy Azure Data Explorer DB with Cosmos DB connection.
Deploy Azure Data Explorer db with Event Grid connection	Deploy Azure Data Explorer db with Event Grid connection.
Deploy Azure Data Explorer db with Event Hub connection	Deploy Azure Data Explorer db with Event Hub connection.

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@2022-12-29"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  zones = [
    "string"
  ]
  body = jsonencode({
    properties = {
      acceptedAudiences = [
        {
          value = "string"
        }
      ]
      allowedFqdnList = [
        "string"
      ]
      allowedIpRangeList = [
        "string"
      ]
      enableAutoStop = bool
      enableDiskEncryption = bool
      enableDoubleEncryption = bool
      enablePurge = bool
      enableStreamingIngest = bool
      engineType = "string"
      keyVaultProperties = {
        keyName = "string"
        keyVaultUri = "string"
        keyVersion = "string"
        userIdentity = "string"
      }
      languageExtensions = {
        value = [
          {
            languageExtensionImageName = "string"
            languageExtensionName = "string"
          }
        ]
      }
      optimizedAutoscale = {
        isEnabled = bool
        maximum = int
        minimum = int
        version = int
      }
      publicIPType = "string"
      publicNetworkAccess = "string"
      restrictOutboundNetworkAccess = "string"
      trustedExternalTenants = [
        {
          value = "string"
        }
      ]
      virtualClusterGraduationProperties = "string"
      virtualNetworkConfiguration = {
        dataManagementPublicIpId = "string"
        enginePublicIpId = "string"
        subnetId = "string"
      }
    }
  })
}

Property values

AcceptedAudiences

AzureSku

ClusterProperties

ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties

Identity

IdentityUserAssignedIdentities

KeyVaultProperties

LanguageExtension

LanguageExtensionsList

Microsoft.Kusto/clusters

OptimizedAutoscale

TrackedResourceTags

TrustedExternalTenant

VirtualNetworkConfiguration