Azure へのクエリデータエクスポートを自動化する

[アーティクル]
10/26/2023

Microsoft Entra IDを使用すると、Workplace Analytics のMicrosoft Viva Insightsからのクエリデータのエクスポートを自動化できます。これを行うには、Workplace Analytics の OData クエリリンクを使用して、Azure Data Factoryや Azure Synapse Analytics など、任意の Azure データストアに接続して自動的に更新します。

セットアップパスを選択する

クエリデータと Azure データストア間の自動 OData 接続を設定するには、次のいずれかのパスを使用して、プライベートネットワークと選択したデータストアに関する会社固有の情報 (シークレット) を必要とする新しい Azure 分析アプリを作成して構成します。

Azure Data Factory UI を使用してセットアップする – このパスでは、アプリを作成して登録し、Azure Data Factory UI を使用してデータエクスポート用のデータファクトリを作成する手順を実行します。
Azure Synapse Analytics を使用してセットアップする - このパスでは、アプリを作成して登録し、Azure Synapse Analytics を使用してクエリデータをエクスポートするための OData パイプラインを作成する手順を実行します。
Azure PowerShellを使用してセットアップする – このパスは、アプリを作成して登録し、organizationの特定のパラメーターの入力を求め、データファクトリを作成してデプロイする定義済みのスクリプトを使用して、PowerShell を通じてプロセスをエンドツーエンドで自動化します。

前提条件

Viva Insightsまたは Workplace Analytics アナリスト – Viva Insightsまたは Workplace Analytics のライセンスとアナリストロールを割り当て、エクスポートするデータでクエリ結果を取得する必要があります。
Microsoft Azure サブスクリプション – Azure サブスクリプションをお持ちでない場合は、今すぐ無料アカウントを作成してください。このセットアップには、Microsoft Entra ID、OData コネクタ、Data Factory を使用します。
Azure データストア – データストアは OData コネクタでサポートされている必要があります。
Azure 管理者 – Azure でアプリを作成して登録するには、Azure 管理者特権が必要です。また、新しいアプリを Azure データストアに接続するために、Azure Data Factoryでアクセス許可を付与するように Azure グローバル管理者に依頼する必要もあります。

Azure Data Factory UI を使用してセットアップするには

次の手順では、Azure Data Factory UI を使用して、Workplace Analytics クエリデータの任意の Azure データストアへのエクスポートを自動化する方法について説明します。このセットアップを完了するには、次の手順を Azure ドキュメントと組み合わせて使用します。

「Azure portalを使用してアプリケーションを登録する」の手順に従って、Microsoft Entra IDで新しい分析アプリを作成して登録します。
Microsoft Entra アプリの登録で、手順 1 からアプリを選択し、[API のアクセス許可の表示] を選択して Workplace Analytics にアクセスするためのアクセス許可を付与し、[アクセス許可の追加] を選択します。
Workplace Analytics アプリ名または ID を入力して検索し、一覧から該当する名前を選択します。

アプリケーション (クライアント) ID を検索するには:
- Active Directory で、すべてのアプリケーションを選択し、使用するエンタープライズアプリの Workplace Analytics と入力します。
- 一覧から選択します。
- [アプリケーション ID] で ID をコピーし、organizationが検索フィールドを使用する API に貼り付けます。
[ API のアクセス許可の要求] で、[ アプリケーションのアクセス許可] を選択し、[ アナリスト] を選択し、[ アクセス許可の追加] を選択します。
API のアクセス許可では、次の手順に進む前に、グローバル管理者が [Workplace Analytics...] の管理者の同意を付与するを選択する必要があります。
「データファクトリの作成」の手順に従って、Microsoft Entra ID内に新しい分析データファクトリを作成します。
[Azure Data Factoryの概要] で、[Author & Monitor] を選択してAzure Data Factoryを開きます。

注:

