Microsoft.Kusto clusters 2018-09-07-preview
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@2018-09-07-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
tier: 'Standard'
}
properties: {
trustedExternalTenants: [
{
value: '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 | Class representing the Kusto cluster properties. | ClusterProperties |
ClusterProperties
| Name | Description | Value |
|---|---|---|
| trustedExternalTenants | The cluster's external tenants. | TrustedExternalTenant[] |
TrustedExternalTenant
| Name | Description | Value |
|---|---|---|
| value | GUID representing an external tenant. | string |
AzureSku
| Name | Description | Value |
|---|---|---|
| capacity | SKU capacity. | int |
| name | SKU name. | 'D13_v2' 'D14_v2' 'KC16' 'KC8' 'KS16' 'KS8' 'L16' 'L8' (required) |
| tier | SKU tier. | 'Standard' (required) |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create a database watcher |
This sample creates a database watcher for Azure SQL and configures its data store, SQL targets, and managed private endpoints |
| 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. |
| 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. |
| Deploy Azure Data Explorer cluster into your VNet |
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:
- 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": "2018-09-07-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "Standard"
},
"properties": {
"trustedExternalTenants": [
{
"value": "string"
}
]
}
}
Property values
clusters
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Kusto/clusters' |
| apiVersion | The resource api version | '2018-09-07-preview' |
| 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 | Class representing the Kusto cluster properties. | ClusterProperties |
ClusterProperties
| Name | Description | Value |
|---|---|---|
| trustedExternalTenants | The cluster's external tenants. | TrustedExternalTenant[] |
TrustedExternalTenant
| Name | Description | Value |
|---|---|---|
| value | GUID representing an external tenant. | string |
AzureSku
| Name | Description | Value |
|---|---|---|
| capacity | SKU capacity. | int |
| name | SKU name. | 'D13_v2' 'D14_v2' 'KC16' 'KC8' 'KS16' 'KS8' 'L16' 'L8' (required) |
| tier | SKU tier. | 'Standard' (required) |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create a database watcher |
This sample creates a database watcher for Azure SQL and configures its data store, SQL targets, and managed private endpoints |
| 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. |
| 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. |
| Deploy Azure Data Explorer cluster into your VNet |
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@2018-09-07-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
trustedExternalTenants = [
{
value = "string"
}
]
}
sku = {
capacity = int
name = "string"
tier = "Standard"
}
})
}
Property values
clusters
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Kusto/clusters@2018-09-07-preview" |
| 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 | Class representing the Kusto cluster properties. | ClusterProperties |
ClusterProperties
| Name | Description | Value |
|---|---|---|
| trustedExternalTenants | The cluster's external tenants. | TrustedExternalTenant[] |
TrustedExternalTenant
| Name | Description | Value |
|---|---|---|
| value | GUID representing an external tenant. | string |
AzureSku
| Name | Description | Value |
|---|---|---|
| capacity | SKU capacity. | int |
| name | SKU name. | "D13_v2" "D14_v2" "KC16" "KC8" "KS16" "KS8" "L16" "L8" (required) |
| tier | SKU tier. | "Standard" (required) |