Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The workspaces/kustoPools 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.Synapse/workspaces/kustoPools resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Synapse/workspaces/kustoPools@2021-06-01-preview' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
enablePurge: bool
enableStreamingIngest: bool
optimizedAutoscale: {
isEnabled: bool
maximum: int
minimum: int
version: int
}
workspaceUID: 'string'
}
sku: {
capacity: int
name: 'string'
size: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Synapse/workspaces/kustoPools
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: workspaces |
| properties | The kusto pool properties. | KustoPoolProperties |
| sku | The SKU of the kusto pool. | AzureSku (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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) |
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) |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The workspaces/kustoPools 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.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",
"properties": {
"enablePurge": "bool",
"enableStreamingIngest": "bool",
"optimizedAutoscale": {
"isEnabled": "bool",
"maximum": "int",
"minimum": "int",
"version": "int"
},
"workspaceUID": "string"
},
"sku": {
"capacity": "int",
"name": "string",
"size": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Synapse/workspaces/kustoPools
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-06-01-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The kusto pool properties. | KustoPoolProperties |
| sku | The SKU of the kusto pool. | AzureSku (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Synapse/workspaces/kustoPools' |
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) |
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) |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The workspaces/kustoPools 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.Synapse/workspaces/kustoPools resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Synapse/workspaces/kustoPools@2021-06-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
enablePurge = bool
enableStreamingIngest = bool
optimizedAutoscale = {
isEnabled = bool
maximum = int
minimum = int
version = int
}
workspaceUID = "string"
}
sku = {
capacity = int
name = "string"
size = "string"
}
}
}
Property Values
Microsoft.Synapse/workspaces/kustoPools
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: workspaces |
| properties | The kusto pool properties. | KustoPoolProperties |
| sku | The SKU of the kusto pool. | AzureSku (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Synapse/workspaces/kustoPools@2021-06-01-preview" |
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) |
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) |
TrackedResourceTags
| Name | Description | Value |
|---|