Microsoft.Synapse workspaces/kustoPools

ARM template resource definition

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

{
  "type": "Microsoft.Synapse/workspaces/kustoPools",
  "apiVersion": "2021-06-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "size": "string"
  },
  "properties": {
    "enablePurge": "bool",
    "enableStreamingIngest": "bool",
    "optimizedAutoscale": {
      "isEnabled": "bool",
      "maximum": "int",
      "minimum": "int",
      "version": "int"
    },
    "workspaceUID": "string"
  }
}

Property values

workspaces/kustoPools

Name Description Value
type The resource type 'Microsoft.Synapse/workspaces/kustoPools'
apiVersion The resource api version '2021-06-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
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 The SKU of the kusto pool. AzureSku (required)
properties The kusto pool properties. KustoPoolProperties

KustoPoolProperties

Name Description Value
enablePurge A boolean value that indicates if the purge operations are enabled. bool
enableStreamingIngest A boolean value that indicates if the streaming ingest is enabled. bool
optimizedAutoscale Optimized auto scale definition. OptimizedAutoscale
workspaceUID The workspace unique identifier. string

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)

AzureSku

Name Description Value
capacity The number of instances of the cluster. int
name SKU name. 'Compute optimized'
'Storage optimized' (required)
size SKU size. 'Extra small'
'Large'
'Medium'
'Small' (required)