kql_script

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

Overview

Name	kql_script
Type	Resource
Id	azure.synapse_artifacts.kql_script

Fields

The following fields are returned by SELECT queries:

get_by_name

Name	Datatype	Description
id	string	:vartype id: str
name	string	:vartype name: str
content	object	:vartype content: ~azure.synapse.artifacts.models.KqlScriptContent
type	string	:vartype type: str

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_name	select	kql_script_name, endpoint		Get KQL script by name.
create_or_update	insert	kql_script_name, endpoint		Creates or updates a KQL Script.
create_or_update	replace	kql_script_name, endpoint		Creates or updates a KQL Script.
delete_by_name	delete	kql_script_name, endpoint		Delete KQL script by name.
rename	exec	kql_script_name, endpoint		Rename KQL script.

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
endpoint	string	The service endpoint host (no scheme). (default: )
kql_script_name	string	KQL script name. Required.

SELECT examples

get_by_name

Get KQL script by name.

SELECT
id,
name,
content,
type
FROM azure.synapse_artifacts.kql_script
WHERE kql_script_name = '{{ kql_script_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_or_update

Creates or updates a KQL Script.

INSERT INTO azure.synapse_artifacts.kql_script (
id,
name,
type,
properties,
kql_script_name,
endpoint
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ type }}',
'{{ properties }}',
'{{ kql_script_name }}',
'{{ endpoint }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: kql_script
props:
  - name: kql_script_name
    value: "{{ kql_script_name }}"
    description: Required parameter for the kql_script resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the kql_script resource.
  - name: id
    value: "{{ id }}"
    description: |
      :vartype id: str
  - name: name
    value: "{{ name }}"
    description: |
      :vartype name: str
  - name: type
    value: "{{ type }}"
    description: |
      :vartype type: str
  - name: properties
    description: |
      Properties of sql script.
    value:
      content:
        query: "{{ query }}"
        metadata:
          language: "{{ language }}"
        currentConnection:
          name: "{{ name }}"
          poolName: "{{ poolName }}"
          databaseName: "{{ databaseName }}"
          type: "{{ type }}"

REPLACE examples

create_or_update

Creates or updates a KQL Script.

REPLACE azure.synapse_artifacts.kql_script
SET 
id = '{{ id }}',
name = '{{ name }}',
type = '{{ type }}',
properties = '{{ properties }}'
WHERE 
kql_script_name = '{{ kql_script_name }}' --required
AND endpoint = '{{ endpoint }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete_by_name

Delete KQL script by name.

DELETE FROM azure.synapse_artifacts.kql_script
WHERE kql_script_name = '{{ kql_script_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

rename

Rename KQL script.

EXEC azure.synapse_artifacts.kql_script.rename 
@kql_script_name='{{ kql_script_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;