次の手順を完了するには、ブラウザーウィンドウを切り替える必要があるため、すべてのブラウザーウィンドウを開いたままにします。
Azure Data Factoryで、[パイプラインの作成] を選択します。
次のデータセットの省略記号 (...) を選択し、[新しいデータセット] を選択します。詳細については、「Azure Data Factoryのデータセット」を参照してください。
[データストアの選択] に「odata」と入力し、[OData] を選択します。
[ 全般] に、リンク先のクエリデータの名前と説明を入力します。
[ 接続] を選択し、[ 新規] を選択し、 OData リンクの名前と説明 (WPA_Odata_Collabなど) を入力します。
[ 統合ランタイム経由で接続する] で、[ AutoResolveIntegrationRuntime] を選択します。
Workplace Analytics で、[クエリデザイナー>の結果の分析>] を選択し、Azure に接続するクエリデータの OData リンクをコピーします。

重要

自動的に更新されるデータの場合は、Workplace Analytics の [自動更新 ] オプションを使用するクエリにリンクする必要があります。静的クエリ結果の場合は、接続されている Azure データストア内のクエリデータを更新するために、毎回新しい OData リンクを入力する必要があります。
[ サービス URL] に、前の手順でコピーしたクエリ OData リンクを貼り付けます。
リソースMicrosoft Entraに「」と入力しますhttps://workplaceanalytics.office.com。
Active Directory で、新しいアプリの [概要] を選択し、アプリケーション (クライアント) ID をコピーします。
[Azure Data Factory>新しいリンクされたサービスサービス>プリンシパル ID] で、クライアント ID をコピーします。詳細については、「リンクされたサービスプロパティを示すスクリーンショット」を参照してください。
[認証の種類] で、[キーを使用Microsoft Entraサービスプリンシパル] または [Cert を使用Microsoft Entraサービスプリンシパル] を選択します。別のブラウザーウィンドウで [新しいリンクされたサービス (OData)] を開いたままにします。これらのオプションの詳細については、「パイプラインアクティビティで Azure Key Vault シークレットを使用する」を参照してください。
新しく登録した分析アプリMicrosoft Entra ID>で、[証明書 & シークレット] を選択し、次のいずれかの操作を行います。
- [キー認証] で [ 新しいクライアントシークレット ] を選択し、[ クライアントシークレットの追加] で説明を入力し、有効期限が切れた時点を選択して、[ 追加] を選択します。 [ クライアントシークレット] で、新しいシークレットを選択し、[ コピー] アイコン を選択してコピーします。
- [証明書認証 ] (セキュリティを強化するために推奨) の場合は、証明書を選択してコピーします。
Azure Data Factoryで、該当する認証の種類に対して次の操作を行います。
- [サービスプリンシパルキー] に、前の手順でコピーした新しいクライアントシークレットを サービスプリンシパルキーに貼り付けます。
- Azure キーコンテナーの場合は、証明書とその他の必要な情報をコピーして貼り付けます。詳細については、「Azure Key Vault からシークレットを設定して取得する」を参照してください。
[ 接続のテスト] を選択して、OData のリンクされたサービスをテストします。
[接続が成功しました] が表示されたら、[作成] を選択します。
[新しい ODataリンクされたサービスの接続>リンクされたサービス] で、前の手順で作成した新しいデータセットを選択します。
[ 接続>パス] で [ 編集] を選択し、 エンティティセット名を入力します。これを見つけるには、 Workplace Analytics>Analyze>クエリデザイナー>の [結果] から OData クエリリンクをコピーし、新しいブラウザーウィンドウでクエリリンクを開きます。 メタデータを検索してエンティティ名を見つけます。エンティティ名は、$metadata# の後に表示されます。たとえば、次の図に示すエンティティセット名は Persons です。
パスの [データのプレビュー ] を選択して、正しいエンティティを入力したことを確認します。
Azure Data Factory>Properties で、この新しいデータセットの名前と説明を確認します。
上部 にある [すべて発行] を選択し、[ 発行] を選択します。
[パイプライン] で、新しい OData データセットを使用してクエリデータを外部リソースにコピーできる新しいパイプラインを作成します。詳細については、「パイプラインの作成」を参照してください。
新しいパイプラインで [ ソース] を選択し、[ ソースデータセット] で新しい OData データセットの名前を選択し、[ クエリの使用] で [テーブル] を選択します。
エクスポート先のデータストアのリンクされたサービスを作成します。詳細については、「リンクされたサービス」を参照してください。
Azure Data Factory>Author で、次の図に示すように、新しいパイプラインを選択し、[トリガー>トリガーを今すぐ追加] を選択して、最後に発行されたパイプラインを手動で実行します。 [Add triggerNew/Edit New]$新しいトリガーの追加/編集>$ を選択して、この新しいパイプラインのトリガー>をスケジュールし、それに必要な情報を入力することもできます。詳細については、「Azure Data Factoryのパイプラインの実行とトリガー」を参照してください。
>シンクシンクデータセットで、前の手順で作成したリンクされたサービス名を選択します。

