kusto_pool_data_connections

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

Overview

Name	kusto_pool_data_connections
Type	Resource
Id	azure.synapse.kusto_pool_data_connections

Fields

Name	Datatype	Description
kind	string	Kind of the endpoint for the data connection
location	string	Resource location.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

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

SELECT examples

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

SELECT
kind,
location,
systemData
FROM azure.synapse.kusto_pool_data_connections
WHERE databaseName = '{{ databaseName }}'
AND kustoPoolName = '{{ kustoPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.synapse.kusto_pool_data_connections (
dataConnectionName,
databaseName,
kustoPoolName,
resourceGroupName,
subscriptionId,
workspaceName,
data__kind,
location,
kind
)
SELECT 
'{{ dataConnectionName }}',
'{{ databaseName }}',
'{{ kustoPoolName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ data__kind }}',
'{{ location }}',
'{{ kind }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: kind
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

UPDATE example

Updates a kusto_pool_data_connections resource.

/*+ update */
UPDATE azure.synapse.kusto_pool_data_connections
SET 
location = '{{ location }}',
kind = '{{ kind }}'
WHERE 
dataConnectionName = '{{ dataConnectionName }}'
AND databaseName = '{{ databaseName }}'
AND kustoPoolName = '{{ kustoPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}'
AND data__kind = '{{ data__kind }}';

DELETE example

Deletes the specified kusto_pool_data_connections resource.

/*+ delete */
DELETE FROM azure.synapse.kusto_pool_data_connections
WHERE dataConnectionName = '{{ dataConnectionName }}'
AND databaseName = '{{ databaseName }}'
AND kustoPoolName = '{{ kustoPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';