Создание монитора заданий Stream Analytics программным способом

  • Статья

В этой статье рассказывается, как включить функцию отслеживания задания Stream Analytics. Отслеживание заданий Stream Analytics, созданных с помощью интерфейсов API REST, пакета SDK для Azure и оболочки PowerShell, по умолчанию отключено. Вы можете вручную включить отслеживание на портале Azure. Для этого перейдите на страницу "Отслеживание" задания и нажмите кнопку "Включить". Этот процесс также можно автоматизировать, выполнив описанные в этой статье действия. Данные отслеживания будут отображаться в области метрики на портале Azure для задания Stream Analytics.

Необходимые компоненты

Прежде чем начать этот процесс, необходимо следующее:

  • Visual Studio 2019 или 2015
  • Скачанный и установленный пакет SDK Azure для .NET.
  • Существующее задание Stream Analytics, отслеживание которого нужно включить.

Создание проекта

  1. Создайте консольное приложение Visual Studio C# .NET.

  2. В консоли диспетчера пакетов выполните следующие команды, чтобы установить пакеты NuGet. Первый — пакет SDK для .NET для управления Azure Stream Analytics. Второй — пакет SDK для Azure Monitor, который будет использоваться для включения отслеживания. Последним является клиент Microsoft Entra, который будет использоваться для проверки подлинности.

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

  3. Добавьте следующий раздел appSettings в файл 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>

    Замените значения SubscriptionId и ActiveDirectoryTenantId идентификаторами подписки Azure и клиента. Вы можете получить эти значения, запустив следующий командлет Azure PowerShell:

    Get-AzureAccount

  4. Добавьте следующие инструкции с оператором using в исходный файл (Program.cs) в проекте.

      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. Добавьте вспомогательный метод проверки подлинности.

    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");
}

Создание клиентов управления

С помощью следующего кода можно настроить необходимые переменные и клиенты управления.

 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);

Включение отслеживания существующего задания Stream Analytics

С помощью следующего кода можно включить отслеживание имеющегося задания Stream Analytics. В первой части кода в службу Stream Analytics отправляется запрос GET, что позволяет получить сведения о конкретном задании Stream Analytics. Во второй части кода, где запрос PUT отправляется в службу Insights для включения отслеживания задания Stream Analytics, свойство ID (полученное в результате выполнения запроса GET) используется в качестве параметра метода Put.

Предупреждение

Если ранее вы включили функцию отслеживания для другого задания Stream Analytics либо на портале Azure, либо программным способом с помощью указанного ниже кода, мы рекомендуем использовать ту же учетную запись хранения, которую вы использовали для включения функции отслеживания.

Учетная запись хранения связана с регионом, в котором вы создали свое задание Stream Analytics, а не с самим заданием.

Все задания Stream Analytics (и все остальные ресурсы Azure) в этом регионе совместно используют эту учетную запись хранения для хранения данных отслеживания. Если указать другую учетную запись хранения, это может привести к непредвиденным побочным эффектам при отслеживании других заданий Stream Analytics или других ресурсов Azure.

Имя учетной записи хранения, используемой для замены <YOUR STORAGE ACCOUNT NAME> в следующем коде, должно представлять собой учетную запись хранения, которая входит в ту же подписку, что и задание Stream Analytics, для которого вы включаете функцию отслеживания.

// 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);

Поддержка

За дополнительной информацией перейдите на страницу вопросов и ответов об Azure Stream Analytics.

Следующие шаги