その後、この新しいデータファクトリを使用して、Workplace Analytics からクエリデータにアクセスし、Azure Resource Manager テンプレートを使用して選択したデータストア (BLOB ストレージ) にコピーできます。これらの手順を繰り返すことなく、この新しいアプリを複数のプロジェクトに対して時間をかけて再利用できます。また、新しいパイプライン用に作成したデータファクトリを再利用することもできます。

Azure Synapse Analytics を使用して設定するには

次の手順では、Azure Synapse Analytics を使用して、選択した Azure データストアへの Workplace Analytics クエリデータのエクスポートを自動化する方法について説明します。このセットアップを完了するには、次の手順を Azure ドキュメントと組み合わせて使用します。

「Azure portalを使用してアプリケーションを登録する」の手順に従って、Microsoft Entra IDで新しい分析アプリを作成して登録します。
Microsoft Entra アプリの登録で、手順 1 からアプリを選択し、[API のアクセス許可の表示] を選択して Workplace Analytics にアクセスするためのアクセス許可を付与し、[アクセス許可の追加] を選択します。
Workplace Analytics または Viva Insights アプリ名または ID を入力して検索し、一覧から該当する名前を選択します。

アプリケーション (クライアント) ID を検索するには:
- Active Directory で、すべてのアプリケーションを選択し、使用するエンタープライズアプリの Workplace Analytics または Viva Insights を入力します。
- 一覧から選択します。
- [アプリケーション ID] で ID をコピーし、organizationが検索フィールドを使用する API に貼り付けます。
[ API のアクセス許可の要求] で、[ アプリケーションのアクセス許可] を選択し、[ アナリスト] を選択し、[ アクセス許可の追加] を選択します。
API のアクセス許可では、次の手順に進む前に、グローバル管理者が [Workplace Analytics...] の管理者の同意を付与するを選択する必要があります。
「Synapse ワークスペースの作成」の手順に従って、Azure portal内に新しい Synapse ワークスペースを作成します。
ポータルのAzure Synapse リソースで、[Synapse Studioを開く] を選択して、Azure Synapse ワークスペースを開きます。

注:

次の手順を完了するには、ブラウザーウィンドウを切り替える必要があるため、すべてのブラウザーウィンドウを開いたままにします。
Azure Synapse Studio で、[統合] を選択し、パイプラインを追加します。
新しい [パイプラインアクティビティ] メニューで、[ 移動と変換] を選択し、[ データのコピー ] をパイプラインワークスペースにドラッグします。
次のデータセットの省略記号 (...) を選択し、[新しいデータセット] を選択します。
[ ソース ] セクションで、新しいソースを追加します。
[新しい統合データセット] に「odata」と入力し、[OData] を選択します。
[ プロパティの設定] で、名前を入力し、新しいリンクされたサービスを作成します。
[ 新しいリンクされたサービス (Odata)] に、リンク先のクエリデータの名前と説明を入力します。
[ 統合ランタイム経由で接続する] で、[ AutoResolveIntegrationRuntime] を選択します。
Workplace Analytics のViva Insightsで、[クエリデザイナー>の結果の分析>] を選択し、Azure に接続するクエリデータの OData リンクをコピーします。

重要

