attached_database_configurations

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

Overview

Name	attached_database_configurations
Type	Resource
Id	azure.data_explorer.attached_database_configurations

Fields

vw_attached_database_configurations

Name	Datatype	Description
attachedDatabaseConfigurationName	text	field from the properties object
attached_database_names	text	field from the properties object
clusterName	text	field from the properties object
cluster_resource_id	text	field from the properties object
database_name	text	field from the properties object
database_name_override	text	field from the properties object
database_name_prefix	text	field from the properties object
default_principals_modification_kind	text	field from the properties object
location	text	Resource location.
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
table_level_sharing_properties	text	field from the properties object

attached_database_configurations

Name	Datatype	Description
location	string	Resource location.
properties	object	Class representing the an attached database configuration properties of kind specific.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	attachedDatabaseConfigurationName, clusterName, resourceGroupName, subscriptionId	Returns an attached database configuration.
list_by_cluster	SELECT	clusterName, resourceGroupName, subscriptionId	Returns the list of attached database configurations of the given Kusto cluster.
create_or_update	INSERT	attachedDatabaseConfigurationName, clusterName, resourceGroupName, subscriptionId	Creates or updates an attached database configuration.
delete	DELETE	attachedDatabaseConfigurationName, clusterName, resourceGroupName, subscriptionId	Deletes the attached database configuration with the given name.
check_name_availability	EXEC	clusterName, resourceGroupName, subscriptionId, data__name, data__type	Checks that the attached database configuration resource name is valid and is not already in use.

SELECT examples

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

vw_attached_database_configurations

SELECT
attachedDatabaseConfigurationName,
attached_database_names,
clusterName,
cluster_resource_id,
database_name,
database_name_override,
database_name_prefix,
default_principals_modification_kind,
location,
provisioning_state,
resourceGroupName,
subscriptionId,
table_level_sharing_properties
FROM azure.data_explorer.vw_attached_database_configurations
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

attached_database_configurations

SELECT
location,
properties
FROM azure.data_explorer.attached_database_configurations
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.data_explorer.attached_database_configurations (
attachedDatabaseConfigurationName,
clusterName,
resourceGroupName,
subscriptionId,
location,
properties
)
SELECT 
'{{ attachedDatabaseConfigurationName }}',
'{{ clusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ location }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: properties
      value:
        - name: provisioningState
          value: []
        - name: databaseName
          value: string
        - name: clusterResourceId
          value: string
        - name: attachedDatabaseNames
          value:
            - string
        - name: defaultPrincipalsModificationKind
          value: string
        - name: tableLevelSharingProperties
          value:
            - name: tablesToInclude
              value:
                - string
            - name: tablesToExclude
              value:
                - string
            - name: externalTablesToInclude
              value:
                - string
            - name: externalTablesToExclude
              value:
                - string
            - name: materializedViewsToInclude
              value:
                - string
            - name: materializedViewsToExclude
              value:
                - string
            - name: functionsToInclude
              value:
                - string
            - name: functionsToExclude
              value:
                - string
        - name: databaseNameOverride
          value: string
        - name: databaseNamePrefix
          value: string

DELETE example

Deletes the specified attached_database_configurations resource.

/*+ delete */
DELETE FROM azure.data_explorer.attached_database_configurations
WHERE attachedDatabaseConfigurationName = '{{ attachedDatabaseConfigurationName }}'
AND clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';