Attached Database Configurations - List By Cluster

Service:

Azure Kusto

API Version:

2023-08-15

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations?api-version=2023-08-15

URI Parameters

Name	In	Required	Type	Description
clusterName	path	True	string	The name of the Kusto cluster. Regex pattern: ^.*$
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	AttachedDatabaseConfigurationListResult	Successfully retrieved the list of attached database configurations.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Examples

KustoAttachedDatabaseConfigurationsListByCluster

Sample Request

HTTP

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster2/attachedDatabaseConfigurations?api-version=2023-08-15

Java

/** Samples for AttachedDatabaseConfigurations ListByCluster. */
public final class Main {
    /*
     * x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoAttachedDatabaseConfigurationsListByCluster.json
     */
    /**
     * Sample code: KustoAttachedDatabaseConfigurationsListByCluster.
     *
     * @param manager Entry point to KustoManager.
     */
    public static void kustoAttachedDatabaseConfigurationsListByCluster(
        com.azure.resourcemanager.kusto.KustoManager manager) {
        manager
            .attachedDatabaseConfigurations()
            .listByCluster("kustorptest", "kustoCluster2", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.kusto import KustoManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-kusto
# USAGE
    python kusto_attached_database_configurations_list_by_cluster.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KustoManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-123456789098",
    )

    response = client.attached_database_configurations.list_by_cluster(
        resource_group_name="kustorptest",
        cluster_name="kustoCluster2",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoAttachedDatabaseConfigurationsListByCluster.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armkusto_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kusto/armkusto/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoAttachedDatabaseConfigurationsListByCluster.json
func ExampleAttachedDatabaseConfigurationsClient_NewListByClusterPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAttachedDatabaseConfigurationsClient().NewListByClusterPager("kustorptest", "kustoCluster2", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AttachedDatabaseConfigurationListResult = armkusto.AttachedDatabaseConfigurationListResult{
		// 	Value: []*armkusto.AttachedDatabaseConfiguration{
		// 		{
		// 			Name: to.Ptr("kustoCluster2/KustoDatabase8"),
		// 			Type: to.Ptr("Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2/AttachedDatabaseConfigurations/KustoDatabase8"),
		// 			Location: to.Ptr("westus"),
		// 			Properties: &armkusto.AttachedDatabaseConfigurationProperties{
		// 				ClusterResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader"),
		// 				DatabaseName: to.Ptr("db1"),
		// 				DefaultPrincipalsModificationKind: to.Ptr(armkusto.DefaultPrincipalsModificationKindUnion),
		// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("kustoCluster2/KustoDatabase9"),
		// 			Type: to.Ptr("Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2/AttachedDatabaseConfigurations/KustoDatabase9"),
		// 			Location: to.Ptr("westus"),
		// 			Properties: &armkusto.AttachedDatabaseConfigurationProperties{
		// 				ClusterResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader"),
		// 				DatabaseName: to.Ptr("db1"),
		// 				DefaultPrincipalsModificationKind: to.Ptr(armkusto.DefaultPrincipalsModificationKindUnion),
		// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
		// 				TableLevelSharingProperties: &armkusto.TableLevelSharingProperties{
		// 					ExternalTablesToExclude: []*string{
		// 						to.Ptr("ExternalTable2")},
		// 						ExternalTablesToInclude: []*string{
		// 							to.Ptr("ExternalTable1")},
		// 							FunctionsToExclude: []*string{
		// 								to.Ptr("functionsToExclude2")},
		// 								FunctionsToInclude: []*string{
		// 									to.Ptr("functionsToInclude1")},
		// 									MaterializedViewsToExclude: []*string{
		// 										to.Ptr("MaterializedViewTable2")},
		// 										MaterializedViewsToInclude: []*string{
		// 											to.Ptr("MaterializedViewTable1")},
		// 											TablesToExclude: []*string{
		// 												to.Ptr("Table2")},
		// 												TablesToInclude: []*string{
		// 													to.Ptr("Table1")},
		// 												},
		// 											},
		// 									}},
		// 								}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { KustoManagementClient } = require("@azure/arm-kusto");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Returns the list of attached database configurations of the given Kusto cluster.
 *
 * @summary Returns the list of attached database configurations of the given Kusto cluster.
 * x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoAttachedDatabaseConfigurationsListByCluster.json
 */
async function kustoAttachedDatabaseConfigurationsListByCluster() {
  const subscriptionId =
    process.env["KUSTO_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-123456789098";
  const resourceGroupName = process.env["KUSTO_RESOURCE_GROUP"] || "kustorptest";
  const clusterName = "kustoCluster2";
  const credential = new DefaultAzureCredential();
  const client = new KustoManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.attachedDatabaseConfigurations.listByCluster(
    resourceGroupName,
    clusterName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Kusto;
using Azure.ResourceManager.Kusto.Models;

// Generated from example definition: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoAttachedDatabaseConfigurationsListByCluster.json
// this example is just showing the usage of "AttachedDatabaseConfigurations_ListByCluster" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this KustoClusterResource created on azure
// for more information of creating KustoClusterResource, please refer to the document of KustoClusterResource
string subscriptionId = "12345678-1234-1234-1234-123456789098";
string resourceGroupName = "kustorptest";
string clusterName = "kustoCluster2";
ResourceIdentifier kustoClusterResourceId = KustoClusterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName);
KustoClusterResource kustoCluster = client.GetKustoClusterResource(kustoClusterResourceId);

// get the collection of this KustoAttachedDatabaseConfigurationResource
KustoAttachedDatabaseConfigurationCollection collection = kustoCluster.GetKustoAttachedDatabaseConfigurations();

// invoke the operation and iterate over the result
await foreach (KustoAttachedDatabaseConfigurationResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    KustoAttachedDatabaseConfigurationData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2/AttachedDatabaseConfigurations/KustoDatabase8",
      "name": "kustoCluster2/KustoDatabase8",
      "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations",
      "location": "westus",
      "properties": {
        "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader",
        "databaseName": "db1",
        "defaultPrincipalsModificationKind": "Union",
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2/AttachedDatabaseConfigurations/KustoDatabase9",
      "name": "kustoCluster2/KustoDatabase9",
      "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations",
      "location": "westus",
      "properties": {
        "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader",
        "databaseName": "db1",
        "defaultPrincipalsModificationKind": "Union",
        "tableLevelSharingProperties": {
          "tablesToInclude": [
            "Table1"
          ],
          "tablesToExclude": [
            "Table2"
          ],
          "externalTablesToInclude": [
            "ExternalTable1"
          ],
          "externalTablesToExclude": [
            "ExternalTable2"
          ],
          "materializedViewsToInclude": [
            "MaterializedViewTable1"
          ],
          "materializedViewsToExclude": [
            "MaterializedViewTable2"
          ],
          "functionsToInclude": [
            "functionsToInclude1"
          ],
          "functionsToExclude": [
            "functionsToExclude2"
          ]
        },
        "provisioningState": "Succeeded"
      }
    }
  ]
}

Definitions

Name	Description
AttachedDatabaseConfiguration	Class representing an attached database configuration.
AttachedDatabaseConfigurationListResult	The list attached database configurations operation response.
DefaultPrincipalsModificationKind	The default principals modification kind
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ProvisioningState	The provisioned state of the resource.
TableLevelSharingProperties	Tables that will be included and excluded in the follower database

AttachedDatabaseConfiguration

Class representing an attached database configuration.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Resource location.
name	string	The name of the resource
properties.attachedDatabaseNames	string[]	The list of databases from the clusterResourceId which are currently attached to the cluster.
properties.clusterResourceId	string	The resource id of the cluster where the databases you would like to attach reside.
properties.databaseName	string	The name of the database which you would like to attach, use * if you want to follow all current and future databases.
properties.databaseNameOverride	string	Overrides the original database name. Relevant only when attaching to a specific database.
properties.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.
properties.defaultPrincipalsModificationKind	DefaultPrincipalsModificationKind	The default principals modification kind
properties.provisioningState	ProvisioningState	The provisioned state of the resource.
properties.tableLevelSharingProperties	TableLevelSharingProperties	Table level sharing specifications
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

AttachedDatabaseConfigurationListResult

The list attached database configurations operation response.

Name	Type	Description
value	AttachedDatabaseConfiguration[]	The list of attached database configurations.

DefaultPrincipalsModificationKind

The default principals modification kind

Name	Type	Description
None	string
Replace	string
Union	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ProvisioningState

The provisioned state of the resource.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Moving	string
Running	string
Succeeded	string

TableLevelSharingProperties

Tables that will be included and excluded in the follower database

Name	Type	Description
externalTablesToExclude	string[]	List of external tables to exclude from the follower database
externalTablesToInclude	string[]	List of external tables to include in the follower database
functionsToExclude	string[]	List of functions to exclude from the follower database
functionsToInclude	string[]	List of functions to include in the follower database
materializedViewsToExclude	string[]	List of materialized views to exclude from the follower database
materializedViewsToInclude	string[]	List of materialized views to include in the follower database
tablesToExclude	string[]	List of tables to exclude from the follower database
tablesToInclude	string[]	List of tables to include in the follower database