kusto_pools

Creates, updates, deletes, gets or lists a kusto_pools resource.

Overview

Name	kusto_pools
Type	Resource
Id	azure.synapse.kusto_pools

Fields

The following fields are returned by SELECT queries:

get

The Kusto pool.

Name	Datatype	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	The geo-location where the resource lives
properties	object	The kusto pool properties.
sku	object	The SKU of the kusto pool.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.

list_by_workspace

List of Kusto pools under the Workspace.

Name	Datatype	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	The geo-location where the resource lives
properties	object	The kusto pool properties.
sku	object	The SKU of the kusto pool.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	workspaceName, kustoPoolName, subscriptionId, resourceGroupName		Gets a Kusto pool.
list_by_workspace	select	resourceGroupName, subscriptionId, workspaceName		List all Kusto pools
create_or_update	insert	workspaceName, resourceGroupName, kustoPoolName, subscriptionId, data__sku	If-Match, If-None-Match	Create or update a Kusto pool.
update	update	workspaceName, resourceGroupName, kustoPoolName, subscriptionId	If-Match	Update a Kusto Kusto Pool.
delete	delete	workspaceName, resourceGroupName, kustoPoolName, subscriptionId		Deletes a Kusto pool.
check_name_availability	exec	subscriptionId, location, name, type		Checks that the kusto pool name is valid and is not already in use.
stop	exec	workspaceName, kustoPoolName, subscriptionId, resourceGroupName		Stops a Kusto pool.
start	exec	workspaceName, kustoPoolName, subscriptionId, resourceGroupName		Starts a Kusto pool.
add_language_extensions	exec	workspaceName, kustoPoolName, subscriptionId, resourceGroupName		Add a list of language extensions that can run within KQL queries.
remove_language_extensions	exec	workspaceName, kustoPoolName, subscriptionId, resourceGroupName		Remove a list of language extensions that can run within KQL queries.
detach_follower_databases	exec	workspaceName, kustoPoolName, subscriptionId, resourceGroupName, clusterResourceId, attachedDatabaseConfigurationName		Detaches all followers of a database owned by this Kusto Pool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
kustoPoolName	string	The name of the Kusto pool.
location	string	The name of Azure region.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.
If-Match	string	The ETag of the Kusto Pool. Omit this value to always overwrite the current Kusto Pool. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
If-None-Match	string	Set to '*' to allow a new Kusto Pool to be created, but to prevent updating an existing Kusto Pool. Other values will result in a 412 Pre-condition Failed response.

SELECT examples

get

Gets a Kusto pool.

SELECT
etag,
location,
properties,
sku,
systemData,
tags
FROM azure.synapse.kusto_pools
WHERE workspaceName = '{{ workspaceName }}' -- required
AND kustoPoolName = '{{ kustoPoolName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_workspace

List all Kusto pools

SELECT
etag,
location,
properties,
sku,
systemData,
tags
FROM azure.synapse.kusto_pools
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

INSERT examples

create_or_update

Create or update a Kusto pool.

INSERT INTO azure.synapse.kusto_pools (
data__sku,
data__properties,
data__tags,
data__location,
workspaceName,
resourceGroupName,
kustoPoolName,
subscriptionId,
If-Match,
If-None-Match
)
SELECT 
'{{ sku }}' /* required */,
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ workspaceName }}',
'{{ resourceGroupName }}',
'{{ kustoPoolName }}',
'{{ subscriptionId }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
etag,
location,
properties,
sku,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: kusto_pools
  props:
    - name: workspaceName
      value: string
      description: Required parameter for the kusto_pools resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the kusto_pools resource.
    - name: kustoPoolName
      value: string
      description: Required parameter for the kusto_pools resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the kusto_pools resource.
    - name: sku
      value: object
      description: |
        The SKU of the kusto pool.
    - name: properties
      value: object
      description: |
        The kusto pool properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: If-Match
      value: string
      description: The ETag of the Kusto Pool. Omit this value to always overwrite the current Kusto Pool. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
    - name: If-None-Match
      value: string
      description: Set to '*' to allow a new Kusto Pool to be created, but to prevent updating an existing Kusto Pool. Other values will result in a 412 Pre-condition Failed response.

UPDATE examples

update

Update a Kusto Kusto Pool.

UPDATE azure.synapse.kusto_pools
SET 
data__tags = '{{ tags }}',
data__sku = '{{ sku }}',
data__properties = '{{ properties }}'
WHERE 
workspaceName = '{{ workspaceName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND kustoPoolName = '{{ kustoPoolName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
etag,
location,
properties,
sku,
systemData,
tags;

DELETE examples

delete

Deletes a Kusto pool.

DELETE FROM azure.synapse.kusto_pools
WHERE workspaceName = '{{ workspaceName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND kustoPoolName = '{{ kustoPoolName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

check_name_availability

Checks that the kusto pool name is valid and is not already in use.

EXEC azure.synapse.kusto_pools.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@location='{{ location }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;

stop

Stops a Kusto pool.

EXEC azure.synapse.kusto_pools.stop 
@workspaceName='{{ workspaceName }}' --required, 
@kustoPoolName='{{ kustoPoolName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required
;

start

Starts a Kusto pool.

EXEC azure.synapse.kusto_pools.start 
@workspaceName='{{ workspaceName }}' --required, 
@kustoPoolName='{{ kustoPoolName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required
;

add_language_extensions

Add a list of language extensions that can run within KQL queries.

EXEC azure.synapse.kusto_pools.add_language_extensions 
@workspaceName='{{ workspaceName }}' --required, 
@kustoPoolName='{{ kustoPoolName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required 
@@json=
'{
"value": "{{ value }}"
}'
;

remove_language_extensions

Remove a list of language extensions that can run within KQL queries.

EXEC azure.synapse.kusto_pools.remove_language_extensions 
@workspaceName='{{ workspaceName }}' --required, 
@kustoPoolName='{{ kustoPoolName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required 
@@json=
'{
"value": "{{ value }}"
}'
;

detach_follower_databases

Detaches all followers of a database owned by this Kusto Pool.

EXEC azure.synapse.kusto_pools.detach_follower_databases 
@workspaceName='{{ workspaceName }}' --required, 
@kustoPoolName='{{ kustoPoolName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required 
@@json=
'{
"clusterResourceId": "{{ clusterResourceId }}", 
"attachedDatabaseConfigurationName": "{{ attachedDatabaseConfigurationName }}"
}'
;