概要
時系列モデルを作成する 3 つのコンポーネント (インスタンス、階層、型) のそれぞれには、CREATE、READ、UPDATE、DELETE、ページ分割、バッチ操作をサポートする対応する REST API があります。
- インスタンス API は、ページ分割された GET 操作、バッチ CREATE、READ、UPDATE、DELETE 操作、検索、および検索操作のキーワード候補をサポートします。
- Hierarchy API は、ページ分割された GET 操作と、バッチ CREATE、READ、UPDATE、DELETE 操作をサポートします。
- Type API は、ページ分割された GET 操作と、CREATE、READ、UPDATE、および DELETE のバッチ操作をサポートします。
4 番目の API は、時系列モデル設定の REST サポートを提供します。
- モデル設定 API では、時系列モデル構成設定の HTTP GET および UPDATE 操作がサポートされています。 時系列モデルとインスタンス、階層、型の定義の詳細については、「時系列モデル」を参照してください。
インスタンス API
インスタンス API を使用すると、時系列インスタンスに対して CREATE、READ、UPDATE、DELETE 操作を実行できます。
Get Instances API は、要求に一致するすべての時系列インスタンスを返します。
インスタンスの管理 API を使用すると、インスタンスに対するバッチ操作が可能になります。 この API に対するすべての操作は HTTP POST 操作です。 各操作はペイロードを受け入れます。 ペイロードは JSON オブジェクトです。 このオブジェクトは、単一のプロパティを定義します。 プロパティキーは、API で許可される操作の名前です。 サポートされている操作は、PUT、UPDATE、および DELETE です。
これらの API を使用すると、時系列インスタンスの検出が可能になります。
ヒント
検索 クエリの機能 については、以下をご覧ください。
階層 API
Hierarchies API を使用すると、時系列階層で CREATE、READ、UPDATE、DELETE が有効になります。
| API | 説明 |
|---|---|
| 階層 API の取得 | 要求に一致するすべての時系列階層を返します。 |
| 階層 API の管理 | 階層に対するバッチ操作を有効にします。 この API に対するすべての操作は HTTP POST 操作です。 各操作はペイロードを受け入れます。 ペイロードは JSON オブジェクトです。 このオブジェクトは、単一のプロパティを定義します。 プロパティキーは、API で許可される操作の名前です。 サポートされている操作は、PUT、UPDATE、および DELETE です。 |
タイプ API
型 API を使用すると、時系列型とそれに関連する変数に対して CREATE、READ、UPDATE、DELETE が有効になります。
| API | 説明 |
|---|---|
| 型の取得 API | すべての時系列型とそれに関連する変数を返します。 |
| 投稿タイプ API | 型に対するバッチ操作を有効にします。 この API に対するすべての操作は HTTP POST 操作です。 各操作はペイロードを受け入れます。 ペイロードは JSON オブジェクトです。 このオブジェクトは、単一のプロパティを定義します。 プロパティキーは、API で許可される操作の名前です。 サポートされている操作は、PUT、UPDATE、および DELETE です。 |
モデル設定API
モデル設定 API では、TimeSeriesIds によって環境内で自動的に作成されたモデルに対して、CREATE、READ、UPDATE、DELETE を有効にします。
| API | 説明 |
|---|---|
| モデル設定 API の取得 | TimeSeriesIds の環境で自動作成されたモデルを返します。 |
| モデル設定の更新 API | TimeSeriesIds の環境内のモデルを、要求で指定された新しい値で更新します。 |
検索機能
ワイルドカード検索
1 つの用語内で 1 文字および複数文字のワイルドカード検索がサポートされています (フレーズ検索内ではサポートされません)。
単一文字
1 文字のワイルドカード検索を実行するには、 ? 記号を使用します。 1 文字のワイルドカード検索では、1 文字が置換されたストリングに一致する用語が検索されます。
textまたはtestを検索するには、te?t を検索します。
複数の文字
複数文字のワイルドカード検索を実行するには、 * 記号を使用します。 複数文字のワイルドカード検索では、ゼロ以上の文字を検索します。
test、tests、またはtesterを検索するには、検索 test* を使用します。
用語の途中でワイルドカード検索を使用することもできます。
dryerを検索するには、検索 dr*r を使用できます。
ブール演算子
ブール演算子を使用すると、論理演算子を使用して用語を組み合わせることができます。 AND、OR、+、-、および NOT をブール演算子としてサポートします。
Von Bedeutung
- ブール演算子はすべて大文字でなければなりません。
- ブール演算子は、空白を使用して検索句から分離する必要があります。
-
dryer AND washerは有効ですが、dryer ANDwasherではありません。
AND 演算子
AND 演算子は、1 つの文書のテキスト内の任意の場所に両方の用語が存在する文書に一致します。
dryer washerを含むドキュメントを検索するには、foo bar検索を使用します。dryer washer AND foo bar。
注
記号 && は、演算子 AND の代わりに使用できます。
OR 演算子
OR 演算子は 2 つの用語をリンクし、いずれかの用語がドキュメントに存在する場合は、一致するドキュメントを検索します。 OR 演算子は、デフォルトの接続演算子です。 つまり、2 つの用語の間にブール演算子がない場合は、 OR 演算子が使用されます。
dryer washerまたは単にdryerを含むドキュメントを検索するには、次のいずれかの検索を使用します。
'dryer washer' dryer'dryer washer' OR dryer
注
記号 || は、演算子 OR の代わりに使用できます。
+ 演算子
+ 演算子または必須演算子では、+記号の後の用語が 1 つのドキュメントのフィールドのどこかに存在する必要があります。
dryerを含む必要があり、washerを含む可能性のあるドキュメントを検索するには、検索 +dryer washer を使用します。
-演算子
- または prohibit 演算子は、-記号の後に用語を含むドキュメントを除外します。
dryer washerを含むがfoo bar含まれていないドキュメントを検索するには、検索 dryer washer -foo bar を使用します。
いいえ
NOT 演算子は、NOT後に用語を含むドキュメントを除外します。
dryer washerを含むがfoo bar含まれていないドキュメントを検索するには、検索 dryer washer NOT foo bar を使用します。
NOT 演算子は、1 つの用語だけで使用することはできません。
次の検索では、結果は返されません: NOT dryer washer。
注
記号 ! は、演算子 NOT の代わりに使用できます。
- 除外された検索語の直前に配置する必要があります。
-
dryer !washerは有効ですが、dryer ! washerではありません。
こちらも参照ください
アプリケーション登録と Azure Active Directory プログラミング モデルの詳細については、「 開発者向け Azure Active Directory」を参照してください。
要求と認証のパラメーターについては、「 認証と承認」を参照してください。
HTTP リクエストとレスポンスのテストを支援するツールには、次のものがあります。
フィドラー。 この無料の Web デバッグ プロキシは REST 要求をインターセプトできるため、HTTP 要求と応答メッセージを診断できます。
JWT.io。 このツールを使用すると、ベアラー トークン内のクレームをすばやくダンプし、その内容を検証できます。
郵便配達員。 これは、REST API をデバッグするための無料の HTTP 要求および応答テスト ツールです。
Azure Time Series Insights Gen2 の詳細については、 Gen2 のドキュメントを参照してください。