Time Series Types - Execute Batch

リファレンス

サービス:: Time Series Insights

API バージョン:: 2020-07-31

複数の時系列の種類に対してバッチ取得、作成、更新、削除操作を実行します。

POST https://{environmentFqdn}/timeseries/types/$batch?api-version=2020-07-31

URI パラメーター

名前	/	必須	型	説明
environmentFqdn	path	True	string	環境ごとの FQDN (たとえば、10000000-0000-0000-0000-100000000109.env.timeseries.azure.com)。このドメイン名は、Get Environments API、Azure portal、または Azure Resource Manager の応答から取得できます。
api-version	query	True	string	クライアント要求で使用する API のバージョン。現在サポートされているバージョンは "2020-07-31" です。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string	オプションのクライアント要求 ID。サービスはこの値を記録します。サービスがサービス間で操作をトレースできるようにし、顧客が特定の要求に関してサポートに連絡できるようにします。
x-ms-client-session-id		string	オプションのクライアントセッション ID。サービスはこの値を記録します。サービスがサービス間で関連する操作のグループをトレースできるようにし、顧客が特定の要求グループに関するサポートに問い合わせることができます。

要求本文

名前	型	説明
delete	TypesRequestBatchGetOrDelete	削除する時系列の種類の定義。
get	TypesRequestBatchGetOrDelete	返す時系列型の定義。
put	TimeSeriesType[]	更新または作成する時系列の種類の定義。

応答

名前	型	説明
200 OK	TypesBatchResponse	正常な操作。ヘッダー x-ms-request-id: string
Other Status Codes	TsiError	予期しないエラー。ヘッダー x-ms-request-id: string

名前

型

説明

200 OK

TypesBatchResponse

正常な操作。

ヘッダー

x-ms-request-id: string

Other Status Codes

TsiError

予期しないエラー。

ヘッダー

x-ms-request-id: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

TypesBatchDeleteByIds

TypesBatchDeleteByNames

TypesBatchGetByIds

TypesBatchGetByNames

TypesBatchPut

TypesBatchDeleteByIds

要求のサンプル

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types/$batch?api-version=2020-07-31

{
  "delete": {
    "typeIds": [
      "9250f816-faed-44c4-88e6-630e5eefa38b"
    ]
  }
}

応答のサンプル

状態コード:: 200

{
  "delete": [
    null
  ]
}

TypesBatchDeleteByNames

要求のサンプル

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types/$batch?api-version=2020-07-31

{
  "delete": {
    "names": [
      "TemperatureSensor"
    ]
  }
}

応答のサンプル

状態コード:: 200

{
  "delete": [
    null
  ]
}

TypesBatchGetByIds

要求のサンプル

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types/$batch?api-version=2020-07-31

{
  "get": {
    "typeIds": [
      "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8"
    ],
    "names": null
  }
}

応答のサンプル

状態コード:: 200

