Utiliser des bases de données de suivi

Attacher une base de données à l’aide de C#

Packages NuGet requis

• Installez Microsoft.Azure.Management.Kusto.
• Installez Microsoft.Rest.ClientRuntime.Azure.Authentication pour l’authentification.

Exemple C#

var tenantId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"; //Directory (tenant) ID
var clientId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"; //Application ID
var clientSecret = "PlaceholderClientSecret"; //Client Secret
var followerSubscriptionId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx";
var credentials = await ApplicationTokenProvider.LoginSilentAsync(tenantId, clientId, clientSecret);
var resourceManagementClient = new KustoManagementClient(credentials) { SubscriptionId = followerSubscriptionId };
var followerResourceGroupName = "followerResourceGroup";
var followerClusterName = "follower";
var attachedDatabaseConfigurationName = "attachedDatabaseConfiguration"
var leaderSubscriptionId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx";
var leaderResourceGroup = "leaderResourceGroup";
var leaderClusterName = "leader";
var attachedDatabaseConfigurationData = new AttachedDatabaseConfiguration
{
    ClusterResourceId = $"/subscriptions/{leaderSubscriptionId}/resourceGroups/{leaderResourceGroup}/providers/Microsoft.Kusto/Clusters/{leaderClusterName}",
    DatabaseName = "<databaseName>", // Can be specific database name or * for all databases
    DefaultPrincipalsModificationKind = "Union",
    Location = "North Central US"
};
// Table level sharing properties are not supported when using '*' all databases notation.
if (attachedDatabaseConfigurationData.DatabaseName != "*")
{
    // Set up the table level sharing properties - the following is just an example.
    attachedDatabaseConfigurationData.TableLevelSharingProperties = new TableLevelSharingProperties(
        tablesToInclude:new List<string> { "table1" },
        tablesToExclude:new List<string> { "table2" },
        externalTablesToInclude:new List<string> { "exTable1" },
        externalTablesToExclude:new List<string> { "exTable2" },
        materializedViewsToInclude:new List<string> { "matTable1" },
        materializedViewsToExclude:new List<string> { "matTable2" }
    );
}
await resourceManagementClient.AttachedDatabaseConfigurations.CreateOrUpdateAsync(
    followerResourceGroupName, followerClusterName, attachedDatabaseConfigurationName, attachedDatabaseConfigurationData
);

Attacher une base de données à l’aide de Python

Modules requis

pip install azure-common
pip install azure-mgmt-kusto

Exemple Python

from azure.mgmt.kusto import KustoManagementClient
from azure.mgmt.kusto.models import AttachedDatabaseConfiguration
from azure.common.credentials import ServicePrincipalCredentials
import datetime

#Directory (tenant) ID
tenant_id = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"
#Application ID
client_id = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"
#Client Secret
client_secret = "xxxxxxxxxxxxxx"
follower_subscription_id = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"
leader_subscription_id = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"
credentials = ServicePrincipalCredentials(
        client_id=client_id,
        secret=client_secret,
        tenant=tenant_id
    )
kusto_management_client = KustoManagementClient(credentials, follower_subscription_id)

follower_resource_group_name = "followerResourceGroup"
leader_resource_group_name = "leaderResourceGroup"
follower_cluster_name = "follower"
leader_cluster_name = "leader"
attached_database_Configuration_name = "uniqueNameForAttachedDatabaseConfiguration"
database_name  = "db" # Can be specific database name or * for all databases
default_principals_modification_kind  = "Union"
location = "North Central US"
cluster_resource_id = "/subscriptions/" + leader_subscription_id + "/resourceGroups/" + leader_resource_group_name + "/providers/Microsoft.Kusto/Clusters/" + leader_cluster_name
table_level_sharing_properties = None
if (database_name != "*"):
    #Set up the table level sharing properties - the following is just an example.
    tables_to_include = ["table1", "table2", "table3"]
    external_tables_to_exclude =  ["Logs*"]
    table_level_sharing_properties = TableLevelSharingProperties(tables_to_include = tables_to_include, external_tables_to_exclude = external_tables_to_exclude)


attached_database_configuration_properties = AttachedDatabaseConfiguration(cluster_resource_id = cluster_resource_id, database_name = database_name, default_principals_modification_kind = default_principals_modification_kind, location = location, table_level_sharing_properties = table_level_sharing_properties)

#Returns an instance of LROPoller, see https://learn.microsoft.com/python/api/msrest/msrest.polling.lropoller?view=azure-python
poller = kusto_management_client.attached_database_configurations.create_or_update(follower_resource_group_name, follower_cluster_name, attached_database_Configuration_name, attached_database_configuration_properties)

Attacher une base de données à l’aide de PowerShell

Module prérequis

Install : Az.Kusto

Exemple PowerShell

