Query - Get Event Schema

リファレンス

Service:: Time Series Insights

API Version:: 2020-07-31

特定の検索範囲の環境イベントスキーマを返します。イベントスキーマは、プロパティ定義のセットです。プロパティが多すぎる場合、イベントスキーマにすべての永続化プロパティが含まれていない場合があります。

POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31

With optional parameters:

POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31&storeType={storeType}

URI パラメーター

名前	/	必須	型	説明
environmentFqdn	path	True	string	10000000-0000-0000-0000-100000000109.env.timeseries.azure.com など、環境ごとの FQDN。このドメイン名は、Get Environments API、Azure portal、または Azure Resource Managerの応答から取得できます。
api-version	query	True	string	クライアント要求で使用される API のバージョン。現在サポートされているバージョンは "2020-07-31" です。
storeType	query		string	ウォームストアが有効になっている環境の場合、クエリは 'WarmStore' または 'ColdStore' で実行できます。クエリ内のこのパラメーターは、クエリを実行する必要があるストアを定義します。定義されていない場合は、コールドストアでクエリが実行されます。

要求ヘッダー

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

要求本文

名前	必須	型	説明
searchSpan	True	DateTimeRange	クエリが実行される時間の範囲。 null にすることはできません。

応答

名前	型	説明
200 OK	EventSchema	操作は成功しました。 Headers x-ms-request-id: string
Other Status Codes	TsiError	予期しないエラー。 Headers x-ms-request-id: string

名前

型

説明

200 OK

EventSchema

操作は成功しました。

Headers

x-ms-request-id: string

Other Status Codes

TsiError

予期しないエラー。

Headers

x-ms-request-id: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

ColdStoreEventSchemaGet

EventSchemaGet

EventSchemaGetEmpty

WarmStoreEventSchemaGet

ColdStoreEventSchemaGet

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31&storeType=coldstore

{
  "searchSpan": {
    "from": "2018-08-01T00:00:00.000Z",
    "to": "2018-08-31T00:00:00.000Z"
  }
}

Sample Response

Status code:: 200

{
  "properties": [
    {
      "name": "Building",
      "type": "String"
    },
    {
      "name": "Room",
      "type": "String"
    },
    {
      "name": "DeviceId",
      "type": "Double"
    },
    {
      "name": "Temperature",
      "type": "Double"
    },
    {
      "name": "Pressure",
      "type": "Double"
    },
    {
      "name": "Status",
      "type": "String"
    }
  ]
}

EventSchemaGet

Sample Request

HTTP

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

{
  "searchSpan": {
    "from": "2018-08-01T00:00:00.000Z",
    "to": "2018-08-31T00:00:00.000Z"
  }
}

Sample Response

Status code:: 200

{
  "properties": [
    {
      "name": "Building",
      "type": "String"
    },
    {
      "name": "Room",
      "type": "String"
    },
    {
      "name": "DeviceId",
      "type": "Double"
    },
    {
      "name": "Temperature",
      "type": "Double"
    },
    {
      "name": "Pressure",
      "type": "Double"
    },
    {
      "name": "Status",
      "type": "String"
    }
  ]
}

EventSchemaGetEmpty

Sample Request

HTTP

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

{
  "searchSpan": {
    "from": "2016-08-01T00:00:00.000Z",
    "to": "2016-08-31T00:00:00.000Z"
  }
}

Sample Response

Status code:: 200

{
  "properties": []
}

WarmStoreEventSchemaGet

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31&storeType=warmstore

{
  "searchSpan": {
    "from": "2018-08-01T00:00:00.000Z",
    "to": "2018-08-31T00:00:00.000Z"
  }
}

Sample Response

Status code:: 200

{
  "properties": [
    {
      "name": "Building",
      "type": "String"
    },
    {
      "name": "Room",
      "type": "String"
    },
    {
      "name": "DeviceId",
      "type": "Double"
    },
    {
      "name": "Temperature",
      "type": "Double"
    },
    {
      "name": "Pressure",
      "type": "Double"
    },
    {
      "name": "Status",
      "type": "String"
    }
  ]
}

定義

名前	説明
DateTimeRange	時間の範囲。 null または負の値にすることはできません。
EventProperty	格納または計算されるイベントのプロパティ。プロパティは、名前と型の両方で識別されます。異なるイベントは、同じ名前のプロパティを持つことができますが、種類は異なります。
EventSchema	特定の検索スパン内のすべてのイベントのイベントスキーマ。イベントスキーマは、プロパティ定義のセットです。プロパティは、名前と型の両方で識別されます。異なるイベントは、同じ名前のプロパティを持つことができますが、種類は異なります。プロパティが多すぎる場合、イベントスキーマにすべての永続化プロパティが含まれていない場合があります。
GetEventSchemaRequest	特定の検索スパン内のすべてのイベントのイベントスキーマを取得するように要求します。
PropertyTypes	プロパティの型。
TsiError	API エラーに関する情報。
TsiErrorBody	エラーコードとメッセージを含む特定の API エラー。
TsiErrorDetails	その他のエラー情報。

DateTimeRange

時間の範囲。 null または負の値にすることはできません。

名前	型	説明
from	string	時間範囲のタイムスタンプを開始します。時系列クエリ要求で使用される場合、開始タイムスタンプは包括的です。このタイムスタンプを持つイベントが含まれます。
to	string	時間範囲の終了タイムスタンプ。時系列クエリ要求で使用する場合、終了タイムスタンプは排他的です。このタイムスタンプに一致するイベントは除外されます。 Get Availability によって返される場合、終了タイムスタンプは包括的であることに注意してください (つまり、この正確な "to" タイムスタンプを持つイベントがあることを意味します)。

EventProperty

格納または計算されるイベントのプロパティ。プロパティは、名前と型の両方で識別されます。異なるイベントは、同じ名前のプロパティを持つことができますが、種類は異なります。

名前	型	説明
name	string	プロパティの名前。
type	PropertyTypes	プロパティの型。

EventSchema

特定の検索スパン内のすべてのイベントのイベントスキーマ。イベントスキーマは、プロパティ定義のセットです。プロパティは、名前と型の両方で識別されます。異なるイベントは、同じ名前のプロパティを持つことができますが、種類は異なります。プロパティが多すぎる場合、イベントスキーマにすべての永続化プロパティが含まれていない場合があります。

名前	型	説明
properties	EventProperty[]	プロパティ定義のセット。環境にデータがない場合、返される配列は空です。

GetEventSchemaRequest

特定の検索スパン内のすべてのイベントのイベントスキーマを取得するように要求します。

名前	型	説明
searchSpan	DateTimeRange	クエリが実行される時間の範囲。 null にすることはできません。

PropertyTypes

プロパティの型。

名前	型	説明
Bool	string
DateTime	string
Double	string
Long	string
String	string
TimeSpan	string

TsiError

API エラーに関する情報。

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

TsiErrorBody

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

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

TsiErrorDetails

その他のエラー情報。

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

Query - Get Event Schema

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

Scopes

例

ColdStoreEventSchemaGet

Sample Request

Sample Response

EventSchemaGet

Sample Request

Sample Response

EventSchemaGetEmpty

Sample Request

Sample Response

WarmStoreEventSchemaGet

Sample Request

Sample Response

定義

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails

その他のリソース