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:

check_name_availability

Name	Datatype	Description
name	string	The name that was checked.
message	string	Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
nameAvailable	boolean	Specifies a Boolean value that indicates if the name is available.
reason	string	Message providing the reason why the given name is invalid. Known values are: "Invalid" and "AlreadyExists".

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
kind	string	Kind of the endpoint for the data connection. Required. Known values are: "EventHub", "EventGrid", and "IotHub".
location	string	Resource location.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_database

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
kind	string	Kind of the endpoint for the data connection. Required. Known values are: "EventHub", "EventGrid", and "IotHub".
location	string	Resource location.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
check_name_availability	select	resource_group_name, workspace_name, kusto_pool_name, database_name, subscription_id		Checks that the data connection name is valid and is not already in use.
get	select	resource_group_name, workspace_name, kusto_pool_name, database_name, data_connection_name, subscription_id		Returns a data connection.
list_by_database	select	resource_group_name, workspace_name, kusto_pool_name, database_name, subscription_id		Returns the list of data connections of the given Kusto pool database.
create_or_update	insert	resource_group_name, workspace_name, kusto_pool_name, database_name, data_connection_name, subscription_id, kind		Creates or updates a data connection.
update	update	resource_group_name, workspace_name, kusto_pool_name, database_name, data_connection_name, subscription_id, kind		Updates a data connection.
create_or_update	replace	resource_group_name, workspace_name, kusto_pool_name, database_name, data_connection_name, subscription_id, kind		Creates or updates a data connection.
delete	delete	resource_group_name, workspace_name, kusto_pool_name, database_name, data_connection_name, subscription_id		Deletes the data connection with the given name.
data_connection_validation	exec	resource_group_name, workspace_name, kusto_pool_name, database_name, subscription_id		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
data_connection_name	string	The name of the data connection. Required.
database_name	string	The name of the database in the Kusto pool. Required.
kusto_pool_name	string	The name of the Kusto pool. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

check_name_availability

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

SELECT
name,
message,
nameAvailable,
reason
FROM azure.synapse.kusto_pool_data_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND kusto_pool_name = '{{ kusto_pool_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Returns a data connection.

SELECT
id,
name,
kind,
location,
systemData,
type
FROM azure.synapse.kusto_pool_data_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND kusto_pool_name = '{{ kusto_pool_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND data_connection_name = '{{ data_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_database

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

SELECT
id,
name,
kind,
location,
systemData,
type
FROM azure.synapse.kusto_pool_data_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND kusto_pool_name = '{{ kusto_pool_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a data connection.

INSERT INTO azure.synapse.kusto_pool_data_connections (
location,
kind,
resource_group_name,
workspace_name,
kusto_pool_name,
database_name,
data_connection_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ kind }}' /* required */,
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ kusto_pool_name }}',
'{{ database_name }}',
'{{ data_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
location,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: kusto_pool_data_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the kusto_pool_data_connections resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the kusto_pool_data_connections resource.
  - name: kusto_pool_name
    value: "{{ kusto_pool_name }}"
    description: Required parameter for the kusto_pool_data_connections resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the kusto_pool_data_connections resource.
  - name: data_connection_name
    value: "{{ data_connection_name }}"
    description: Required parameter for the kusto_pool_data_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the kusto_pool_data_connections resource.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: kind
    value: "{{ kind }}"
    description: |
      Kind of the endpoint for the data connection. Required. Known values are: "EventHub", "EventGrid", and "IotHub".

UPDATE examples

update

Updates a data connection.

UPDATE azure.synapse.kusto_pool_data_connections
SET 
location = '{{ location }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND kusto_pool_name = '{{ kusto_pool_name }}' --required
AND database_name = '{{ database_name }}' --required
AND data_connection_name = '{{ data_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
kind,
location,
systemData,
type;

REPLACE examples

create_or_update

Creates or updates a data connection.

REPLACE azure.synapse.kusto_pool_data_connections
SET 
location = '{{ location }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND kusto_pool_name = '{{ kusto_pool_name }}' --required
AND database_name = '{{ database_name }}' --required
AND data_connection_name = '{{ data_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
kind,
location,
systemData,
type;

DELETE examples

delete

Deletes the data connection with the given name.

DELETE FROM azure.synapse.kusto_pool_data_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND kusto_pool_name = '{{ kusto_pool_name }}' --required
AND database_name = '{{ database_name }}' --required
AND data_connection_name = '{{ data_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

data_connection_validation

Checks that the data connection parameters are valid.

EXEC azure.synapse.kusto_pool_data_connections.data_connection_validation 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@kusto_pool_name='{{ kusto_pool_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"dataConnectionName": "{{ dataConnectionName }}", 
"properties": "{{ properties }}"
}'
;