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

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified data connection.

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

list_by_database

Successfully retrieved the list of data connections.

Name	Datatype	Description
kind	string	Kind of the endpoint for the data connection
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, dataConnectionName, subscriptionId		Returns a data connection.
list_by_database	select	resourceGroupName, clusterName, databaseName, subscriptionId		Returns the list of data connections of the given Kusto database.
create_or_update	insert	resourceGroupName, clusterName, databaseName, dataConnectionName, subscriptionId, data__kind		Creates or updates a data connection.
update	update	resourceGroupName, clusterName, databaseName, dataConnectionName, subscriptionId, data__kind		Updates a data connection.
delete	delete	resourceGroupName, clusterName, databaseName, dataConnectionName, subscriptionId		Deletes the data connection with the given name.
data_connection_validation	exec	resourceGroupName, clusterName, databaseName, subscriptionId		Checks that the data connection parameters are valid.
check_name_availability	exec	resourceGroupName, clusterName, databaseName, subscriptionId, name, type		Checks that the data connection 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.
dataConnectionName	string	The name of the data connection.
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.

SELECT examples

get

Returns a data connection.

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

list_by_database

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

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

INSERT examples

create_or_update

Creates or updates a data connection.

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

Manifest

# Description fields are for documentation purposes
- name: data_connections
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the data_connections resource.
    - name: clusterName
      value: string
      description: Required parameter for the data_connections resource.
    - name: databaseName
      value: string
      description: Required parameter for the data_connections resource.
    - name: dataConnectionName
      value: string
      description: Required parameter for the data_connections resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the data_connections resource.
    - name: location
      value: string
      description: |
        Resource location.
    - name: kind
      value: string
      description: |
        Kind of the endpoint for the data connection
      valid_values: ['EventHub', 'EventGrid', 'IotHub', 'CosmosDb']

UPDATE examples

update

Updates a data connection.

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

DELETE examples

delete

Deletes the data connection with the given name.

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

Lifecycle Methods

data_connection_validation

Checks that the data connection parameters are valid.

EXEC azure.data_explorer.data_connections.data_connection_validation 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"dataConnectionName": "{{ dataConnectionName }}", 
"properties": "{{ properties }}"
}'
;

check_name_availability

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

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