Azure Data Explorer ダッシュボードでパラメーターを使用する

[アーティクル]
01/23/2024

パラメーターは、Azure Data Explorer ダッシュボードのフィルターの構成要素として使用されます。これらはダッシュボードスコープで管理されます。これらをクエリに追加して、基になるビジュアルによって表示されるデータをフィルター処理することができます。クエリでは、1 つ以上のパラメーターを使用できます。

このドキュメントでは、ダッシュボードでのパラメーターとリンクされたフィルターの作成と使用について説明します。パラメーターは、フィルターバーでパラメーター値を選択するか、クロスフィルターを使用して、ダッシュボードビジュアルをフィルター処理するために使用できます。

この記事で使用するクエリ例は、サンプルギャラリーのStormEventsテーブルに基づいています。

Note

パラメーター管理は、ダッシュボードエディター の編集 モードで使用できます。

前提条件

Azure Data Explorer ダッシュボードを使用してデータを視覚化する
Azure Data Explorer ダッシュボードに対するエディターのアクセス許可
ビジュアルを含むダッシュボード

パラメーターの一覧を表示する

すべてのダッシュボードパラメーターの一覧を表示するには、ダッシュボードの上部にある [パラメーター] ボタンを選択します。

パラメーターを作成する

パラメーターを作成するには:

表示モードから編集モードに切り替えます。
ダッシュボードの上部にある [ パラメーター] ボタンを選択します。
右側のウィンドウの上部にある [ + 新しいパラメーター ] ボタンを選択します。
パラメーターに関連するプロパティを入力します。

サポートされているプロパティ

[ パラメーターの追加 ] ペインで、次のプロパティを構成します。

フィールド	説明
Label	ダッシュボードまたは編集カードに表示されるパラメーターの名前。
パラメーターの種類	次のいずれかのパラメーター: Single selection (単一選択) :パラメーターの入力としてフィルターで値を 1 つのみ選択できます。 Multiple selection (複数選択) :パラメーターの入力としてフィルターで値を 1 つまたは複数選択できます。 [時間範囲] : 時間に基づいてクエリとダッシュボードをフィルター処理するための追加パラメーターを作成できます。既定では、すべてのダッシュボードに時間範囲のピッカーがあります。 Free text (自由記載) : フィルターには値が設定されていません。ユーザーは、テキストフィールドに値を入力するか、値をコピーして貼り付けることができます。フィルターでは、使用された最新の値が保持されます。
[変数名]	クエリで使用されるパラメーターの名前。ヒント: 変数名の先頭にアンダースコア文字 (_) などの固有の文字を付けると、クエリの作成時に見つけやすくなります。
データの種類	パラメーター値のデータ型。
[Show on pages](ページに表示)	このパラメーターが表示されるページを選択します。 [すべて選択] オプションを選択すると、すべてのページにこのパラメーターが表示されます。
ソース	パラメーター値のソース。 Fixed values (固定値) :手動で導入される静的なフィルター値。 Query: KQL クエリを使用して動的に導入される値。
既定値	フィルターの既定値。フィルターは、ダッシュボードの初期レンダリング時に常に既定値で開始されます。
[Add a Select all value](「すべて選択」の値を追加)	単一選択と複数選択のパラメーターの種類にのみ適用されます。すべてのパラメーター値のデータを取得するために使用します。この値は、その機能を提供するためにクエリに組み込む必要があります。このようなクエリを作成するその他の例については、「複数選択クエリベースのパラメーターを使用する」を参照してください。

パラメーターの管理

上部のバーから [パラメーター] を選択すると、既存のパラメーターの一覧を表示できます。各パラメーターカードで、鉛筆ウィジェットを選択してパラメーターを編集するか、[その他 ]...] メニューを選択してパラメーターを複製、削除、または移動します。

パラメーターカードでは、以下の表示を確認することができます。

パラメーターの表示名
変数名
パラメーターが使用されたクエリの数
パラメーターがピン留めされているページ

パラメーターカードは、ドラッグアンドドロップするか、[ 移動 > 先] オプションを使用して新しい場所を選択して並べ替えることができます。

サンプルパラメーターカードのスクリーンショット。

クエリでパラメーターを使用する

