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

Azure Time Series Insights Gen2 では、パブリック サーフェス API を使用して、環境に格納されているイベントおよびメタデータのデータのクエリを実行できます。Azure Time Series Insights Gen2 enables data querying on events and metadata stored in the environment via public surface APIs. これらの API は、Azure Time Series Insights TSI Explorer でも使用されます。These APIs also are used by the Azure Time Series Insights TSI Explorer.

Azure Time Series Insights Gen2 では、3 つの主要な API カテゴリを使用できます。Three primary API categories are available in Azure Time Series Insights Gen2:

  • Environment API:これらの API により、Azure Time Series Insights Gen2 環境自体に対してクエリを実行できます。Environment APIs: These APIs enable queries on the Azure Time Series Insights Gen2 environment itself. これらを使用すると、呼び出し元がアクセスできる環境の一覧と環境メタデータを収集できます。These can be used to gather the list of environments the caller has access to and environment metadata.
  • Time Series Model-Query (TSM-Q) API:環境のタイム シリーズ モデルに保管されるメタデータの作成、読み取り、更新、削除 (CRUD) 操作を実行できます。Time Series Model-Query (TSM-Q) APIs: Enables create, read, update, and delete (CRUD) operations on metadata stored in the Time Series Model of the environment. これらを使用して、インスタンス、型、および階層にアクセスして編集できます。These can be used to access and edit the instances, types, and hierarchies.
  • Time Series Query (TSQ) API:テレメトリまたはイベントのデータをソース プロバイダーからの記録時に取得できます。また、高度なスカラー関数および集計関数を使用して、データに対して計算および集計を実行できます。Time Series Query (TSQ) APIs: Enables retrieval of telemetry or events data as it's recorded from the source provider and enables performant computations and aggregations on the data using advanced scalar and aggregate functions.

Azure Time Series Insights Gen2 では、機能が豊富な文字列ベースの式言語である Time Series Expression (TSX) を、Time Series 変数での計算の記述に使用します。Azure Time Series Insights Gen2 uses a rich string-based expression language, Time Series Expression (TSX), for expressing calculations in Time Series Variables.

Azure Time Series Insights Gen2 API の概要Azure Time Series Insights Gen2 APIs overview

次のコア API がサポートされています。The following core APIs are supported.

Time Series Query の概要Time Series Query overview

Environment APIEnvironment APIs

  • Environment API の取得:呼び出し元がアクセスを許可されている環境の一覧が返されます。Get Environments API: Returns the list of environments that the caller is authorized to access.
  • Environments Availability API の取得:イベントのタイムスタンプ $ts に対するイベント数の分布が返されます。Get Environments Availability API: Returns the distribution of event count over the event timestamp $ts. この API は、イベントが存在する場合に、時間間隔ごとにイベントの数を返すため、環境にイベントがあるかどうかを判断するのに役立ちます。This API helps determine if there are any events in the environment by returning the count of events broken into intervals of time, if any exist.
  • Get Event Schema API:特定の検索範囲に対するイベント スキーマのメタデータが返されます。Get Event Schema API: Returns the event schema metadata for a given search span. この API は、特定の検索範囲に対してスキーマで使用できるすべてのメタデータとプロパティを取得するのに役立ちます。This API helps retrieve all metadata and properties available in the schema for the given search span.

Time Series Model-Query (TSM-Q) APITime Series Model-Query (TSM-Q) APIs