{
  "get": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "TemperatureSensor",
        "description": "This is a temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": null,
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

TypesBatchGetByNames

要求のサンプル

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types/$batch?api-version=2020-07-31

{
  "get": {
    "names": [
      "DefaultType",
      "TemperatureSensor"
    ]
  }
}

応答のサンプル

状態コード:: 200

{
  "get": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "TemperatureSensor",
        "description": "This is a temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": null,
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

TypesBatchPut

要求のサンプル

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types/$batch?api-version=2020-07-31

{
  "put": [
    {
      "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "name": "DefaultType",
      "description": "My Default type",
      "variables": {
        "EventCount": {
          "kind": "aggregate",
          "filter": null,
          "aggregation": {
            "tsx": "count()"
          }
        }
      }
    },
    {
      "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
      "name": "OutdoorTemperatureSensor",
      "description": "This is an outdoor temperature sensor.",
      "variables": {
        "AverageTemperature": {
          "kind": "numeric",
          "value": {
            "tsx": "$event.Temperature.Double"
          },
          "filter": {
            "tsx": "$event.Mode.String = 'outdoor'"
          },
          "aggregation": {
            "tsx": "avg($value)"
          }
        }
      }
    }
  ]
}

応答のサンプル

状態コード:: 200

{
  "put": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "My Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "OutdoorTemperatureSensor",
        "description": "This is an outdoor temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": {
              "tsx": "$event.Mode.String = 'outdoor'"
            },
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

定義

名前	説明
AggregateVariable	集計変数は、集計計算を表します。集計変数は補間をサポートしていません。
Boundary	補間に使用する検索スパンの左右の時間範囲。これは、入力検索スパンの開始または終了の近くにデータポイントが欠落しているシナリオで役立ちます。 null を指定できます。
CategoricalVariable	カテゴリ変数は、定義された値の限られたセットの出現回数または継続時間に基づいて分析する必要があるシグナルを表します。
Interpolation	生データポイントに対して実行される補間操作。現時点では、補間された時系列のサンプリングのみが許可されています。許可される集計関数 - 例: left($value)。補間を適用する必要がない場合は null にすることができます。
InterpolationKind	補間手法の種類: "Linear" または "Step"。
NumericVariable	数値変数は、補間を使用して再構築できる 1 つの連続する数値信号を表します。
TimeSeriesAggregateCategory	カテゴリ変数で使用されるカテゴリ。カテゴリは、このラベルが割り当てられている 'label' と 'values' によって定義されます。
TimeSeriesDefaultCategory	既定のカテゴリを表します。
TimeSeriesType	時系列型は、時系列インスタンスに関連付けられたイベントに対して計算を実行するための変数または数式を定義します。各時系列インスタンスは、厳密に 1 つの型に関連付けられます。型には、1 つ以上の変数を含めることができます。たとえば、時系列インスタンスは、平均温度、最小温度、および最大温度の変数で構成される温度センサー型である場合があります。
TimeSeriesTypeOrError	特定の時系列の種類に対するバッチ操作の結果。 Type オブジェクトは、操作が成功したときに設定され、操作が失敗したときにエラーオブジェクトが設定されます。
TsiError	API エラーに関する情報。
TsiErrorBody	エラーコードとメッセージを含む特定の API エラー。
TsiErrorDetails	追加のエラー情報。
Tsx	1 つの文字列として書き込まれた時系列式 (TSX)。例: "$event。Status.String='Good'", "avg($event.温度)"。時系列式を記述する方法については、ドキュメントを参照してください。
TypesBatchRequest	時系列の種類のバッチに対して 1 つの操作を実行するように要求します。 "get"、"put"、または "delete" のいずれかを設定する必要があります。
TypesBatchResponse	時系列の種類のバッチに対する 1 つの操作の応答。 "get"、"put"、または "delete" のいずれかが設定されます。
TypesRequestBatchGetOrDelete	ID または型名による時系列型の取得または削除を要求します。 "typeIds" または "names" のいずれかを設定する必要があります。

AggregateVariable

Object

集計変数は、集計計算を表します。集計変数は補間をサポートしていません。

名前	型	説明
aggregation	Tsx	種類が "aggregate" の場合の集計時系列式は、"$event" などのイベントプロパティを使用して直接実行する必要がある集計を表すために使用されます。温度"。たとえば、温度変化の範囲を計算するための集計は、"max($event。Temperature)-min($event.温度)"。
filter	Tsx	計算対象と見なされるイベントの数を制限するイベントをフィルター処理します。例: "$event。Status.String='Good'"。随意。
kind	string: aggregate	使用できる "kind" 値は、"numeric" または "aggregate" です。 "numeric" では再構築されたシグナルの値とそれらを集計する式を指定できますが、"集計" の種類を使用すると、値を指定せずにイベントプロパティを直接集計できます。

Boundary

Object

補間に使用する検索スパンの左右の時間範囲。これは、入力検索スパンの開始または終了の近くにデータポイントが欠落しているシナリオで役立ちます。 null を指定できます。

名前	型	説明
span	string (duration)

CategoricalVariable

Object

カテゴリ変数は、定義された値の限られたセットの出現回数または継続時間に基づいて分析する必要があるシグナルを表します。

名前	型	説明
categories	TimeSeriesAggregateCategory[]	カテゴリ変数で使用されるカテゴリ。カテゴリは、このラベルが割り当てられている 'label' と 'values' によって定義されます。
defaultCategory	TimeSeriesDefaultCategory	既定のカテゴリを表します。
filter	Tsx	計算対象と見なされるイベントの数を制限するイベントをフィルター処理します。例: "$event。Status.String='Good'"。随意。
interpolation	Interpolation	カテゴリ変数では、"ステップ" 補間のみがサポートされます。
kind	string: categorical	使用できる "kind" 値は、"numeric" または "aggregate" です。 "numeric" では再構築されたシグナルの値とそれらを集計する式を指定できますが、"集計" の種類を使用すると、値を指定せずにイベントプロパティを直接集計できます。
value	Tsx	値の時系列式は、分類されるシグナルの値を表すために使用されます。カテゴリ変数の場合、'String' 型または 'Long' 型にのみ評価できます。

Interpolation

Object

生データポイントに対して実行される補間操作。現時点では、補間された時系列のサンプリングのみが許可されています。許可される集計関数 - 例: left($value)。補間を適用する必要がない場合は null にすることができます。

名前	型	説明
boundary	Boundary	補間に使用する検索スパンの左右の時間範囲。これは、入力検索スパンの開始または終了の近くにデータポイントが欠落しているシナリオで役立ちます。 null を指定できます。
kind	InterpolationKind	補間手法の種類: "Linear" または "Step"。

InterpolationKind

列挙

補間手法の種類: "Linear" または "Step"。

値	説明
Linear
Step

NumericVariable

Object

数値変数は、補間を使用して再構築できる 1 つの連続する数値信号を表します。

名前	型	説明
aggregation	Tsx	種類が "numeric" の場合の集計時系列式は、$value式で実行する必要がある集計を表すために使用されます。そのためには、$valueを指定する必要があり、集計関数内の$valueのみを使用できます。たとえば、$valueの最小値を計算するための集計は、"min($value)" と書き込まれます。
filter	Tsx	計算対象と見なされるイベントの数を制限するイベントをフィルター処理します。例: "$event。Status.String='Good'"。随意。
interpolation	Interpolation	生データポイントに対して実行される補間操作。現時点では、補間された時系列のサンプリングのみが許可されています。許可される集計関数 - 例: left($value)。補間を適用する必要がない場合は null にすることができます。
kind	string: numeric	使用できる "kind" 値は、"numeric" または "aggregate" です。 "numeric" では再構築されたシグナルの値とそれらを集計する式を指定できますが、"集計" の種類を使用すると、値を指定せずにイベントプロパティを直接集計できます。
value	Tsx	値の時系列式は、集計または補間されるシグナルの値を表すために使用されます。たとえば、イベントの温度値は次のように表されます: "$event。Temperature.Double"。

TimeSeriesAggregateCategory

Object

カテゴリ変数で使用されるカテゴリ。カテゴリは、このラベルが割り当てられている 'label' と 'values' によって定義されます。

名前	型	説明
label	string	出力変数名の構築に使用されるカテゴリの名前。
values	object[]	カテゴリがマップされる値の一覧。文字列の一意のリストまたは long のリストを指定できます。

TimeSeriesDefaultCategory

Object

既定のカテゴリを表します。

名前	型	説明
label	string	'categories' で定義されているものと一致しない値に割り当てられる既定のカテゴリの名前。

TimeSeriesType

Object

時系列型は、時系列インスタンスに関連付けられたイベントに対して計算を実行するための変数または数式を定義します。各時系列インスタンスは、厳密に 1 つの型に関連付けられます。型には、1 つ以上の変数を含めることができます。たとえば、時系列インスタンスは、平均温度、最小温度、および最大温度の変数で構成される温度センサー型である場合があります。

名前	型	説明
description	string	型の説明。 null を指定できます。
id	string	変更できない大文字と小文字を区別する一意の型識別子。作成要求または更新要求で null を指定でき、サーバーによって ID が生成されます。取得操作と削除操作では null ではありません。
name	string	型のユーザー指定の一意の名前。 null ではなく、変更可能です。
variables	object	型に関連付けられているさまざまな変数。空ではなく、null ではありません。

TimeSeriesTypeOrError

Object

特定の時系列の種類に対するバッチ操作の結果。 Type オブジェクトは、操作が成功したときに設定され、操作が失敗したときにエラーオブジェクトが設定されます。

名前	型	説明
error	TsiErrorBody	Error オブジェクト - 操作が失敗したときに設定されます。
timeSeriesType	TimeSeriesType	時系列型オブジェクト - 操作が成功したときに設定されます。

TsiError

Object

API エラーに関する情報。

名前	型	説明
error	TsiErrorBody	エラーコードとメッセージを含む特定の API エラー。

TsiErrorBody

Object

エラーコードとメッセージを含む特定の API エラー。

名前	型	説明
code	string	サービス固有のエラーコードを定義する、言語に依存しない人間が判読できる文字列。このコードは、応答で指定された HTTP エラーコードのより具体的なインジケーターとして機能します。特定のエラーケースをプログラムで処理するために使用できます。
details	TsiErrorDetails[]	追加のエラー情報が含まれています。 null を指定できます。
innerError	TsiErrorBody	原因を絞り込む、より具体的なエラーが含まれています。 null を指定できます。
message	string	エラーの人間が判読できる、言語に依存しない表現。これは開発者の支援を目的としており、エンドユーザーへの公開には適していません。
target	string	特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。 null を指定できます。

TsiErrorDetails

Object

追加のエラー情報。

名前	型	説明
code	string	サービス固有のエラーコードを定義する、言語に依存しない人間が判読できる文字列。このコードは、応答で指定された HTTP エラーコードのより具体的なインジケーターとして機能します。特定のエラーケースをプログラムで処理するために使用できます。
message	string	エラーの人間が判読できる、言語に依存しない表現。これは開発者の支援を目的としており、エンドユーザーへの公開には適していません。

Tsx

Object

1 つの文字列として書き込まれた時系列式 (TSX)。例: "$event。Status.String='Good'", "avg($event.温度)"。時系列式を記述する方法については、ドキュメントを参照してください。

名前	型	説明
tsx	string	1 つの文字列として書き込まれた時系列式 (TSX)。例: "$event。Status.String='Good'", "avg($event.温度)"。時系列式を記述する方法については、ドキュメントを参照してください。

TypesBatchRequest

Object

時系列の種類のバッチに対して 1 つの操作を実行するように要求します。 "get"、"put"、または "delete" のいずれかを設定する必要があります。

名前	型	説明
delete	TypesRequestBatchGetOrDelete	削除する時系列の種類の定義。
get	TypesRequestBatchGetOrDelete	返す時系列型の定義。
put	TimeSeriesType[]	更新または作成する時系列の種類の定義。

TypesBatchResponse

Object

時系列の種類のバッチに対する 1 つの操作の応答。 "get"、"put"、または "delete" のいずれかが設定されます。

名前	型	説明
delete	TsiErrorBody[]	要求内の "delete" 配列の位置によって対応するエラーオブジェクトの一覧 - 操作が成功した場合は null。
get	TimeSeriesTypeOrError[]	要求内の "get" 配列の位置によって対応する型またはエラーオブジェクトの一覧。 Type オブジェクトは、操作が成功したときに設定され、操作が失敗したときにエラーオブジェクトが設定されます。
put	TimeSeriesTypeOrError[]	要求内の "put" 配列の位置によって対応する型またはエラーオブジェクトの一覧。 Type オブジェクトは、操作が成功したときに設定され、操作が失敗したときにエラーオブジェクトが設定されます。

TypesRequestBatchGetOrDelete

Object

ID または型名による時系列型の取得または削除を要求します。 "typeIds" または "names" のいずれかを設定する必要があります。

名前	型	説明
names	string[]	取得または削除する時系列型の名前の一覧。
typeIds	string[]	取得または削除する時系列型の ID の一覧。

次の方法で共有

Time Series Types - Execute Batch

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

例

TypesBatchDeleteByIds

要求のサンプル

応答のサンプル

TypesBatchDeleteByNames

要求のサンプル

応答のサンプル

TypesBatchGetByIds

要求のサンプル

応答のサンプル

TypesBatchGetByNames

要求のサンプル

応答のサンプル

TypesBatchPut

要求のサンプル

応答のサンプル

定義

AggregateVariable

Boundary

CategoricalVariable

Interpolation

InterpolationKind

NumericVariable

TimeSeriesAggregateCategory

TimeSeriesDefaultCategory

TimeSeriesType

TimeSeriesTypeOrError

TsiError

TsiErrorBody

TsiErrorDetails

Tsx

TypesBatchRequest

TypesBatchResponse

TypesRequestBatchGetOrDelete