フィルターを対象のクエリビジュアルに適用できるようにするには、クエリでパラメーターを使用する必要があります。定義が完了すると、[クエリ] ページのフィルターの上部バーとクエリの intellisense にパラメーターが表示されます。

注意

パラメーターがクエリで使用されていない場合、フィルターは非アクティブなままになります。クエリにパラメーターを追加すると、フィルターがアクティブになります。

パラメーターの種類

次のように、いくつかのダッシュボードパラメーターの種類がサポートされています。

既定の時間範囲パラメーター
単一選択の固定値パラメーター
複数選択の固定値パラメーター
単一選択クエリベースのパラメーター
複数選択クエリベースのパラメーター
フリーテキストパラメーター
データソースパラメーター

次の例では、さまざまなパラメーターの種類に対してクエリでパラメーターを使用する方法について説明します。

既定の時間範囲パラメーター

既定では、すべてのダッシュボードに "時間の範囲" パラメーターがあります。これは、クエリで使用されている場合にのみ、ダッシュボードにフィルターとして表示されます。次の例に示すように、クエリで既定の時間の範囲パラメーターを使用するには、パラメーターキーワード _startTime および _endTime を使用します。

StormEvents
| where StartTime between (_startTime.._endTime)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

保存すると、時間の範囲フィルターがダッシュボードに表示されます。これで、カードでのデータのフィルター処理に使用できるようになります。次のようにドロップダウンから選択して、ダッシュボードをフィルター処理できます。時間の範囲 (過去 x 分/時間/日) または カスタムの時間の範囲。

カスタム時間範囲を使用してフィルター処理する方法を示すスクリーンショット。

単一選択の固定値パラメーター

固定値パラメーターは、ユーザーによって指定された定義済みの値に基づいています。次の例では、単一選択の固定値パラメーターを作成する方法を示します。

単一選択の固定値パラメーターを作成する

[パラメーター] を選択して [パラメーター] ペインを開き、 [新しいパラメーター] を選択します。
詳細を次のように入力します。
- ラベル: イベントの種類
- パラメーターの種類:Single selection (単一選択)
- 変数名: _eventType
- データ型:String
- Pin as dashboard filter (ダッシュボードフィルターとしてピン留め) : オン
- ソース:Fixed values (固定値)
  
  この例では、次の値を使用します。
  
  値パラメーターの表示名
  
  雷雨風雷雨の風
  
  ひょうひょう
  
  鉄砲水フラッシュフラッド
  
  干ばつ干ばつ
  
  冬の天気冬の天気
- Add a Select all value (「すべて選択」の値を追加):オフ
- 既定値: Thunderstorm Wind
[完了] を選択してパラメーターを作成します。

値	パラメーターの表示名
雷雨風	雷雨の風
ひょう	ひょう
鉄砲水	フラッシュフラッド
干ばつ	干ばつ
冬の天気	冬の天気

パラメーターは [ パラメーター ] サイドペインに表示できますが、現在、どのビジュアルでも使用されていません。

単一選択の固定値パラメーターを使用する

変数名を使用して、新しい Event TypTope パラメーターを使用してサンプルクエリを _eventType 実行します。
```
StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType == _eventType
| summarize TotalEvents = count() by State
| top 5 by TotalEvents
```
新しいパラメーターは、ダッシュボードの上部にあるパラメーターの一覧に表示されます。
さまざまな値を選択して、ビジュアルを更新します。

複数選択の固定値パラメーター

固定値パラメーターは、ユーザーによって指定された定義済みの値に基づいています。次の例では、複数選択の固定値パラメーターを作成して使用する方法を示します。

複数選択の固定値パラメーターを作成する

[パラメーター] を選択して [パラメーター] ペインを開き、 [新しいパラメーター] を選択します。
「単一選択の固定値パラメーターを使用する」で説明されているように、次の変更を加えた詳細を入力します。
- ラベル: イベントの種類
- パラメーターの種類:複数選択
- 変数名: _eventType
[完了] を選択してパラメーターを作成します。

新しいパラメーターは [パラメーター] のサイドペインに表示されますが、現在はどのビジュアルでも使用されていません。

複数選択の固定値パラメーターを使用する

