Stream Analytics ジョブモニターをプログラムで作成する

[アーティクル]
06/01/2023

この記事では、Stream Analytics ジョブの監視を有効にする方法を示します。 REST API、Azure SDK、または PowerShell を介して作成された Stream Analytics ジョブの監視は、既定では有効になっていません。 Azure Portal で、ジョブの [監視] ページに移動し、[有効にする] ボタンをクリックして、手動で監視を有効にできます。または、この記事にある手順に従って、有効にするプロセスを自動化することもできます。監視データは、Azure Portal の Stream Analytics ジョブの [メトリック] 領域に表示されます。

前提条件

このプロセスを開始する前に、以下の前提条件を満たしている必要があります。

Visual Studio 2019 または 2015
Azure .NET SDK のダウンロードとインストール
監視を有効にする必要がある、既存の Stream Analytics ジョブ

プロジェクトの作成

Visual Studio C# .NET コンソールアプリケーションを作成します。
パッケージマネージャーコンソールで、次のコマンドを実行して NuGet パッケージをインストールします。 1 つ目は、Azure Stream Analytics 管理用 .NET SDK です。 2 つ目は、監視を有効にするために使用される Azure Monitor SDK です。最後の 1 つは、認証で使用する Microsoft Entra クライアントです。
```
Install-Package Microsoft.Azure.Management.StreamAnalytics
Install-Package Microsoft.Azure.Insights -Pre
Install-Package Microsoft.IdentityModel.Clients.ActiveDirectory
```

次の 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 サブスクリプションとテナント ID に置き換えます。次の PowerShell コマンドレットを実行すると、これらの値を取得できます。

Get-AzureAccount

次の 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;

認証ヘルパーメソッドを追加します。

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 ジョブに関する情報を取得します。コードの後半部分では、GET 要求で取得した ID プロパティを PUT メソッド用のパラメーターとして使用します。これにより、PUT 要求が Insights サービスに送信され、Stream Analytics ジョブの監視が有効になります。

警告

Azure Portal から、または次のコードを使用してプログラムにより、別の Stream Analytics ジョブの監視を有効にしている場合、前に監視を有効にしたときに使用したのと同じストレージアカウント名を指定することをお勧めします。

ストレージアカウントは、特定のジョブ自体ではなく、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 に関する Microsoft Q&A 質問ページを参照してください。

Stream Analytics ジョブモニターをプログラムで作成する

前提条件

プロジェクトの作成

管理クライアントの作成

既存の Stream Analytics ジョブに対する監視の有効化

サポートを受ける

次のステップ

その他のリソース

Stream Analytics ジョブ モニターをプログラムで作成する

前提条件

プロジェクトの作成

管理クライアントの作成

既存の Stream Analytics ジョブに対する監視の有効化

サポートを受ける

次のステップ

その他のリソース

Stream Analytics ジョブモニターをプログラムで作成する