data_connections

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

Overview

Name	data_connections
Type	Resource
Id	azure.data_explorer.data_connections

Fields

Name	Datatype	Description
kind	string	Kind of the endpoint for the data connection
location	string	Resource location.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	clusterName, dataConnectionName, databaseName, resourceGroupName, subscriptionId	Returns a data connection.
list_by_database	SELECT	clusterName, databaseName, resourceGroupName, subscriptionId	Returns the list of data connections of the given Kusto database.
create_or_update	INSERT	clusterName, dataConnectionName, databaseName, resourceGroupName, subscriptionId, data__kind	Creates or updates a data connection.
delete	DELETE	clusterName, dataConnectionName, databaseName, resourceGroupName, subscriptionId	Deletes the data connection with the given name.
update	UPDATE	clusterName, dataConnectionName, databaseName, resourceGroupName, subscriptionId, data__kind	Updates a data connection.
check_name_availability	EXEC	clusterName, databaseName, resourceGroupName, subscriptionId, data__name, data__type	Checks that the data connection name is valid and is not already in use.
data_connection_validation	EXEC	clusterName, databaseName, resourceGroupName, subscriptionId	Checks that the data connection parameters are valid.

SELECT examples

Returns the list of data connections of the given Kusto database.

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

INSERT example

Use the following StackQL query and manifest file to create a new data_connections resource.

All Properties

/*+ create */
INSERT INTO azure.data_explorer.data_connections (
clusterName,
dataConnectionName,
databaseName,
resourceGroupName,
subscriptionId,
data__kind,
location,
kind
)
SELECT 
'{{ clusterName }}',
'{{ dataConnectionName }}',
'{{ databaseName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__kind }}',
'{{ location }}',
'{{ kind }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: kind
      value: string

UPDATE example

Updates a data_connections resource.

/*+ update */
UPDATE azure.data_explorer.data_connections
SET 
location = '{{ location }}',
kind = '{{ kind }}'
WHERE 
clusterName = '{{ clusterName }}'
AND dataConnectionName = '{{ dataConnectionName }}'
AND databaseName = '{{ databaseName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND data__kind = '{{ data__kind }}';

DELETE example

Deletes the specified data_connections resource.

/*+ delete */
DELETE FROM azure.data_explorer.data_connections
WHERE clusterName = '{{ clusterName }}'
AND dataConnectionName = '{{ dataConnectionName }}'
AND databaseName = '{{ databaseName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';