変数を使用して、新しい Event Type パラメーターを使用してサンプルクエリを _eventType 実行します。
```
StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents
```
新しいパラメーターは、ダッシュボードの上部にあるパラメーターの一覧に表示されます。
1 つまたは複数の異なる値を選択して、ビジュアルを更新します。

単一選択クエリベースのパラメーター

クエリベースのパラメーター値は、パラメーターのクエリを実行することで、ダッシュボードの読み込み時に取得されます。次の例では、単一選択のクエリベースパラメーターを作成して使用する方法を示します。

単一選択クエリベースのパラメーターを作成する

[パラメーター] を選択して [パラメーター] ペインを開き、 [新しいパラメーター] を選択します。
「単一選択の固定値パラメーターを使用する」で説明されているように、次の変更を加えた詳細を入力します。
- ラベル: 状態
- 変数名: _state
- ソース:クエリ
- データソース: StormEventsSample
- [ クエリの編集] を 選択し、次のクエリを入力します。 [完了] を選択します。
```
StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents
| project State
```
- 値: State
- 表示名: State
- 既定値: 既定値を選択する
[完了] を選択してパラメーターを作成します。

単一選択クエリベースのパラメーターを使用する

新しい State パラメーターを使用した次のサンプルクエリでは、変数を _state 使用します。
```
StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| where State == _state
| summarize TotalEvents = count() by State
| top 5 by TotalEvents
```
新しいパラメーターは、ダッシュボードの上部にあるパラメーターの一覧に表示されます。
さまざまな値を選択して、ビジュアルを更新します。

複数選択クエリベースのパラメーター

クエリベースのパラメーター値は、ユーザー指定のクエリを実行することで、ダッシュボードの読み込み時に取得されます。次の例では、複数選択のクエリベースのパラメーターを作成する方法を示します。

複数選択クエリベースのパラメーターを作成する

[ パラメーター] を 選択して [ パラメーター ] ペインを開き、 [ + 新しいパラメーター] を選択します。
1. 「単一選択の固定値パラメーターを使用する」で説明されているように、次の変更を加えた詳細を入力します。
- ラベル: 状態
- パラメーターの種類:複数選択
- 変数名: _state
[完了] を選択してパラメーターを作成します。

複数選択クエリベースのパラメーターを使用する

次のサンプルクエリでは、変数を使用して新しい State パラメーターを _state 使用します。
```
StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| where State in (_state) or isempty(_state)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents
```
Note

このサンプルでは、isempty() 関数で空の値をチェックすることによって、 [すべて選択] オプションを使用します。

新しいパラメーターは、ダッシュボードの上部にあるパラメーターの一覧に表示されます。
1 つまたは複数の異なる値を選択して、ビジュアルを更新します。

フリーテキストパラメーター

自由記載パラメーターには値は含まれていません。独自の値を取り込むことができます。

自由記載パラメーターを作成する

[ パラメーター] を 選択して [ パラメーター ] ペインを開き、 [ + 新しいパラメーター] を選択します。
詳細を次のように入力します。
- ラベル: 状態
- パラメーターの種類:自由記載
- 変数名: _state
- データ型:String
- 既定値:既定値なし

フリーテキストパラメーターを使用する

変数名を使用して、新しい State パラメーターを使用してサンプルクエリを _state 実行します。

StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| where State contains _state
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

データソースパラメーター

ダッシュボードにデータソースを追加したら、使用可能なデータソースを 1 つ以上選択するパラメーターを作成できます。このパラメーターは、タイルやその他のパラメーターで使用できます。

データソースパラメーターを作成する

[ パラメーター] を 選択して [ パラメーター ] ペインを開き、 [ + 新しいパラメーター] を選択します。
詳細を次のように入力します。
- ラベル: ソース
- パラメーターの種類: データソース
- ページに表示: すべて選択
- 値: すべて選択
- 既定値: StormEventsSample
[完了] を選択します。

新しいパラメーターが、ダッシュボードの上部にあるパラメーター一覧に表示されます。

データソースパラメーターを使用する

新規または既存のタイルのクエリに移動します。
[ ソース] で、[ データソース パラメーター] で新しいパラメーターの名前を選択します。上記で作成したパラメーターについては、[クラスター] を選択 します。
[変更の適用] を選択します。
クラスター パラメーターを使用して、この接続されたクエリのデータソースを変更します。

クロスフィルターパラメーター

