scripts

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

Overview

Name	scripts
Type	Resource
Id	azure.data_explorer.scripts

Fields

The following fields are returned by SELECT queries:

get

The Kusto cluster database script object.

Name	Datatype	Description
properties	object	The database script.
systemData	object	Metadata pertaining to creation and last modification of the resource.

list_by_database

The list result of Kusto database scripts.

Name	Datatype	Description
properties	object	The database script.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, databaseName, scriptName		Gets a Kusto cluster database script.
list_by_database	select	subscriptionId, resourceGroupName, clusterName, databaseName		Returns the list of database scripts for given database.
create_or_update	insert	subscriptionId, resourceGroupName, clusterName, databaseName, scriptName		Creates a Kusto database script.
update	update	subscriptionId, resourceGroupName, clusterName, databaseName, scriptName		Updates a database script.
delete	delete	subscriptionId, resourceGroupName, clusterName, databaseName, scriptName		Deletes a Kusto database script.
check_name_availability	exec	resourceGroupName, clusterName, databaseName, subscriptionId, name, type		Checks that the script name is valid and is not already in use.

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.
scriptName	string	The name of the Kusto database script.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a Kusto cluster database script.

SELECT
properties,
systemData
FROM azure.data_explorer.scripts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND scriptName = '{{ scriptName }}' -- required
;

list_by_database

Returns the list of database scripts for given database.

SELECT
properties,
systemData
FROM azure.data_explorer.scripts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
;

INSERT examples

create_or_update

Creates a Kusto database script.

INSERT INTO azure.data_explorer.scripts (
data__properties,
subscriptionId,
resourceGroupName,
clusterName,
databaseName,
scriptName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ databaseName }}',
'{{ scriptName }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: scripts
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the scripts resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the scripts resource.
    - name: clusterName
      value: string
      description: Required parameter for the scripts resource.
    - name: databaseName
      value: string
      description: Required parameter for the scripts resource.
    - name: scriptName
      value: string
      description: Required parameter for the scripts resource.
    - name: properties
      value: object
      description: |
        The database script.

UPDATE examples

update

Updates a database script.

UPDATE azure.data_explorer.scripts
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND scriptName = '{{ scriptName }}' --required
RETURNING
properties,
systemData;

DELETE examples

delete

Deletes a Kusto database script.

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

Lifecycle Methods

check_name_availability

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

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