Azure Time Series Insights Gen2 からのデータのクエリ

  • [アーティクル]

注意

Time Series Insights (TSI) サービスは、2025 年 3 月以降はサポートされなくなります。 できるだけ早く既存の TSI 環境を代替ソリューションに移行することを検討してください。 サポートの終了と移行の詳細については、こちらのドキュメントを参照してください。

Azure Time Series Insights Gen2 では、パブリック サーフェス API を使用して、環境に格納されているイベントおよびメタデータのデータのクエリを実行できます。 これらの API は、Azure Time Series Insights TSI Explorer でも使用されます。

Azure Time Series Insights Gen2 では、3 つの主要な API カテゴリを使用できます。

  • Environment 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) を、Time Series 変数での計算の記述に使用します。

Azure Time Series Insights Gen2 API の概要

次のコア API がサポートされています。

Time Series Query の概要

Environment API

  • Environment API の取得:呼び出し元がアクセスを許可されている環境の一覧が返されます。
  • Environments Availability API の取得:: イベントのタイムスタンプ に対するイベント数の分布が返されます。 この API は、イベントが存在する場合に、時間間隔ごとにイベントの数を返すため、環境にイベントがあるかどうかを判断するのに役立ちます。
  • Get Event Schema API:特定の検索範囲に対するイベント スキーマのメタデータが返されます。 この API は、特定の検索範囲に対してスキーマで使用できるすべてのメタデータとプロパティを取得するのに役立ちます。

Time Series Model-Query (TSM-Q) API

これらの API のほとんどでバッチ実行操作がサポートされるため、複数のタイム シリーズ モデル エンティティに対してバッチ CRUD 操作を実行できます。

  • Model Settings API:環境の既定の型とモデル名を GET および PATCH できます。
  • Types API:タイム シリーズの種類とそれに関連する変数に対して CRUD を実行できます。
  • Hierarchies API:タイム シリーズの階層とそれに関連するフィールド パスに対して CRUD を実行できます。
  • Instances API:タイム シリーズのインスタンスとそれに関連するインスタンス フィールドに対して CRUD を実行できます。 さらに、Instances API は次の操作もサポートしています。
    • Search:インスタンス属性に基づいて、時系列インスタンス検索のヒットの部分リストを取得します。
    • Suggest:インスタンス属性に基づいて、時系列インスタンス検索のヒットの部分リストを検索しサジェストします。

Time Series Query (TSQ) API

これらの API は、多層ストレージ ソリューションの両方のストア (ウォームとコールド) 全体で利用できます。

  • Get Events API:未加工のイベントおよび関連するイベント タイムスタンプのクエリと取得を実行できます。これらは、ソース プロバイダーから Azure Time Series Insights Gen2 に記録されるためです。 この API を使用すると、特定の時系列 ID と検索範囲に対する未加工のイベントを取得できます。 この API は、改ページ位置の自動修正をサポートしており、選択した入力に対する完全な応答データセットを取得できます。

    重要

    JSON のフラット化とエスケープの規則への今後の変更の一部として、配列が動的型として格納されます。 この型として格納されているペイロード プロパティは、Get Events API を通じてのみアクセスできます。

  • Get Series API:未加工イベントの変数によって定義された計算を適用することで、計算値と関連するイベント タイムスタンプのクエリと取得を実行できます。 これらの変数は、タイム シリーズ モデルで定義することもクエリでインラインで指定することもできます。 この API は、改ページ位置の自動修正をサポートしており、選択した入力に対する完全な応答データセットを取得できます。

  • Aggregate Series API:未加工イベントの変数によって定義された計算を適用することで、集計値と関連する間隔タイムスタンプのクエリと取得を実行できます。 これらの変数は、タイム シリーズ モデルで定義することもクエリでインラインで指定することもできます。 この API は、改ページ位置の自動修正をサポートしており、選択した入力に対する完全な応答データセットを取得できます。

    この API は、指定された検索範囲と間隔で、タイム シリーズ ID の変数ごとの各間隔で集計された応答を返します。 応答データセット内の間隔の数は、エポック ティック (Unix エポック - 1970 年 1 月 1 日以降の経過時間 (ミリ秒)) をカウントし、クエリで指定された間隔のサイズでティックを割ることによって計算されます。

    応答セットで返されるタイムスタンプは、間隔からサンプリングされたイベントのものではなく、残された間隔境界のものです。

ストアの種類の選択

上記の API は、1 回の呼び出しで 2 つのストレージの種類 (コールドまたはウォーム) のいずれかに対してのみ実行できます。 クエリ URL パラメーターは、クエリを実行する必要があるストアの種類を指定するために使用されます。

パラメーターを指定しない場合、クエリは既定ではコールド ストアで実行されます。 クエリがコールドとウォームの両方のストアで重複する時間範囲に及ぶ場合、ウォーム ストアには部分的なデータしか含まれないため、最善のエクスペリエンスを実現するには、コールド ストアにクエリをルーティングすることをお勧めします。

Azure Time Series Insights Explorer および Power BI コネクタ によって上記の API が呼び出され、関連する適切な storeType パラメーターが自動的に選択されます。

次のステップ