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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataIngestionUri	string	The Kusto Pool data ingestion URI.
enablePurge	boolean	A boolean value that indicates if the purge operations are enabled.
enableStreamingIngest	boolean	A boolean value that indicates if the streaming ingest is enabled.
etag	string	A unique read-only string that changes whenever the resource is updated.
languageExtensions	object	List of the Kusto Pool's language extensions.
location	string	The geo-location where the resource lives. Required.
optimizedAutoscale	object	Optimized auto scale definition.
provisioningState	string	The provisioned state of the resource. Known values are: "Running", "Creating", "Deleting", "Succeeded", "Failed", "Moving", and "Canceled".
sku	object	The SKU of the kusto pool. Required.
state	string	The state of the resource. Known values are: "Creating", "Unavailable", "Running", "Deleting", "Deleted", "Stopping", "Stopped", "Starting", and "Updating".
stateReason	string	The reason for the Kusto Pool's current state.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uri	string	The Kusto Pool URI.
workspaceUID	string	The workspace unique identifier.

check_name_availability

Name	Datatype	Description
name	string	The name that was checked.
message	string	Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
nameAvailable	boolean	Specifies a Boolean value that indicates if the name is available.
reason	string	Message providing the reason why the given name is invalid. Known values are: "Invalid" and "AlreadyExists".

list_by_workspace

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataIngestionUri	string	The Kusto Pool data ingestion URI.
enablePurge	boolean	A boolean value that indicates if the purge operations are enabled.
enableStreamingIngest	boolean	A boolean value that indicates if the streaming ingest is enabled.
etag	string	A unique read-only string that changes whenever the resource is updated.
languageExtensions	object	List of the Kusto Pool's language extensions.
location	string	The geo-location where the resource lives. Required.
optimizedAutoscale	object	Optimized auto scale definition.
provisioningState	string	The provisioned state of the resource. Known values are: "Running", "Creating", "Deleting", "Succeeded", "Failed", "Moving", and "Canceled".
sku	object	The SKU of the kusto pool. Required.
state	string	The state of the resource. Known values are: "Creating", "Unavailable", "Running", "Deleting", "Deleted", "Stopping", "Stopped", "Starting", and "Updating".
stateReason	string	The reason for the Kusto Pool's current state.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uri	string	The Kusto Pool URI.
workspaceUID	string	The workspace unique identifier.

list_skus

Name	Datatype	Description
name	string	The name of the SKU.
locationInfo	array	Locations and zones.
locations	array	The set of locations that the SKU is available.
resourceType	string	The resource type.
restrictions	array	The restrictions because of which SKU cannot be used.
size	string	The size of the SKU.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	workspace_name, kusto_pool_name, resource_group_name, subscription_id		Gets a Kusto pool.
check_name_availability	select	location, subscription_id		Checks that the kusto pool name is valid and is not already in use.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		List Kusto pools. List all Kusto pools.
list_skus	select	subscription_id		Lists eligible SKUs for Kusto Pool resource.
create_or_update	insert	workspace_name, resource_group_name, kusto_pool_name, subscription_id, location, sku	If-Match, If-None-Match	Create or update a Kusto pool.
update	update	workspace_name, resource_group_name, kusto_pool_name, subscription_id	If-Match	Update a Kusto Kusto Pool.
create_or_update	replace	workspace_name, resource_group_name, kusto_pool_name, subscription_id, location, sku	If-Match, If-None-Match	Create or update a Kusto pool.
delete	delete	workspace_name, resource_group_name, kusto_pool_name, subscription_id		Deletes a Kusto pool.
list_skus_by_resource	exec	workspace_name, kusto_pool_name, resource_group_name, subscription_id		Returns the SKUs available for the provided resource.
list_language_extensions	exec	workspace_name, kusto_pool_name, resource_group_name, subscription_id		Returns a list of language extensions that can run within KQL queries.
list_follower_databases	exec	workspace_name, kusto_pool_name, resource_group_name, subscription_id		Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool.
stop	exec	workspace_name, kusto_pool_name, resource_group_name, subscription_id		Stops a Kusto pool.
start	exec	workspace_name, kusto_pool_name, resource_group_name, subscription_id		Starts a Kusto pool.
add_language_extensions	exec	workspace_name, kusto_pool_name, resource_group_name, subscription_id		Add a list of language extensions that can run within KQL queries.
remove_language_extensions	exec	workspace_name, kusto_pool_name, resource_group_name, subscription_id		Remove a list of language extensions that can run within KQL queries.
detach_follower_databases	exec	workspace_name, kusto_pool_name, resource_group_name, subscription_id, 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
kusto_pool_name	string	The name of the Kusto pool. Required.
location	string	The name of Azure region. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.
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. Default value is None.
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. Default value is None.

SELECT examples

get

Gets a Kusto pool.

