Créer la surveillance des tâches Stream Analytics par programmation

  • Article

Cet article explique comment activer la surveillance d'une tâche Stream Analytics. Par défaut, la surveillance n'est pas activée pour les travaux Stream Analytics créés par le biais des API REST, du kit de développement logiciel (SDK) Azure ou de PowerShell. Vous pouvez l’activer manuellement sur le portail Azure. Pour cela, accédez à la page Surveiller du travail et cliquez sur le bouton Activer. Vous pouvez également automatiser ce processus en suivant les étapes décrites dans cet article. Les données de surveillance sont affichées dans la zone Métriques du portail Azure pour le travail Stream Analytics.

Prérequis

Avant de commencer à lire ce processus, vous devez disposer des éléments suivants :

Création d’un projet

  1. Créez une application console Visual Studio .NET C#.

  2. Dans la console du Gestionnaire de package, exécutez les commandes suivantes pour installer les packages NuGet. Le premier est le Kit de développement logiciel (SDK) .NET de gestion Azure Stream Analytics. Le second est le SDK Azure Monitor qui sera utilisé pour activer la surveillance. Le dernier est le client Microsoft Entra qui sera utilisé pour l’authentification.

    Install-Package Microsoft.Azure.Management.StreamAnalytics
Install-Package Microsoft.Azure.Insights -Pre
Install-Package Microsoft.IdentityModel.Clients.ActiveDirectory

  3. Ajoutez la section appSettings suivante au fichier App.config.

    <appSettings>
  <!--CSM Prod related values-->
  <add key="ResourceGroupName" value="RESOURCE GROUP NAME" />
  <add key="JobName" value="YOUR JOB NAME" />
  <add key="StorageAccountName" value="YOUR STORAGE ACCOUNT"/>
  <add key="ActiveDirectoryEndpoint" value="https://login.microsoftonline.com/" />
  <add key="ResourceManagerEndpoint" value="https://management.azure.com/" />
  <add key="WindowsManagementUri" value="https://management.core.windows.net/" />
  <add key="AsaClientId" value="1950a258-227b-4e31-a9cf-717495945fc2" />
  <add key="RedirectUri" value="urn:ietf:wg:oauth:2.0:oob" />
  <add key="SubscriptionId" value="YOUR AZURE SUBSCRIPTION ID" />
  <add key="ActiveDirectoryTenantId" value="YOUR TENANT ID" />
</appSettings>

    Remplacez les valeurs de SubscriptionId et ActiveDirectoryTenantId par votre ID d’abonnement et votre ID de locataire Azure. Vous pouvez obtenir ces valeurs en exécutant l'applet de commande PowerShell suivante :

    Get-AzureAccount

  4. Ajoutez les instructions using suivantes au fichier source (Program.cs) dans le projet.

      using System;
  using System.Configuration;
  using System.Threading;
  using Microsoft.Azure;
  using Microsoft.Azure.Management.Insights;
  using Microsoft.Azure.Management.Insights.Models;
  using Microsoft.Azure.Management.StreamAnalytics;
  using Microsoft.Azure.Management.StreamAnalytics.Models;
  using Microsoft.IdentityModel.Clients.ActiveDirectory;

  5. Ajoutez une méthode d'aide pour l'authentification.

    public static string GetAuthorizationHeader()
{
   AuthenticationResult result = null;
   var thread = new Thread(() =>
   {
      try
      {
          var context = new AuthenticationContext(
             ConfigurationManager.AppSettings["ActiveDirectoryEndpoint"] +
             ConfigurationManager.AppSettings["ActiveDirectoryTenantId"]);
          result = context.AcquireToken(
              resource: ConfigurationManager.AppSettings["WindowsManagementUri"],
              clientId: ConfigurationManager.AppSettings["AsaClientId"],
              redirectUri: new Uri(ConfigurationManager.AppSettings["RedirectUri"]),
              promptBehavior: PromptBehavior.Always);
      }
      catch (Exception threadEx)
      {
          Console.WriteLine(threadEx.Message);
      }
  });

  thread.SetApartmentState(ApartmentState.STA);
  thread.Name = "AcquireTokenThread";
  thread.Start();
  thread.Join();

  if (result != null)
  {
      return result.AccessToken;
  }
      throw new InvalidOperationException("Failed to acquire token");
}

