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

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.
attachedDatabaseNames	array	The list of databases from the clusterResourceId which are currently attached to the kusto pool.
clusterResourceId	string	The resource id of the kusto pool where the databases you would like to attach reside.
databaseName	string	The name of the database which you would like to attach, use * if you want to follow all current and future databases.
defaultPrincipalsModificationKind	string	The default principals modification kind. Known values are: "Union", "Replace", and "None".
location	string	Resource location.
provisioningState	string	The provisioned state of the resource. Known values are: "Running", "Creating", "Deleting", "Succeeded", "Failed", "Moving", and "Canceled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tableLevelSharingProperties	object	Table level sharing specifications.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_kusto_pool

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.
attachedDatabaseNames	array	The list of databases from the clusterResourceId which are currently attached to the kusto pool.
clusterResourceId	string	The resource id of the kusto pool where the databases you would like to attach reside.
databaseName	string	The name of the database which you would like to attach, use * if you want to follow all current and future databases.
defaultPrincipalsModificationKind	string	The default principals modification kind. Known values are: "Union", "Replace", and "None".
location	string	Resource location.
provisioningState	string	The provisioned state of the resource. Known values are: "Running", "Creating", "Deleting", "Succeeded", "Failed", "Moving", and "Canceled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tableLevelSharingProperties	object	Table level sharing specifications.
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
get	select	workspace_name, kusto_pool_name, attached_database_configuration_name, resource_group_name, subscription_id		Returns an attached database configuration.
list_by_kusto_pool	select	workspace_name, kusto_pool_name, resource_group_name, subscription_id		Returns the list of attached database configurations of the given Kusto Pool.
create_or_update	insert	workspace_name, kusto_pool_name, attached_database_configuration_name, resource_group_name, subscription_id		Creates or updates an attached database configuration.
create_or_update	replace	workspace_name, kusto_pool_name, attached_database_configuration_name, resource_group_name, subscription_id		Creates or updates an attached database configuration.
delete	delete	workspace_name, kusto_pool_name, attached_database_configuration_name, resource_group_name, subscription_id		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
attached_database_configuration_name	string	The name of the attached database configuration. 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

get

Returns an attached database configuration.

SELECT
id,
name,
attachedDatabaseNames,
clusterResourceId,
databaseName,
defaultPrincipalsModificationKind,
location,
provisioningState,
systemData,
tableLevelSharingProperties,
type
FROM azure.synapse.kusto_pool_attached_database_configurations
WHERE workspace_name = '{{ workspace_name }}' -- required
AND kusto_pool_name = '{{ kusto_pool_name }}' -- required
AND attached_database_configuration_name = '{{ attached_database_configuration_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_kusto_pool

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

SELECT
id,
name,
attachedDatabaseNames,
clusterResourceId,
databaseName,
defaultPrincipalsModificationKind,
location,
provisioningState,
systemData,
tableLevelSharingProperties,
type
FROM azure.synapse.kusto_pool_attached_database_configurations
WHERE workspace_name = '{{ workspace_name }}' -- required
AND kusto_pool_name = '{{ kusto_pool_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an attached database configuration.

INSERT INTO azure.synapse.kusto_pool_attached_database_configurations (
location,
properties,
workspace_name,
kusto_pool_name,
attached_database_configuration_name,
resource_group_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ properties }}',
'{{ workspace_name }}',
'{{ kusto_pool_name }}',
'{{ attached_database_configuration_name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: kusto_pool_attached_database_configurations
props:
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the kusto_pool_attached_database_configurations resource.
  - name: kusto_pool_name
    value: "{{ kusto_pool_name }}"
    description: Required parameter for the kusto_pool_attached_database_configurations resource.
  - name: attached_database_configuration_name
    value: "{{ attached_database_configuration_name }}"
    description: Required parameter for the kusto_pool_attached_database_configurations resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the kusto_pool_attached_database_configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the kusto_pool_attached_database_configurations resource.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: properties
    value:
      databaseName: "{{ databaseName }}"
      clusterResourceId: "{{ clusterResourceId }}"
      defaultPrincipalsModificationKind: "{{ defaultPrincipalsModificationKind }}"
      tableLevelSharingProperties:
        tablesToInclude:
          - "{{ tablesToInclude }}"
        tablesToExclude:
          - "{{ tablesToExclude }}"
        externalTablesToInclude:
          - "{{ externalTablesToInclude }}"
        externalTablesToExclude:
          - "{{ externalTablesToExclude }}"
        materializedViewsToInclude:
          - "{{ materializedViewsToInclude }}"
        materializedViewsToExclude:
          - "{{ materializedViewsToExclude }}"

REPLACE examples

create_or_update

Creates or updates an attached database configuration.

REPLACE azure.synapse.kusto_pool_attached_database_configurations
SET 
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
workspace_name = '{{ workspace_name }}' --required
AND kusto_pool_name = '{{ kusto_pool_name }}' --required
AND attached_database_configuration_name = '{{ attached_database_configuration_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
type;

DELETE examples

delete

Deletes the attached database configuration with the given name.

DELETE FROM azure.synapse.kusto_pool_attached_database_configurations
WHERE workspace_name = '{{ workspace_name }}' --required
AND kusto_pool_name = '{{ kusto_pool_name }}' --required
AND attached_database_configuration_name = '{{ attached_database_configuration_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;