$FollowerClustername = 'follower'
$FollowerClusterSubscriptionID = 'xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx'
$FollowerResourceGroupName = 'followerResourceGroup'
$DatabaseName = "db"  ## Can be specific database name or * for all databases
$LeaderClustername = 'leader'
$LeaderClusterSubscriptionID = 'xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx'
$LeaderClusterResourceGroup = 'leaderResourceGroup'
$DefaultPrincipalsModificationKind = 'Union'
##Construct the LeaderClusterResourceId and Location
$getleadercluster = Get-AzKustoCluster -Name $LeaderClustername -ResourceGroupName $LeaderClusterResourceGroup -SubscriptionId $LeaderClusterSubscriptionID -ErrorAction Stop
$LeaderClusterResourceid = $getleadercluster.Id
$Location = $getleadercluster.Location
##Handle the config name if all databases needs to be followed
if($DatabaseName -eq '*')  {
        $configname = $FollowerClustername + 'config'
       }
else {
        $configname = $DatabaseName
     }
##Table level sharing is not supported when using '*' all databases notation. If you use the all database notation please remove all table level sharing lines from the powershell command.
New-AzKustoAttachedDatabaseConfiguration -ClusterName $FollowerClustername `
    -Name $configname `
    -ResourceGroupName $FollowerResourceGroupName `
    -SubscriptionId $FollowerClusterSubscriptionID `
    -DatabaseName $DatabaseName `
    -ClusterResourceId $LeaderClusterResourceid `
    -DefaultPrincipalsModificationKind $DefaultPrincipalsModificationKind `
    -Location $Location `
    -TableLevelSharingPropertyTablesToInclude "table1", "table2", "table3" `
    -TableLevelSharingPropertyExternalTablesToExclude "Logs*" `
    -ErrorAction Stop

Attacher une base de données à l’aide d’un modèle Azure Resource Manager

Vous pouvez utiliser un modèle Azure Resource Manager pour attacher une base de données à un cluster existant.

Pour attacher une base de données, procédez comme suit :