クロスフィルターを使用すると、1 つのビジュアルで値を選択できます。また、折れ線グラフや散布図など、すべてのダッシュボードビジュアルがフィルター処理され、関連データのみが表示されます。クロスフィルターを使用すると、ダッシュボード上部のパラメーターリストのパラメーターに相当する値を選択した場合と同じ結果が得られます。

クロスフィルターの定義

クロスフィルターを作成するには、ビジュアルでオプションを有効にし、データのフィルター処理に使用するパラメーターを指定する必要があります。

クロスフィルターを追加するタイルのクエリに移動します。
[ビジュアル] を選択します。
右側のペインで、[相互作用] を選択し、[クロスフィルター] をオンにします。
必要に応じて、 相互作用 の種類を指定します。既定値 は Point で、ビジュアルで値を選択できます。タイムチャートなどの値の範囲を選択するには、[ドラッグ] を選択 します。
値の指定に使用する列と、クエリのフィルター処理に使用するパラメーターの両方を指定します。

重要

列とパラメーターのデータ型は同じである必要があります。

[操作] タブを示すビジュアルの編集ページのスクリーンショット。

クロスフィルターを使用してデータを操作する

クロスフィルターを定義したら、それを使用してデータを操作できます。クロスフィルターを定義したビジュアルで、データポイントを選択し、その値を使用して現在のダッシュボードページをフィルター処理できます。テーブルビジュアルの場合は、関連するセルを右クリックしてデータポイントを選択し、コンテキストメニューの [クロスフィルター] を選択します。

クロスフィルターコンテキストメニューオプションを示すテーブルビジュアルのスクリーンショット。

クロスフィルターをリセットするには、選択したビジュアルの上部にある [リセット] を選択します。

ドリルスルーをダッシュボードのパラメーターとして使用する

ドリルスルーを使用すると、ビジュアル内で値を選択し、その値を使用して同じダッシュボード内のターゲットページ内のビジュアルをフィルター処理できます。ターゲットページをオープンする際に、関連するフィルターで値が事前に選択されます。折れ線グラフや散布図などのページ上のビジュアルがフィルター処理され、関連データのみが表示されます。

ドリルスルーの定義

ドリルスルーを作成するには、まずビジュアル内でドリルスルーをオンにしてから、必要に応じて 1 つ以上のドリルスルーを追加する必要があります。

ドリルスルーを追加しようとしているビジュアルを編集します。 [ビジュアル] タブが選択されていることを確認します。
右側のペインで、[相互作用] を選択してから、[ドリルスルー] をオンにします。

[ドリルスルー] の下で、[新規作成] を選択し、次の情報を指定します。必要に応じて、[別のペアを追加] を選択し、ターゲットページに対して複数のパラメーターを追加します。別のパラメーターを使用して現在のダッシュボード内の他のページにドリルスルーを追加するには、この手順を繰り返します。

フィールド	説明
送信先ページ	定義したパラメーターを使用したドリルスルー先の 1 つ以上のターゲットページ。
列	ターゲットページ内のパラメーターの値として使用する、クエリ結果の列。
パラメーター	列の値を使用したターゲットページ内のビジュアルのフィルター処理に使用するパラメーター。
メモ	省略可能な簡単な説明。

重要

列とパラメーターのペアのデータ型が同じである必要があります。

ドリルスルーを使用してデータを操作する

ドリルスルーを定義し終えたら、それらのドリルスルーを使用してデータを操作できます。そのためには、ドリルスルーを定義したビジュアルまたはテーブルで、データポイントを右クリックし、[Drill through to](ドリルスルー先)>ドリルスルー先ページを選択します。データポイントからの値が、ターゲットページ上のビジュアルをフィルター処理するパラメーターとして使用されます。

ドリルスルー操作を示すダッシュボードビジュアルのスクリーンショット。

ソースページに戻すには、移行先ページの右上にある [リセット] を選択 します。ドリルスルーにより割り当てられたすべてのフィルターがリセットされます。

単一および複数選択フィルターにフィルター検索を使用する

単一および複数選択フィルターに、必要な値を入力します。フィルターが更新され、検索語句に一致する値のみが表示されます。

Azure Data Explorer ダッシュボードでパラメーターを使用する

前提条件

パラメーターの一覧を表示する