自動的に更新されるデータの場合は、[自動更新] オプションを使用するクエリにリンクする必要があります。静的クエリ結果の場合は、接続されている Azure データストア内のクエリデータを更新するために、毎回新しい OData リンクを入力する必要があります。
[新しいリンクされたサービス URL] Azure Synapse、前の手順でコピーしたクエリ OData リンクを貼り付けます。
リソースMicrosoft Entraに「」と入力しますhttps://workplaceanalytics.office.com。
Active Directory で、新しいアプリの [概要] を選択し、アプリケーション (クライアント) ID をコピーします。
Azure Synapse Studio>New Linked Service (Odata)>Service プリンシパル ID で、クライアント ID をコピーします。詳細については、「リンクされたサービスのプロパティ」を参照してください。
[認証の種類] で、[キーを使用Microsoft Entraサービスプリンシパル] または [Cert を使用Microsoft Entraサービスプリンシパル] を選択します。別のブラウザーウィンドウで [新しいリンクされたサービス (OData)] を開いたままにします。これらのオプションの詳細については、「パイプラインアクティビティで Azure Key Vault シークレットを使用する」を参照してください。
新しく登録した分析アプリMicrosoft Entra ID>で、[証明書 & シークレット] を選択し、次のいずれかの操作を行います。
- [ キー認証] で [ 新しいクライアントシークレット] を選択し、[ クライアントシークレットの追加] で説明を入力し、有効期限が切れた時点を選択して、[ 追加] を選択します。 [ クライアントシークレット] で、新しいシークレットを選択し、[ コピー ] アイコンを選択してコピーします。
- [ 証明書認証 ] (セキュリティを強化するために推奨) の場合は、証明書を選択してコピーします。
Azure Synapse Studio で、該当する認証の種類に対して次の操作を行います。
- [サービスプリンシパルキー] に、前の手順でコピーした新しいクライアントシークレットを サービスプリンシパルキーに貼り付けます。
- Azure キーコンテナーの場合は、証明書とその他の必要な情報をコピーして貼り付けます。詳細については、「Azure Key Vault からシークレットを設定して取得する」を参照してください。
[ 接続のテスト] を選択して、OData のリンクされたサービスをテストします。
[接続が成功しました] が表示されたら、[作成] を選択します。
[ プロパティの設定>] 新 しい OData リンクされたサービスのリンクされたサービスで、前の手順で作成した新しいリンクされたサービスを選択します。
[ ソース>パス] で [ 編集] を選択し、 エンティティセット名を入力します。これを見つけるには、 Workplace Analytics>Analyze>クエリデザイナー>の [結果] から OData クエリリンクをコピーし、新しいブラウザーウィンドウでクエリリンクを開きます。次に 、メタデータ を検索してエンティティ名を見つけます。エンティティ名は 、$metadata# の後に表示されます。たとえば、次の図に示すエンティティセット名は Persons です。
パスの [データのプレビュー ] を選択して、正しいエンティティを入力したことを確認します。
[シンク] セクションで、新しいシンクデータセットを追加し、[新しい統合データセット] で [Azure Data Lake Storage Gen2] を選択し、[続行] を選択します。
[ 書式の選択] で、[ 区切りテキスト] を選択し、[続行] を選択 します。
[ プロパティの設定] で、名前を入力し、[ 先頭行] をヘッダーとして選択し、既定の Synapse ストレージアカウント (既にリンクされている) を選択するか、新しいリンクされたサービスを作成します。
ストレージ内のコピー先ファイルのファイルパスを入力します。 [ファイル] を空のままにすると、コピーパイプラインによって、コピー先ディレクトリ内のファイルの名前が自動的に生成されます。
検証し、成功した場合は、上部 にある [すべて発行 ] を選択します。
正常に発行されたら、[ トリガーの追加] を選択し、[ 今すぐトリガー] を選択するか、トリガーを選択します。
正常に実行されたら、Azure Data Lake Linked Service に移動して、転送されたデータを見つけます。 [ その他の>更新] を選択して、利用可能な最新のデータを表示します。