kusto_pools

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

Overview

Name	kusto_pools
Type	Resource
Id	azure.synapse.kusto_pools

Fields

vw_kusto_pools

Name	Datatype	Description
data_ingestion_uri	text	field from the properties object
enable_purge	text	field from the properties object
enable_streaming_ingest	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
kustoPoolName	text	field from the properties object
language_extensions	text	field from the properties object
location	text	The geo-location where the resource lives
optimized_autoscale	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	Azure SKU definition.
state	text	field from the properties object
state_reason	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.
uri	text	field from the properties object
workspaceName	text	field from the properties object
workspace_uid	text	field from the properties object

kusto_pools

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	Class representing the Kusto pool properties.
sku	object	Azure SKU definition.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	kustoPoolName, resourceGroupName, subscriptionId, workspaceName	Gets a Kusto pool.
list_by_workspace	SELECT	resourceGroupName, subscriptionId, workspaceName	List all Kusto pools
create_or_update	INSERT	kustoPoolName, resourceGroupName, subscriptionId, workspaceName, data__sku	Create or update a Kusto pool.
delete	DELETE	kustoPoolName, resourceGroupName, subscriptionId, workspaceName	Deletes a Kusto pool.
update	UPDATE	kustoPoolName, resourceGroupName, subscriptionId, workspaceName	Update a Kusto Kusto Pool.
add_language_extensions	EXEC	kustoPoolName, resourceGroupName, subscriptionId, workspaceName	Add a list of language extensions that can run within KQL queries.
check_name_availability	EXEC	location, subscriptionId, data__name, data__type	Checks that the kusto pool name is valid and is not already in use.
detach_follower_databases	EXEC	kustoPoolName, resourceGroupName, subscriptionId, workspaceName, data__attachedDatabaseConfigurationName, data__clusterResourceId	Detaches all followers of a database owned by this Kusto Pool.
remove_language_extensions	EXEC	kustoPoolName, resourceGroupName, subscriptionId, workspaceName	Remove a list of language extensions that can run within KQL queries.
start	EXEC	kustoPoolName, resourceGroupName, subscriptionId, workspaceName	Starts a Kusto pool.
stop	EXEC	kustoPoolName, resourceGroupName, subscriptionId, workspaceName	Stops a Kusto pool.

SELECT examples

List all Kusto pools

vw_kusto_pools

SELECT
data_ingestion_uri,
enable_purge,
enable_streaming_ingest,
etag,
kustoPoolName,
language_extensions,
location,
optimized_autoscale,
provisioning_state,
resourceGroupName,
sku,
state,
state_reason,
subscriptionId,
system_data,
tags,
uri,
workspaceName,
workspace_uid
FROM azure.synapse.vw_kusto_pools
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

kusto_pools

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

INSERT example

Use the following StackQL query and manifest file to create a new kusto_pools resource.

All Properties

/*+ create */
INSERT INTO azure.synapse.kusto_pools (
kustoPoolName,
resourceGroupName,
subscriptionId,
workspaceName,
data__sku,
sku,
properties,
tags,
location
)
SELECT 
'{{ kustoPoolName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ data__sku }}',
'{{ sku }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: sku
      value:
        - name: name
          value: string
        - name: capacity
          value: integer
        - name: size
          value: string
    - name: properties
      value:
        - name: state
          value: string
        - name: provisioningState
          value: []
        - name: uri
          value: string
        - name: dataIngestionUri
          value: string
        - name: stateReason
          value: string
        - name: optimizedAutoscale
          value:
            - name: version
              value: integer
            - name: isEnabled
              value: boolean
            - name: minimum
              value: integer
            - name: maximum
              value: integer
        - name: enableStreamingIngest
          value: boolean
        - name: enablePurge
          value: boolean
        - name: languageExtensions
          value:
            - name: value
              value:
                - - name: languageExtensionName
                    value: []
        - name: workspaceUID
          value: string
    - name: etag
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a kusto_pools resource.

/*+ update */
UPDATE azure.synapse.kusto_pools
SET 
tags = '{{ tags }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
kustoPoolName = '{{ kustoPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

DELETE example

Deletes the specified kusto_pools resource.

/*+ delete */
DELETE FROM azure.synapse.kusto_pools
WHERE kustoPoolName = '{{ kustoPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';