databases

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

Overview

Name	databases
Type	Resource
Id	azure.kusto.databases

Fields

The following fields are returned by SELECT queries:

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". (Invalid, AlreadyExists)

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_cluster

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
check_name_availability	select	resource_group_name, cluster_name, subscription_id		Checks that the databases resource name is valid and is not already in use.
get	select	resource_group_name, cluster_name, database_name, subscription_id		Returns a database.
list_by_cluster	select	resource_group_name, cluster_name, subscription_id	$top, $skiptoken	Returns the list of databases of the given Kusto cluster.
create_or_update	insert	resource_group_name, cluster_name, database_name, subscription_id, kind	callerRole	Creates or updates a database.
update	update	resource_group_name, cluster_name, database_name, subscription_id, kind	callerRole	Updates a database.
create_or_update	replace	resource_group_name, cluster_name, database_name, subscription_id, kind	callerRole	Creates or updates a database.
delete	delete	resource_group_name, cluster_name, database_name, subscription_id		Deletes the database with the given name.
list_principals	exec	resource_group_name, cluster_name, database_name, subscription_id		Returns a list of database principals of the given Kusto cluster and database.
add_principals	exec	resource_group_name, cluster_name, database_name, subscription_id		Add Database principals permissions.
remove_principals	exec	resource_group_name, cluster_name, database_name, subscription_id		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
cluster_name	string	The name of the Kusto cluster. Required.
database_name	string	The name of the database in the Kusto cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$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. Default value is None.
$top	integer	limit the number of results. Default value is None.
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. Known values are: "Admin" and "None". Default value is None.

SELECT examples

check_name_availability

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

SELECT
name,
message,
nameAvailable,
reason
FROM azure.kusto.databases
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Returns a database.

SELECT
id,
name,
kind,
location,
systemData,
type
FROM azure.kusto.databases
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_cluster

Returns the list of databases of the given Kusto cluster.

SELECT
id,
name,
kind,
location,
systemData,
type
FROM azure.kusto.databases
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create_or_update

Creates or updates a database.

INSERT INTO azure.kusto.databases (
location,
kind,
resource_group_name,
cluster_name,
database_name,
subscription_id,
callerRole
)
SELECT 
'{{ location }}',
'{{ kind }}' /* required */,
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ database_name }}',
'{{ subscription_id }}',
'{{ callerRole }}'
RETURNING
id,
name,
kind,
location,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: databases
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the databases resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the databases resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the databases resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the 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".
  - name: callerRole
    value: "{{ callerRole }}"
    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. Known values are: "Admin" and "None". Default value is None.
    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. Known values are: "Admin" and "None". Default value is None.

UPDATE examples

update

Updates a database.

UPDATE azure.kusto.databases
SET 
location = '{{ location }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND database_name = '{{ database_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND kind = '{{ kind }}' --required
AND callerRole = '{{ callerRole}}'
RETURNING
id,
name,
kind,
location,
systemData,
type;

REPLACE examples

create_or_update

Creates or updates a database.

REPLACE azure.kusto.databases
SET 
location = '{{ location }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND database_name = '{{ database_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND kind = '{{ kind }}' --required
AND callerRole = '{{ callerRole}}'
RETURNING
id,
name,
kind,
location,
systemData,
type;

DELETE examples

delete

Deletes the database with the given name.

DELETE FROM azure.kusto.databases
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND database_name = '{{ database_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_principals

Returns a list of database principals of the given Kusto cluster and database.

EXEC azure.kusto.databases.list_principals 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

add_principals

Add Database principals permissions.

EXEC azure.kusto.databases.add_principals 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"value": "{{ value }}"
}'
;

remove_principals

Remove Database principals permissions.

EXEC azure.kusto.databases.remove_principals 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"value": "{{ value }}"
}'
;