kusto_pool_attached_database_configurations

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

Overview

Name	kusto_pool_attached_database_configurations
Type	Resource
Id	azure.synapse.kusto_pool_attached_database_configurations

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified attached database configuration.

Name	Datatype	Description
location	string	Resource location.
properties	object	The properties of the attached database configuration.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.

list_by_kusto_pool

Successfully retrieved the list of attached database configurations.

Name	Datatype	Description
location	string	Resource location.
properties	object	The properties of the attached database configuration.
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	workspaceName, kustoPoolName, attachedDatabaseConfigurationName, subscriptionId, resourceGroupName		Returns an attached database configuration.
list_by_kusto_pool	select	workspaceName, kustoPoolName, subscriptionId, resourceGroupName		Returns the list of attached database configurations of the given Kusto Pool.
create_or_update	insert	workspaceName, kustoPoolName, attachedDatabaseConfigurationName, subscriptionId, resourceGroupName		Creates or updates an attached database configuration.
delete	delete	workspaceName, kustoPoolName, attachedDatabaseConfigurationName, subscriptionId, resourceGroupName		Deletes the attached database configuration with the given name.

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
attachedDatabaseConfigurationName	string	The name of the attached database configuration.
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 an attached database configuration.

SELECT
location,
properties,
systemData
FROM azure.synapse.kusto_pool_attached_database_configurations
WHERE workspaceName = '{{ workspaceName }}' -- required
AND kustoPoolName = '{{ kustoPoolName }}' -- required
AND attachedDatabaseConfigurationName = '{{ attachedDatabaseConfigurationName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_kusto_pool

Returns the list of attached database configurations of the given Kusto Pool.

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

INSERT examples

create_or_update

Creates or updates an attached database configuration.

INSERT INTO azure.synapse.kusto_pool_attached_database_configurations (
data__location,
data__properties,
workspaceName,
kustoPoolName,
attachedDatabaseConfigurationName,
subscriptionId,
resourceGroupName
)
SELECT 
'{{ location }}',
'{{ properties }}',
'{{ workspaceName }}',
'{{ kustoPoolName }}',
'{{ attachedDatabaseConfigurationName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}'
RETURNING
location,
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: kusto_pool_attached_database_configurations
  props:
    - name: workspaceName
      value: string
      description: Required parameter for the kusto_pool_attached_database_configurations resource.
    - name: kustoPoolName
      value: string
      description: Required parameter for the kusto_pool_attached_database_configurations resource.
    - name: attachedDatabaseConfigurationName
      value: string
      description: Required parameter for the kusto_pool_attached_database_configurations resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the kusto_pool_attached_database_configurations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the kusto_pool_attached_database_configurations resource.
    - name: location
      value: string
      description: |
        Resource location.
    - name: properties
      value: object
      description: |
        The properties of the attached database configuration.

DELETE examples

delete

Deletes the attached database configuration with the given name.

DELETE FROM azure.synapse.kusto_pool_attached_database_configurations
WHERE workspaceName = '{{ workspaceName }}' --required
AND kustoPoolName = '{{ kustoPoolName }}' --required
AND attachedDatabaseConfigurationName = '{{ attachedDatabaseConfigurationName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
;