databases

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

Overview

Name	databases
Type	Resource
Id	azure.data_explorer.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.

list_by_cluster

Successfully retrieved the list of databases.

Name	Datatype	Description
kind	string	Kind of the database
location	string	Resource location.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, clusterName, databaseName, subscriptionId		Returns a database.
list_by_cluster	select	resourceGroupName, clusterName, subscriptionId	$top, $skiptoken	Returns the list of databases of the given Kusto cluster.
create_or_update	insert	resourceGroupName, clusterName, databaseName, subscriptionId, data__kind	callerRole	Creates or updates a database.
update	update	resourceGroupName, clusterName, databaseName, subscriptionId, data__kind	callerRole	Updates a database.
delete	delete	resourceGroupName, clusterName, databaseName, subscriptionId		Deletes the database with the given name.
check_name_availability	exec	resourceGroupName, clusterName, subscriptionId, name, type		Checks that the databases resource name is valid and is not already in use.
invite_follower	exec	subscriptionId, resourceGroupName, clusterName, databaseName, inviteeEmail		Generates an invitation token that allows attaching a follower database to this database.
add_principals	exec	resourceGroupName, clusterName, databaseName, subscriptionId		Add Database principals permissions.
remove_principals	exec	resourceGroupName, clusterName, databaseName, subscriptionId		Remove Database principals permissions.

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
clusterName	string	The name of the Kusto cluster.
databaseName	string	The name of the database in the Kusto cluster.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$skiptoken	string	Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.
$top	integer (int32)	limit the number of results
callerRole	string	By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list.

SELECT examples

get

Returns a database.

SELECT
kind,
location
FROM azure.data_explorer.databases
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_cluster

Returns the list of databases of the given Kusto cluster.

SELECT
kind,
location
FROM azure.data_explorer.databases
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create_or_update

Creates or updates a database.

INSERT INTO azure.data_explorer.databases (
data__location,
data__kind,
resourceGroupName,
clusterName,
databaseName,
subscriptionId,
callerRole
)
SELECT 
'{{ location }}',
'{{ kind }}' /* required */,
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ databaseName }}',
'{{ subscriptionId }}',
'{{ callerRole }}'
RETURNING
kind,
location
;

Manifest

# Description fields are for documentation purposes
- name: databases
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the databases resource.
    - name: clusterName
      value: string
      description: Required parameter for the databases resource.
    - name: databaseName
      value: string
      description: Required parameter for the databases resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the databases resource.
    - name: location
      value: string
      description: |
        Resource location.
    - name: kind
      value: string
      description: |
        Kind of the database
      valid_values: ['ReadWrite', 'ReadOnlyFollowing']
    - name: callerRole
      value: string
      description: By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list.

UPDATE examples

update

Updates a database.

UPDATE azure.data_explorer.databases
SET 
data__location = '{{ location }}',
data__kind = '{{ kind }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND data__kind = '{{ kind }}' --required
AND callerRole = '{{ callerRole}}'
RETURNING
kind,
location;

DELETE examples

delete

Deletes the database with the given name.

DELETE FROM azure.data_explorer.databases
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

check_name_availability

Checks that the databases resource name is valid and is not already in use.

EXEC azure.data_explorer.databases.check_name_availability 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;

invite_follower

Generates an invitation token that allows attaching a follower database to this database.

EXEC azure.data_explorer.databases.invite_follower 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@databaseName='{{ databaseName }}' --required 
@@json=
'{
"inviteeEmail": "{{ inviteeEmail }}", 
"tableLevelSharingProperties": "{{ tableLevelSharingProperties }}"
}'
;

add_principals

Add Database principals permissions.

EXEC azure.data_explorer.databases.add_principals 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"value": "{{ value }}"
}'
;

remove_principals

Remove Database principals permissions.

EXEC azure.data_explorer.databases.remove_principals 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"value": "{{ value }}"
}'
;