1. Créez un modèle à l’aide des informations contenues dans le tableau suivant pour vous aider à le configurer.

   Paramètre	Description	Exemple
   NomDuClusterDeSuiveurs	Nom du cluster de suivi ; où le modèle sera déployé.
   nomConfigurationsBaseDeDonnéesAttachées	Nom de l’objet configurations de base de données jointe. Le nom peut être n’importe quelle chaîne unique au niveau du cluster.
   databaseName	Nom de la base de données à suivre. Pour suivre toutes les bases de données du leader, utilisez « * ».
   identifiantRessourceClusterLeader	ID de ressource du cluster leader.
   defaultPrincipalsModificationKind	Type de modification du principal par défaut.	Peut être Union, Replace ou None. Pour plus d’informations sur le type de la modification principale par défaut, consultez la commande de contrôle du type de modification principale .
   tablesÀInclure	La liste des tables à inclure. Pour inclure toutes les tables commençant par « Logs* », utilisez ["Logs*"].	["table1ToInclude", "table2ToInclude"]
   tablesÀExclure	Liste des tables à exclure. Pour exclure toutes les tables, utilisez ["*"].	["table1ToExclude", "table2ToExclude"]
   externalTablesToInclude	Liste des tables à inclure. Pour inclure toutes les tables externes commençant par "Logs", utilisez ["Logs*"].	["ExternalTable1ToInclude", "ExternalTable2ToInclude"]
   tablesExternesÀExclure	Liste des tables à exclure. Pour exclure toutes les tables externes, utilisez ["*"].	["ExternalTable1ToExclude", "ExternalTable2ToExclude"]
   materializedViewsToInclude	Liste des vues matérialisées à inclure. Pour inclure toutes les vues matérialisées commençant par « Logs », utilisez [« Logs* »].	["Mv1ToInclude", "Mv2ToInclude"]
   vues matérialisées à exclure	Liste des vues matérialisées à exclure. Pour exclure toutes les vues matérialisées, utilisez ["*"].	["Mv11ToExclude", "Mv22ToExclude"]
   fonctionsÀInclure	Liste des fonctions à inclure.	["FunctionToInclude"]
   functionsToExclude	Liste des fonctions à exclure.	["FunctionToExclude"]
   emplacement	Emplacement de toutes les ressources. Le leader et le suiveur doivent se trouver dans le même emplacement.

   {
       "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
       "contentVersion": "1.0.0.0",
       "parameters": {
           "followerClusterName": {
               "type": "string",
               "defaultValue": "",
               "metadata": {
                   "description": "Name of the cluster to which the database will be attached."
               }
           },
           "attachedDatabaseConfigurationsName": {
               "type": "string",
               "defaultValue": "",
               "metadata": {
                   "description": "Name of the attached database configurations to create."
               }
           },
           "databaseName": {
               "type": "string",
               "defaultValue": "",
               "metadata": {
                   "description": "The name of the database to follow. You can follow all databases by using '*'."
               }
           },
           "leaderClusterResourceId": {
               "type": "string",
               "defaultValue": "",
               "metadata": {
                   "description": "The resource ID of the leader cluster."
               }
           },
           "defaultPrincipalsModificationKind": {
               "type": "string",
               "defaultValue": "Union",
               "metadata": {
                   "description": "The default principal modification kind."
               }
           },
           "tablesToInclude": {
               "type": "array",
               "defaultValue": [],
               "metadata": {
                   "description": "The list of tables to include. Not supported when following all databases."
               }
           },
           "tablesToExclude": {
               "type": "array",
               "defaultValue": [],
               "metadata": {
                   "description": "The list of tables to exclude. Not supported when following all databases."
               }
           },
           "externalTablesToInclude": {
               "type": "array",
               "defaultValue": [],
               "metadata": {
                   "description": "The list of external tables to include. Not supported when following all databases."
               }
           },
           "externalTablesToExclude": {
               "type": "array",
               "defaultValue": [],
               "metadata": {
                   "description": "The list of external tables to exclude. Not supported when following all databases."
               }
           },
           "materializedViewsToInclude": {
               "type": "array",
               "defaultValue": [],
               "metadata": {
                   "description": "The list of materialized views to include. Not supported when following all databases."
               }
           },
           "materializedViewsToExclude": {
               "type": "array",
               "defaultValue": [],
               "metadata": {
                   "description": "The list of materialized views to exclude. Not supported when following all databases."
               }
           },
           "functionsToInclude": {
               "type": "array",
               "defaultValue": [],
               "metadata": {
                   "description": "The list of functions to include."
               }
           },
           "functionsToExclude": {
               "type": "array",
               "defaultValue": [],
               "metadata": {
                   "description": "The list of functions to exclude."
               }
           },
           "location": {
               "type": "string",
               "defaultValue": "",
               "metadata": {
                   "description": "Location for all resources."
               }
           }
       },
       "variables": {},
       "resources": [
           {
               "name": "[concat(parameters('followerClusterName'), '/', parameters('attachedDatabaseConfigurationsName'))]",
               "type": "Microsoft.Kusto/clusters/attachedDatabaseConfigurations",
               "apiVersion": "2021-01-01",
               "location": "[parameters('location')]",
               "properties": {
                   "databaseName": "[parameters('databaseName')]",
                   "clusterResourceId": "[parameters('leaderClusterResourceId')]",
                   "defaultPrincipalsModificationKind": "[parameters('defaultPrincipalsModificationKind')]",
                   "tableLevelSharingProperties":{
                       "tablesToInclude": "[parameters('tablesToInclude')]",
                       "tablesToExclude": "[parameters('tablesToExclude')]",
                       "externalTablesToInclude": "[parameters('externalTablesToInclude')]",
                       "externalTablesToExclude": "[parameters('externalTablesToExclude')]",
                       "materializedViewsToInclude": "[parameters('materializedViewsToInclude')]",
                       "materializedViewsToExclude": "[parameters('materializedViewsToExclude')]",
                       "functionsToInclude": "[parameters('functionsToInclude')]",
                       "functionsToExclude": "[parameters('functionsToExclude')]"
                   }
               }
           }
       ]
   }
   

2. Déployez le modèle Azure Resource Manager à l’aide du portail Azure ou PowerShell.

   

Détachez la base de données du suiveur attaché du cluster follower à l’aide de C#**

Le cluster de suivi peut détacher n’importe quelle base de données de suiveur attachée comme suit :

var tenantId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"; //Directory (tenant) ID
var clientId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"; //Application ID
var clientSecret = "PlaceholderClientSecret"; //Client Secret
var followerSubscriptionId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx";
var credentials = await ApplicationTokenProvider.LoginSilentAsync(tenantId, clientId, clientSecret);
var resourceManagementClient = new KustoManagementClient(credentials) { SubscriptionId = followerSubscriptionId };
var followerResourceGroupName = "testrg";
//The cluster and database attached database configuration are created as part of the prerequisites
var followerClusterName = "follower";
var attachedDatabaseConfigurationsName = "attachedDatabaseConfiguration";
await resourceManagementClient.AttachedDatabaseConfigurations.DeleteAsync(
    followerResourceGroupName, followerClusterName, attachedDatabaseConfigurationsName
);

Détacher la base de données de suivi jointe du cluster leader à l’aide de C#

Le cluster leader peut détacher n’importe quelle base de données attachée comme suit :