SELECT
id,
name,
dataIngestionUri,
enablePurge,
enableStreamingIngest,
etag,
languageExtensions,
location,
optimizedAutoscale,
provisioningState,
sku,
state,
stateReason,
systemData,
tags,
type,
uri,
workspaceUID
FROM azure.synapse.kusto_pools
WHERE workspace_name = '{{ workspace_name }}' -- required
AND kusto_pool_name = '{{ kusto_pool_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

check_name_availability

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

SELECT
name,
message,
nameAvailable,
reason
FROM azure.synapse.kusto_pools
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

List Kusto pools. List all Kusto pools.

SELECT
id,
name,
dataIngestionUri,
enablePurge,
enableStreamingIngest,
etag,
languageExtensions,
location,
optimizedAutoscale,
provisioningState,
sku,
state,
stateReason,
systemData,
tags,
type,
uri,
workspaceUID
FROM azure.synapse.kusto_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_skus

Lists eligible SKUs for Kusto Pool resource.

SELECT
name,
locationInfo,
locations,
resourceType,
restrictions,
size
FROM azure.synapse.kusto_pools
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a Kusto pool.

INSERT INTO azure.synapse.kusto_pools (
tags,
location,
sku,
properties,
workspace_name,
resource_group_name,
kusto_pool_name,
subscription_id,
If-Match,
If-None-Match
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ sku }}' /* required */,
'{{ properties }}',
'{{ workspace_name }}',
'{{ resource_group_name }}',
'{{ kusto_pool_name }}',
'{{ subscription_id }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: kusto_pools
props:
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the kusto_pools resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the kusto_pools resource.
  - name: kusto_pool_name
    value: "{{ kusto_pool_name }}"
    description: Required parameter for the kusto_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the kusto_pools resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: sku
    description: |
      The SKU of the kusto pool. Required.
    value:
      name: "{{ name }}"
      capacity: {{ capacity }}
      size: "{{ size }}"
  - name: properties
    value:
      optimizedAutoscale:
        version: {{ version }}
        isEnabled: {{ isEnabled }}
        minimum: {{ minimum }}
        maximum: {{ maximum }}
      enableStreamingIngest: {{ enableStreamingIngest }}
      enablePurge: {{ enablePurge }}
      workspaceUID: "{{ workspaceUID }}"
  - name: If-Match
    value: "{{ If-Match }}"
    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. Default value is None.
    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. Default value is None.
  - name: If-None-Match
    value: "{{ If-None-Match }}"
    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. Default value is None.
    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. Default value is None.

UPDATE examples

update

Update a Kusto Kusto Pool.

UPDATE azure.synapse.kusto_pools
SET 
tags = '{{ tags }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
workspace_name = '{{ workspace_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND kusto_pool_name = '{{ kusto_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a Kusto pool.

REPLACE azure.synapse.kusto_pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
workspace_name = '{{ workspace_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND kusto_pool_name = '{{ kusto_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND sku = '{{ sku }}' --required
AND If-Match = '{{ If-Match}}'
AND If-None-Match = '{{ If-None-Match}}'
RETURNING
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes a Kusto pool.

DELETE FROM azure.synapse.kusto_pools
WHERE workspace_name = '{{ workspace_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND kusto_pool_name = '{{ kusto_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_skus_by_resource

Returns the SKUs available for the provided resource.

EXEC azure.synapse.kusto_pools.list_skus_by_resource 
@workspace_name='{{ workspace_name }}' --required, 
@kusto_pool_name='{{ kusto_pool_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_language_extensions

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

EXEC azure.synapse.kusto_pools.list_language_extensions 
@workspace_name='{{ workspace_name }}' --required, 
@kusto_pool_name='{{ kusto_pool_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_follower_databases

Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool.

EXEC azure.synapse.kusto_pools.list_follower_databases 
@workspace_name='{{ workspace_name }}' --required, 
@kusto_pool_name='{{ kusto_pool_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

Stops a Kusto pool.

EXEC azure.synapse.kusto_pools.stop 
@workspace_name='{{ workspace_name }}' --required, 
@kusto_pool_name='{{ kusto_pool_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

start

Starts a Kusto pool.

EXEC azure.synapse.kusto_pools.start 
@workspace_name='{{ workspace_name }}' --required, 
@kusto_pool_name='{{ kusto_pool_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

add_language_extensions

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

EXEC azure.synapse.kusto_pools.add_language_extensions 
@workspace_name='{{ workspace_name }}' --required, 
@kusto_pool_name='{{ kusto_pool_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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 
@workspace_name='{{ workspace_name }}' --required, 
@kusto_pool_name='{{ kusto_pool_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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 
@workspace_name='{{ workspace_name }}' --required, 
@kusto_pool_name='{{ kusto_pool_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"clusterResourceId": "{{ clusterResourceId }}", 
"attachedDatabaseConfigurationName": "{{ attachedDatabaseConfigurationName }}"
}'
;