これらの API のほとんどでバッチ実行操作がサポートされるため、複数のタイム シリーズ モデル エンティティに対してバッチ CRUD 操作を実行できます。Most of these APIs support batch execution operation to enable batch CRUD operations on multiple Time Series Model entities:

  • Model Settings API:環境の既定の型とモデル名を GET および PATCH できます。Model Settings API: Enables GET and PATCH on the default type and the model name of the environment.
  • Types API:タイム シリーズの種類とそれに関連する変数に対して CRUD を実行できます。Types API: Enables CRUD on Time Series types and their associated variables.
  • Hierarchies API:タイム シリーズの階層とそれに関連するフィールド パスに対して CRUD を実行できます。Hierarchies API: Enables CRUD on Time Series hierarchies and their associated field paths.
  • Instances API:タイム シリーズのインスタンスとそれに関連するインスタンス フィールドに対して CRUD を実行できます。Instances API: Enables CRUD on Time Series instances and their associated instance fields. さらに、Instances API は次の操作もサポートしています。Additionally, the Instances API supports the following operations:
    • Search:インスタンス属性に基づいて、時系列インスタンス検索のヒットの部分リストを取得します。Search: Retrieves a partial list of hits on search for time series instances based on instance attributes.
    • Suggest:インスタンス属性に基づいて、時系列インスタンス検索のヒットの部分リストを検索しサジェストします。Suggest: Searches and suggests a partial list of hits on search for time series instances based on instance attributes.

Time Series Query (TSQ) APITime Series Query (TSQ) APIs

これらの API は、多層ストレージ ソリューションの両方のストア (ウォームとコールド) 全体で利用できます。These APIs are available across both stores (Warm and Cold) in our multilayered storage solution. クエリ URL パラメーターは、クエリを実行するストアの種類を指定するために使用されます。Query URL parameters are used to specify the store type the query should execute on:

  • Get Events API:未加工のイベントおよび関連するイベント タイムスタンプのクエリと取得を実行できます。これらは、ソース プロバイダーから Azure Time Series Insights Gen2 に記録されるためです。Get Events API: Enables query and retrieval of raw events and the associated event timestamps as they're recorded in Azure Time Series Insights Gen2 from the source provider. この API を使用すると、特定の時系列 ID と検索範囲に対する未加工のイベントを取得できます。This API allows retrieval of raw events for a given Time Series ID and search span. この API は、改ページ位置の自動修正をサポートしており、選択した入力に対する完全な応答データセットを取得できます。This API supports pagination to retrieve the complete response dataset for the selected input.

    重要

  • Get Series API:未加工イベントの変数によって定義された計算を適用することで、計算値と関連するイベント タイムスタンプのクエリと取得を実行できます。Get Series API: Enables query and retrieval of computed values and the associated event timestamps by applying calculations defined by variables on raw events. これらの変数は、タイム シリーズ モデルで定義することもクエリでインラインで指定することもできます。These variables can be defined in either the Time Series Model or provided inline in the query. この API は、改ページ位置の自動修正をサポートしており、選択した入力に対する完全な応答データセットを取得できます。This API supports pagination to retrieve the complete response dataset for the selected input.

  • Aggregate Series API:未加工イベントの変数によって定義された計算を適用することで、集計値と関連する間隔タイムスタンプのクエリと取得を実行できます。Aggregate Series API: Enables query and retrieval of aggregated values and the associated interval timestamps by applying calculations defined by variables on raw events. これらの変数は、タイム シリーズ モデルで定義することもクエリでインラインで指定することもできます。These variables can be defined in either the Time Series Model or provided inline in the query. この API は、改ページ位置の自動修正をサポートしており、選択した入力に対する完全な応答データセットを取得できます。This API supports pagination to retrieve the complete response dataset for the selected input.

    この API は、指定された検索範囲と間隔で、タイム シリーズ ID の変数ごとの各間隔で集計された応答を返します。For a specified search span and interval, this API returns an aggregated response per interval per variable for a Time Series ID. 応答データセット内の間隔の数は、エポック ティック (Unix エポック - 1970 年 1 月 1 日以降の経過時間 (ミリ秒)) をカウントし、クエリで指定された間隔のサイズでティックを割ることによって計算されます。The number of intervals in the response dataset is calculated by counting epoch ticks (the number of milliseconds that have elapsed since Unix epoch - Jan 1st, 1970) and dividing the ticks by the interval span size specified in the query.

    応答セットで返されるタイムスタンプは、間隔からサンプリングされたイベントのものではなく、残された間隔境界のものです。The timestamps returned in the response set are of the left interval boundaries, not of the sampled events from the interval.

次のステップNext steps