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

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.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.

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.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.

Methods

The following methods are available for this resource:

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

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
dataConnectionName	string	The name of the data connection.
databaseName	string	The name of the database in the Kusto pool.
kustoPoolName	string	The name of the Kusto pool.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Returns a data connection.

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

list_by_database

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

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

INSERT examples

create_or_update

Creates or updates a data connection.

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

Manifest

# Description fields are for documentation purposes
- name: kusto_pool_data_connections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the kusto_pool_data_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the kusto_pool_data_connections resource.
    - name: workspaceName
      value: string
      description: Required parameter for the kusto_pool_data_connections resource.
    - name: kustoPoolName
      value: string
      description: Required parameter for the kusto_pool_data_connections resource.
    - name: databaseName
      value: string
      description: Required parameter for the kusto_pool_data_connections resource.
    - name: dataConnectionName
      value: string
      description: Required parameter for the kusto_pool_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']

UPDATE examples

update

Updates a data connection.

UPDATE azure.synapse.kusto_pool_data_connections
SET 
data__location = '{{ location }}',
data__kind = '{{ kind }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND kustoPoolName = '{{ kustoPoolName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND dataConnectionName = '{{ dataConnectionName }}' --required
AND data__kind = '{{ kind }}' --required
RETURNING
kind,
location,
systemData;

DELETE examples

delete

Deletes the data connection with the given name.

DELETE FROM azure.synapse.kusto_pool_data_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND kustoPoolName = '{{ kustoPoolName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND dataConnectionName = '{{ dataConnectionName }}' --required
;

Lifecycle Methods

check_name_availability

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

EXEC azure.synapse.kusto_pool_data_connections.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@kustoPoolName='{{ kustoPoolName }}' --required, 
@databaseName='{{ databaseName }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;

data_connection_validation

Checks that the data connection parameters are valid.

EXEC azure.synapse.kusto_pool_data_connections.data_connection_validation 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@kustoPoolName='{{ kustoPoolName }}' --required, 
@databaseName='{{ databaseName }}' --required 
@@json=
'{
"dataConnectionName": "{{ dataConnectionName }}", 
"properties": "{{ properties }}"
}'
;