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

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.
kind	string	Kind of the database. Required. Known values are: "ReadWrite" and "ReadOnlyFollowing".
location	string	Resource location.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_kusto_pool

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.
kind	string	Kind of the database. Required. Known values are: "ReadWrite" and "ReadOnlyFollowing".
location	string	Resource location.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, kusto_pool_name, database_name, subscription_id		Returns a database.
list_by_kusto_pool	select	resource_group_name, workspace_name, kusto_pool_name, subscription_id		Returns the list of databases of the given Kusto pool.
create_or_update	insert	resource_group_name, workspace_name, kusto_pool_name, database_name, subscription_id, kind		Creates or updates a database.
update	update	resource_group_name, workspace_name, kusto_pool_name, database_name, subscription_id, kind		Updates a database.
create_or_update	replace	resource_group_name, workspace_name, kusto_pool_name, database_name, subscription_id, kind		Creates or updates a database.
delete	delete	resource_group_name, workspace_name, kusto_pool_name, database_name, subscription_id		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
database_name	string	The name of the database in the Kusto pool. Required.
kusto_pool_name	string	The name of the Kusto pool. 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.

SELECT examples

get

Returns a database.

SELECT
id,
name,
kind,
location,
systemData,
type
FROM azure.synapse.kusto_pool_databases
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND kusto_pool_name = '{{ kusto_pool_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_kusto_pool

Returns the list of databases of the given Kusto pool.

SELECT
id,
name,
kind,
location,
systemData,
type
FROM azure.synapse.kusto_pool_databases
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND kusto_pool_name = '{{ kusto_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a database.

INSERT INTO azure.synapse.kusto_pool_databases (
location,
kind,
resource_group_name,
workspace_name,
kusto_pool_name,
database_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ kind }}' /* required */,
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ kusto_pool_name }}',
'{{ database_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
location,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: kusto_pool_databases
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the kusto_pool_databases resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the kusto_pool_databases resource.
  - name: kusto_pool_name
    value: "{{ kusto_pool_name }}"
    description: Required parameter for the kusto_pool_databases resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the kusto_pool_databases resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the kusto_pool_databases resource.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: kind
    value: "{{ kind }}"
    description: |
      Kind of the database. Required. Known values are: "ReadWrite" and "ReadOnlyFollowing".

UPDATE examples

update

Updates a database.

UPDATE azure.synapse.kusto_pool_databases
SET 
location = '{{ location }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND kusto_pool_name = '{{ kusto_pool_name }}' --required
AND database_name = '{{ database_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
kind,
location,
systemData,
type;

REPLACE examples

create_or_update

Creates or updates a database.

REPLACE azure.synapse.kusto_pool_databases
SET 
location = '{{ location }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND kusto_pool_name = '{{ kusto_pool_name }}' --required
AND database_name = '{{ database_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
kind,
location,
systemData,
type;

DELETE examples

delete

Deletes the database with the given name.

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