kusto_pool_databases

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

Overview

Name	kusto_pool_databases
Type	Resource
Id	azure.synapse.kusto_pool_databases

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified database.

Name	Datatype	Description
kind	string	Kind of the database
location	string	Resource location.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.

list_by_kusto_pool

Successfully retrieved the list of databases.

Name	Datatype	Description
kind	string	Kind of the database
location	string	Resource location.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, kustoPoolName, databaseName		Returns a database.
list_by_kusto_pool	select	subscriptionId, resourceGroupName, workspaceName, kustoPoolName		Returns the list of databases of the given Kusto pool.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, kustoPoolName, databaseName, data__kind		Creates or updates a database.
update	update	subscriptionId, resourceGroupName, workspaceName, kustoPoolName, databaseName, data__kind		Updates a database.
delete	delete	subscriptionId, resourceGroupName, workspaceName, kustoPoolName, databaseName		Deletes the database with the given name.

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
databaseName	string	The name of the database in the Kusto pool.
kustoPoolName	string	The name of the Kusto pool.
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.

SELECT examples

get

Returns a database.

SELECT
kind,
location,
systemData
FROM azure.synapse.kusto_pool_databases
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND kustoPoolName = '{{ kustoPoolName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
;

list_by_kusto_pool

Returns the list of databases of the given Kusto pool.

SELECT
kind,
location,
systemData
FROM azure.synapse.kusto_pool_databases
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND kustoPoolName = '{{ kustoPoolName }}' -- required
;

INSERT examples

create_or_update

Creates or updates a database.

INSERT INTO azure.synapse.kusto_pool_databases (
data__location,
data__kind,
subscriptionId,
resourceGroupName,
workspaceName,
kustoPoolName,
databaseName
)
SELECT 
'{{ location }}',
'{{ kind }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ kustoPoolName }}',
'{{ databaseName }}'
RETURNING
kind,
location,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: kusto_pool_databases
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the kusto_pool_databases resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the kusto_pool_databases resource.
    - name: workspaceName
      value: string
      description: Required parameter for the kusto_pool_databases resource.
    - name: kustoPoolName
      value: string
      description: Required parameter for the kusto_pool_databases resource.
    - name: databaseName
      value: string
      description: Required parameter for the kusto_pool_databases resource.
    - name: location
      value: string
      description: |
        Resource location.
    - name: kind
      value: string
      description: |
        Kind of the database
      valid_values: ['ReadWrite', 'ReadOnlyFollowing']

UPDATE examples

update

Updates a database.

UPDATE azure.synapse.kusto_pool_databases
SET 
data__location = '{{ location }}',
data__kind = '{{ kind }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND kustoPoolName = '{{ kustoPoolName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND data__kind = '{{ kind }}' --required
RETURNING
kind,
location,
systemData;

DELETE examples

delete

Deletes the database with the given name.

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