var tenantId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"; //Directory (tenant) ID
var clientId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"; //Application ID
var clientSecret = "PlaceholderClientSecret"; //Client Secret
var leaderSubscriptionId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx";
var credentials = await ApplicationTokenProvider.LoginSilentAsync(tenantId, clientId, clientSecret);
var resourceManagementClient = new KustoManagementClient(credentials) { SubscriptionId = leaderSubscriptionId };
var leaderResourceGroupName = "testrg";
var leaderClusterName = "leader";
var followerSubscriptionId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx";
var followerResourceGroupName = "followerResourceGroup";
//The cluster and attached database configuration that are created as part of the Prerequisites
var followerClusterName = "follower";
var attachedDatabaseConfigurationsName = "attachedDatabaseConfiguration";
var followerDatabaseDefinition = new FollowerDatabaseDefinition
{
    ClusterResourceId = $"/subscriptions/{followerSubscriptionId}/resourceGroups/{followerResourceGroupName}/providers/Microsoft.Kusto/Clusters/{followerClusterName}",
    AttachedDatabaseConfigurationName = attachedDatabaseConfigurationsName
};
await resourceManagementClient.Clusters.DetachFollowerDatabasesAsync(
    leaderResourceGroupName, leaderClusterName, followerDatabaseDefinition
);

Détacher la base de données du suiveur attaché du cluster follower à l’aide de Python

Le cluster de suiveur peut détacher n’importe quelle base de données attachée comme suit :

from azure.mgmt.kusto import KustoManagementClient
from azure.common.credentials import ServicePrincipalCredentials
import datetime

#Directory (tenant) ID
tenant_id = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"
#Application ID
client_id = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"
#Client Secret
client_secret = "xxxxxxxxxxxxxx"
follower_subscription_id = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"
credentials = ServicePrincipalCredentials(
        client_id=client_id,
        secret=client_secret,
        tenant=tenant_id
    )
kusto_management_client = KustoManagementClient(credentials, follower_subscription_id)

follower_resource_group_name = "followerResourceGroup"
follower_cluster_name = "follower"
attached_database_configurationName = "uniqueName"

#Returns an instance of LROPoller, see https://learn.microsoft.com/python/api/msrest/msrest.polling.lropoller?view=azure-python
poller = kusto_management_client.attached_database_configurations.delete(follower_resource_group_name, follower_cluster_name, attached_database_configurationName)

Détachez la base de données du suiveur attaché du cluster leader à l’aide de Python

Le cluster leader peut détacher n’importe quelle base de données attachée comme suit :

from azure.mgmt.kusto import KustoManagementClient
from azure.mgmt.kusto.models import FollowerDatabaseDefinition
from azure.common.credentials import ServicePrincipalCredentials
import datetime

#Directory (tenant) ID
tenant_id = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"
#Application ID
client_id = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"
#Client Secret
client_secret = "xxxxxxxxxxxxxx"
follower_subscription_id = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"
leader_subscription_id = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"
credentials = ServicePrincipalCredentials(
        client_id=client_id,
        secret=client_secret,
        tenant=tenant_id
    )
kusto_management_client = KustoManagementClient(credentials, follower_subscription_id)

follower_resource_group_name = "followerResourceGroup"
leader_resource_group_name = "leaderResourceGroup"
follower_cluster_name = "follower"
leader_cluster_name = "leader"
attached_database_configuration_name = "uniqueName"
location = "North Central US"
cluster_resource_id = "/subscriptions/" + follower_subscription_id + "/resourceGroups/" + follower_resource_group_name + "/providers/Microsoft.Kusto/Clusters/" + follower_cluster_name

#Returns an instance of LROPoller, see https://learn.microsoft.com/python/api/msrest/msrest.polling.lropoller?view=azure-python
poller = kusto_management_client.clusters.detach_follower_databases(resource_group_name = leader_resource_group_name, cluster_name = leader_cluster_name, cluster_resource_id = cluster_resource_id, attached_database_configuration_name = attached_database_configuration_name)

Détacher une base de données à l’aide de PowerShell

Module prérequis

Install : Az.Kusto

Exemple :

$FollowerClustername = 'follower'
$FollowerClusterSubscriptionID = 'xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx'
$FollowerResourceGroupName = 'followerResourceGroup'
$DatabaseName = "sanjn"  ## Can be specific database name or * for all databases

##Construct the Configuration name
$confignameraw = (Get-AzKustoAttachedDatabaseConfiguration -ClusterName $FollowerClustername -ResourceGroupName $FollowerResourceGroupName -SubscriptionId $FollowerClusterSubscriptionID) | Where-Object {$_.DatabaseName -eq $DatabaseName }
$configname =$confignameraw.Name.Split("/")[1]

Remove-AzKustoAttachedDatabaseConfiguration -ClusterName $FollowerClustername -Name $configname -ResourceGroupName $FollowerResourceGroupName -SubscriptionId $FollowerClusterSubscriptionID

Détacher la base de données de suivi à l’aide de C#, Python ou PowerShell.