Création de clients de gestion

Le code suivant définit les variables nécessaires et les clients de gestion.

 string resourceGroupName = "<YOUR AZURE RESOURCE GROUP NAME>";
 string streamAnalyticsJobName = "<YOUR STREAM ANALYTICS JOB NAME>";

 // Get authentication token
 TokenCloudCredentials aadTokenCredentials =
     new TokenCloudCredentials(
         ConfigurationManager.AppSettings["SubscriptionId"],
         GetAuthorizationHeader());

 Uri resourceManagerUri = new
 Uri(ConfigurationManager.AppSettings["ResourceManagerEndpoint"]);

 // Create Stream Analytics and Insights management client
 StreamAnalyticsManagementClient streamAnalyticsClient = new
 StreamAnalyticsManagementClient(aadTokenCredentials, resourceManagerUri);
 InsightsManagementClient insightsClient = new
 InsightsManagementClient(aadTokenCredentials, resourceManagerUri);

Activation de la surveillance pour un travail Stream Analytics existant

Le code suivant permet d'activer la surveillance pour un travail Stream Analytics existant. La première partie du code exécute une requête GET sur le service Stream Analytics pour récupérer des informations sur le travail Stream Analytics spécifique. Elle utilise la propriété ID (récupérée à partir de la requête GET) en tant que paramètre pour la méthode Put dans la seconde moitié du code qui envoie une requête PUT au service Insights afin d'activer la surveillance du travail Stream Analytics.

Avertissement

Si vous avez déjà activé la surveillance pour un travail Stream Analytics différente par le passé, via le portail Azure ou par programmation via le code ci-dessous, nous vous recommandons de fournir le même nom de compte de stockage que celui utilisé lors de l’activation de la surveillance.

Le compte de stockage est lié à la région dans laquelle vous avez créé la tâche Stream Analytics, pas spécifiquement à la tâche en soi.

Tous les travaux Stream Analytics (et l’ensemble des autres ressources Microsoft Azure) d’une même région partagent ce compte de stockage afin d’y consigner les données de surveillance. Si vous communiquez un compte de stockage différent, cela peut entraîner des effets collatéraux imprévus sur la surveillance de vos autres travaux Stream Analytics ou autres ressources Microsoft Azure.

Le compte de stockage utilisé pour remplacer <YOUR STORAGE ACCOUNT NAME> dans le code ci-dessous doit être un compte de stockage qui se trouve dans l’abonnement du travail Stream Analytics pour lequel vous avez activé la surveillance.

// Get an existing Stream Analytics job
 JobGetParameters jobGetParameters = new JobGetParameters()
 {
     PropertiesToExpand = "inputs,transformation,outputs"
 };
 JobGetResponse jobGetResponse = streamAnalyticsClient.StreamingJobs.Get(resourceGroupName, streamAnalyticsJobName, jobGetParameters);

// Enable monitoring
ServiceDiagnosticSettingsPutParameters insightPutParameters = new ServiceDiagnosticSettingsPutParameters()
{
        Properties = new ServiceDiagnosticSettings()
       {
           StorageAccountName = "<YOUR STORAGE ACCOUNT NAME>"
       }
};
insightsClient.ServiceDiagnosticSettingsOperations.Put(jobGetResponse.Job.Id, insightPutParameters);

Obtenir de l’aide

Pour obtenir de l’aide supplémentaire, essayez notre page de questions Microsoft Q&A pour Azure Stream Analytics.

Étapes suivantes