attached_database_configurations

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

Overview

Name	attached_database_configurations
Type	Resource
Id	azure.kusto.attached_database_configurations

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". (Invalid, 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.
attachedDatabaseNames	array	The list of databases from the clusterResourceId which are currently attached to the cluster.
clusterResourceId	string	The resource id of the cluster where the databases you would like to attach reside. Required.
databaseName	string	The name of the database which you would like to attach, use * if you want to follow all current and future databases. Required.
databaseNameOverride	string	Overrides the original database name. Relevant only when attaching to a specific database.
databaseNamePrefix	string	Adds a prefix to the attached databases name. When following an entire cluster, that prefix would be added to all of the databases original names from leader cluster.
defaultPrincipalsModificationKind	string	The default principals modification kind. Required. Known values are: "Union", "Replace", and "None". (Union, Replace, None)
location	string	Resource location.
provisioningState	string	The provisioned state of the resource. Known values are: "Running", "Creating", "Deleting", "Succeeded", "Failed", "Moving", and "Canceled". (Running, Creating, Deleting, Succeeded, Failed, Moving, 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_cluster

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 cluster.
clusterResourceId	string	The resource id of the cluster where the databases you would like to attach reside. Required.
databaseName	string	The name of the database which you would like to attach, use * if you want to follow all current and future databases. Required.
databaseNameOverride	string	Overrides the original database name. Relevant only when attaching to a specific database.
databaseNamePrefix	string	Adds a prefix to the attached databases name. When following an entire cluster, that prefix would be added to all of the databases original names from leader cluster.
defaultPrincipalsModificationKind	string	The default principals modification kind. Required. Known values are: "Union", "Replace", and "None". (Union, Replace, None)
location	string	Resource location.
provisioningState	string	The provisioned state of the resource. Known values are: "Running", "Creating", "Deleting", "Succeeded", "Failed", "Moving", and "Canceled". (Running, Creating, Deleting, Succeeded, Failed, Moving, 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
check_name_availability	select	resource_group_name, cluster_name, subscription_id		Checks that the attached database configuration resource name is valid and is not already in use.
get	select	resource_group_name, cluster_name, attached_database_configuration_name, subscription_id		Returns an attached database configuration.
list_by_cluster	select	resource_group_name, cluster_name, subscription_id		Returns the list of attached database configurations of the given Kusto cluster.
create_or_update	insert	resource_group_name, cluster_name, attached_database_configuration_name, subscription_id		Creates or updates an attached database configuration.
create_or_update	replace	resource_group_name, cluster_name, attached_database_configuration_name, subscription_id		Creates or updates an attached database configuration.
delete	delete	resource_group_name, cluster_name, attached_database_configuration_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.
cluster_name	string	The name of the Kusto cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

check_name_availability

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

SELECT
name,
message,
nameAvailable,
reason
FROM azure.kusto.attached_database_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Returns an attached database configuration.

SELECT
id,
name,
attachedDatabaseNames,
clusterResourceId,
databaseName,
databaseNameOverride,
databaseNamePrefix,
defaultPrincipalsModificationKind,
location,
provisioningState,
systemData,
tableLevelSharingProperties,
type
FROM azure.kusto.attached_database_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND attached_database_configuration_name = '{{ attached_database_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_cluster

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

SELECT
id,
name,
attachedDatabaseNames,
clusterResourceId,
databaseName,
databaseNameOverride,
databaseNamePrefix,
defaultPrincipalsModificationKind,
location,
provisioningState,
systemData,
tableLevelSharingProperties,
type
FROM azure.kusto.attached_database_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an attached database configuration.

INSERT INTO azure.kusto.attached_database_configurations (
properties,
location,
resource_group_name,
cluster_name,
attached_database_configuration_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ attached_database_configuration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: attached_database_configurations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the attached_database_configurations resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the attached_database_configurations resource.
  - name: attached_database_configuration_name
    value: "{{ attached_database_configuration_name }}"
    description: Required parameter for the attached_database_configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the attached_database_configurations resource.
  - name: properties
    description: |
      The properties of the attached database configuration.
    value:
      provisioningState: "{{ provisioningState }}"
      databaseName: "{{ databaseName }}"
      clusterResourceId: "{{ clusterResourceId }}"
      attachedDatabaseNames:
        - "{{ attachedDatabaseNames }}"
      defaultPrincipalsModificationKind: "{{ defaultPrincipalsModificationKind }}"
      tableLevelSharingProperties:
        tablesToInclude:
          - "{{ tablesToInclude }}"
        tablesToExclude:
          - "{{ tablesToExclude }}"
        externalTablesToInclude:
          - "{{ externalTablesToInclude }}"
        externalTablesToExclude:
          - "{{ externalTablesToExclude }}"
        materializedViewsToInclude:
          - "{{ materializedViewsToInclude }}"
        materializedViewsToExclude:
          - "{{ materializedViewsToExclude }}"
        functionsToInclude:
          - "{{ functionsToInclude }}"
        functionsToExclude:
          - "{{ functionsToExclude }}"
      databaseNameOverride: "{{ databaseNameOverride }}"
      databaseNamePrefix: "{{ databaseNamePrefix }}"
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.

REPLACE examples

create_or_update

Creates or updates an attached database configuration.

REPLACE azure.kusto.attached_database_configurations
SET 
properties = '{{ properties }}',
location = '{{ location }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND attached_database_configuration_name = '{{ attached_database_configuration_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.kusto.attached_database_configurations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND attached_database_configuration_name = '{{ attached_database_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;