Azure Time Series Insights Gen2 からのデータのクエリ
手記
Time Series Insights サービスは、2024 年 7 月 7 日に廃止されます。 既存の環境をできるだけ早く別のソリューションに移行することを検討してください。 非推奨と移行の詳細については、
Azure Time Series Insights Gen2 を使用すると、パブリック サーフェス API を使用して、環境に格納されているイベントとメタデータに関するデータ クエリを実行できます。 これらの API は、Azure Time Series Insights TSI Explorerでも使用されます。
Azure Time Series Insights Gen2 では、次の 3 つの主要な API カテゴリを使用できます。
- 環境 API: これらの API は、Azure Time Series Insights Gen2 環境自体に対するクエリを有効にします。 これらを使用して、呼び出し元がアクセスできる環境と環境メタデータの一覧を収集できます。
- Time Series Model-Query (TSM-Q) API: 環境のタイム シリーズ モデルに格納されているメタデータに対する作成、読み取り、更新、および削除 (CRUD) 操作を有効にします。 これらは、インスタンス、型、階層にアクセスして編集するために使用できます。
- Time Series Query (TSQ) API: ソース プロバイダーから記録されたテレメトリまたはイベント データの取得を有効にし、高度なスカラー関数と集計関数を使用してデータに対するパフォーマンスの高い計算と集計を可能にします。
Azure Time Series Insights Gen2 では、時系列変数で計算を表現するために、豊富な文字列ベースの式言語である Time Series Expression (TSX)を使用します。
Azure Time Series Insights Gen2 API の概要
次のコア API がサポートされています。
環境API
- 環境の取得 API: 呼び出し元がアクセスを許可されている環境の一覧を返します。
-
環境可用性 APIの取得: イベント タイムスタンプ
$ts
に対するイベント数の分布を返します。 この API は、時間の間隔に分割されたイベントの数 (存在する場合) を返すことによって、環境内にイベントがあるかどうかを判断するのに役立ちます。 - イベント スキーマ APIの取得: 特定の検索範囲のイベント スキーマ メタデータを返します。 この API は、特定の検索範囲のスキーマで使用可能なすべてのメタデータとプロパティを取得するのに役立ちます。
Time Series Model-Query (TSM-Q) API
これらの API のほとんどは、複数のタイム シリーズ モデル エンティティでバッチ CRUD 操作を有効にするバッチ実行操作をサポートしています。
- モデル設定 API: 既定 種類と環境のモデル名に対して GET と PATCH を有効にします。
- 型 API: 時系列型とそれに関連付けられている変数に対して CRUD を有効にします。
- 階層 API: 時系列階層とそれに関連付けられているフィールド パスで CRUD を有効にします。
-
インスタンス API: Time Series インスタンスとそれに関連付けられているインスタンス フィールドで CRUD を有効にします。 さらに、Instances API では次の操作がサポートされています。
- 検索: インスタンス属性に基づいて、時系列インスタンスの検索でヒット数の一部を取得します。
- の提案: インスタンス属性に基づいて時系列インスタンスの検索を行い、見つかったヒットの一部を提案します。
タイム シリーズ クエリ (TSQ) アプリケーション プログラミング インターフェース (API)
これらの API は、多層ストレージ ソリューションの両方のストア (ウォームとコールド) で利用できます。
イベントの取得 API: ソース プロバイダーから Azure Time Series Insights Gen2 に記録される生イベントと関連するイベント タイムスタンプのクエリと取得を有効にします。 この API を使用すると、特定のタイム シリーズ ID と検索スパンの生イベントを取得できます。 この API では、選択した入力の完全な応答データセットを取得するための改ページがサポートされています。
大事な
JSON のフラット化とエスケープの規則
今後の変更の一環として、配列は動的 型 を介してのみ格納されます。 Get Events API アクセス可能な、この型として格納されるペイロードプロパティ。 シリーズの取得 API: 生のイベントに対して変数によって定義された計算を適用することで、計算値と関連するイベント タイムスタンプのクエリと取得を有効にします。 これらの変数は、タイム シリーズ モデルで定義することも、クエリでインラインで指定することもできます。 この API では、選択した入力の完全な応答データセットを取得するための改ページがサポートされています。
集計シリーズ API: 未加工のイベントに変数によって定義された計算を適用することで、集計値と関連する間隔タイムスタンプのクエリと取得を有効にします。 これらの変数は、タイム シリーズ モデルで定義することも、クエリでインラインで指定することもできます。 この API では、選択した入力の完全な応答データセットを取得するための改ページがサポートされています。
指定された検索範囲と間隔の場合、この API は、時系列 ID の変数ごとに間隔ごとに集計された応答を返します。 応答データセット内の間隔の数は、エポック ティック (Unix エポックから経過したミリ秒の数 - 1970 年 1 月 1 日) をカウントし、ティックをクエリで指定された間隔スパン サイズで除算することによって計算されます。
応答セットで返されるタイムスタンプは、間隔内のサンプリングされたイベントのものではなく、左側の区間境界を表しています。
ストアの種類の選択
上記の API は、1 回の呼び出しで 2 つのストレージの種類 (Cold または Warm) のいずれかに対してのみ実行できます。 クエリ URL パラメーターは、クエリを実行する
パラメーターが指定されていない場合、クエリは既定でコールド ストアで実行されます。 クエリがコールド ストアとウォーム ストアの両方と重複する時間範囲にまたがる場合は、ウォーム ストアには部分的なデータのみが含まれるため、最適なエクスペリエンスを得るためにクエリをコールド ストアにルーティングすることをお勧めします。
Azure Time Series Insights Explorer と power BI Connector 上記の API を呼び出し、適切な storeType パラメーターが自動的に選択されます。
次の手順
- タイム シリーズ モデルで定義できるさまざまな変数の詳細を参照してください。
- Azure Time Series Insights Explorerからデータを照会する方法の詳細を確認します。