attached_database_configurations

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

Overview

Name	attached_database_configurations
Type	Resource
Id	azure.data_explorer.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.

list_by_cluster

Successfully retrieved the list of attached database configurations.

Name	Datatype	Description
location	string	Resource location.
properties	object	The properties of the attached database configuration.

Methods

The following methods are available for this resource:

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

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.
clusterName	string	The name of the Kusto cluster.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Returns an attached database configuration.

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

list_by_cluster

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

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

INSERT examples

create_or_update

Creates or updates an attached database configuration.

INSERT INTO azure.data_explorer.attached_database_configurations (
data__location,
data__properties,
resourceGroupName,
clusterName,
attachedDatabaseConfigurationName,
subscriptionId
)
SELECT 
'{{ location }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ attachedDatabaseConfigurationName }}',
'{{ subscriptionId }}'
RETURNING
location,
properties
;

Manifest

# Description fields are for documentation purposes
- name: attached_database_configurations
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the attached_database_configurations resource.
    - name: clusterName
      value: string
      description: Required parameter for the attached_database_configurations resource.
    - name: attachedDatabaseConfigurationName
      value: string
      description: Required parameter for the attached_database_configurations resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the 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.data_explorer.attached_database_configurations
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND attachedDatabaseConfigurationName = '{{ attachedDatabaseConfigurationName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

check_name_availability

Checks that the attached database configuration resource name is valid and is not already in use.

EXEC azure.data_explorer.attached_database_configurations.check_name_availability 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;