Metadata - Get

リファレンス

サービス:: Application Insights

API バージョン:: v1

メタデータ情報を取得します
スキーマなど、アプリのメタデータ情報を取得します。

GET https://api.applicationinsights.io/v1/apps/{appId}/metadata

URI パラメーター

名前	/	必須	型	説明
appId	path	True	string	アプリケーションの ID。これは、Azure portalの [API アクセス設定] ブレードの [アプリケーション ID] です。

応答

名前	型	説明
200 OK	metadataResults	成功応答
Other Status Codes	errorResponse	エラー応答オブジェクト。

セキュリティ

oauth2

Azure アプリケーション Insights API に接続する

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

スコープ

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

例

metadataGet

要求のサンプル

HTTP

GET https://api.applicationinsights.io/v1/apps/cf58dcfd-0683-487c-bc84-048789bca8e5/metadata

応答のサンプル

状態コード:: 200

{
  "tables": [
    {
      "id": "t/requests",
      "name": "requests",
      "timespanColumn": "timestamp",
      "columns": [
        {
          "name": "timestamp",
          "type": "datetime"
        },
        {
          "name": "id",
          "type": "string"
        },
        {
          "name": "source",
          "type": "string"
        },
        {
          "name": "name",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "url",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "success",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "resultCode",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "duration",
          "type": "real"
        },
        {
          "name": "performanceBucket",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "itemType",
          "type": "string"
        },
        {
          "name": "customDimensions",
          "type": "dynamic",
          "isPreferredFacet": true
        },
        {
          "name": "customMeasurements",
          "type": "dynamic"
        },
        {
          "name": "operation_Name",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "operation_Id",
          "type": "string"
        },
        {
          "name": "operation_ParentId",
          "type": "string"
        },
        {
          "name": "operation_SyntheticSource",
          "type": "string"
        },
        {
          "name": "session_Id",
          "type": "string"
        },
        {
          "name": "user_Id",
          "type": "string"
        },
        {
          "name": "user_AuthenticatedId",
          "type": "string"
        },
        {
          "name": "user_AccountId",
          "type": "string"
        },
        {
          "name": "application_Version",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "client_Type",
          "type": "string"
        },
        {
          "name": "client_Model",
          "type": "string"
        },
        {
          "name": "client_OS",
          "type": "string"
        },
        {
          "name": "client_IP",
          "type": "string"
        },
        {
          "name": "client_City",
          "type": "string"
        },
        {
          "name": "client_StateOrProvince",
          "type": "string"
        },
        {
          "name": "client_CountryOrRegion",
          "type": "string"
        },
        {
          "name": "client_Browser",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "cloud_RoleName",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "cloud_RoleInstance",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "appId",
          "type": "string"
        },
        {
          "name": "appName",
          "type": "string"
        },
        {
          "name": "iKey",
          "type": "string"
        },
        {
          "name": "sdkVersion",
          "type": "string"
        },
        {
          "name": "itemId",
          "type": "string"
        },
        {
          "name": "itemCount",
          "type": "int"
        }
      ]
    }
  ],
  "tableGroups": [
    {
      "id": "ai/StandardSchema",
      "name": "StandardSchema",
      "source": "ai",
      "tables": [
        "t/requests"
      ]
    }
  ],
  "applications": [
    {
      "id": "cf58dcfd-0683-487c-bc84-048789bca8e5",
      "name": "FabrikamProd",
      "resourceId": "/subscriptions/72993b69-db12-44fc-9a66-9c2005c30513/resourceGroups/Fabrikam/providers/microsoft.insights/components/FabrikamProd",
      "tables": [],
      "region": "southcentralus",
      "tableGroups": [
        "ai/StandardSchema"
      ]
    }
  ]
}

定義

名前	説明
Columns	テーブルで定義されている列の一覧
errorDetail	エラーの詳細。
errorInfo	エラーのコードとメッセージ。
errorResponse	エラーの詳細。
metadataApplication	Application Insights アプリケーション。
MetadataColumnDataType	列のデータ型
metadataFunction	格納されている関数。
metadataResults	メタデータ応答。
metadataTable	Application Insights アプリのスキーマに含まれるデータテーブル。
metadataTableGroup	テーブルのグループ。

Columns

テーブルで定義されている列の一覧

名前	型	説明
description	string	列の説明
isPreferredFacet	boolean	この列が優先ファセットであることを示すフラグ
name	string	列の名前
source	object	列のソースを示します。複数のアプリで列の定義が競合している場合にのみ使用されます
type	MetadataColumnDataType	列のデータ型

errorDetail

エラーの詳細。

名前	型	説明
additionalProperties	object
code	string	エラーのコード。
message	string	人間が判読できるエラーメッセージ。
resources	string[]	エラーの原因となったリソースを示します。
target	string	要求のどのプロパティがエラーの原因であるかを示します。
value	string	"target" のどの値がエラーの原因であるかを示します。

errorInfo

エラーのコードとメッセージ。

名前	型	説明
additionalProperties	object
code	string	コンピューターで読み取り可能なエラーコード。
details	errorDetail[]	エラーの詳細。
innererror	errorInfo	エラーのコードとメッセージ。内部エラーの詳細 (存在する場合)。
message	string	人間が判読できるエラーメッセージ。

errorResponse

エラーの詳細。

名前	型	説明
error	errorInfo	エラーのコードとメッセージ。エラーの詳細です。

metadataApplication

Application Insights アプリケーション。

名前	型	説明
functions	string[]	Application Insights アプリのストアド関数の一覧
id	string	Application Insights アプリの ID。
name	string	Application Insights アプリの名前。
region	string	Application Insights アプリの Azure リージョン。
resourceId	string	Application Insights アプリの ARM リソース ID。
tableGroups	string[]	Application Insights アプリのテーブルグループの一覧
tables	string[]	Application Insights アプリのカスタムテーブルの一覧。

MetadataColumnDataType

列のデータ型

名前	型	説明
bool	string
datetime	string
dynamic	string
int	string
long	string
real	string
string	string

metadataFunction

格納されている関数。

名前	型	説明
body	string	関数の KQL 本体。
description	string	関数の説明。
displayName	string	関数の表示名。
id	string	関数の ID。
name	string	クエリで使用される関数の名前。
parameters	string	関数のパラメーター/引数 (存在する場合)。

metadataResults

メタデータ応答。

名前	型	説明
applications	metadataApplication[]	メタデータ要求で参照された Application Insights アプリの一覧。
functions	metadataFunction[]	アプリに格納されている関数の一覧。
tableGroups	metadataTableGroup[]	アプリ上のテーブルのグループの一覧。
tables	metadataTable[]	アプリのスキーマを構成するテーブルと列の一覧。

metadataTable

Application Insights アプリのスキーマに含まれるデータテーブル。

名前	型	説明
columns	Columns[]	テーブルで定義されている列の一覧
description	string	テーブルの説明
id	string	テーブルの ID
name	string	テーブルの名前
timespanColumn	string	テーブルの timespan クエリパラメーターに関連付けられている列

metadataTableGroup

テーブルのグループ。

名前	型	説明
description	string	テーブルグループの説明
displayName	string	テーブルグループの表示名
id	string	テーブルグループの ID
name	string	テーブルグループの名前
source	string	テーブルグループのソースは、LOG Analytics ワークスペースの AI または OMS のいずれかです
tables	string[]	テーブルグループに含まれるテーブルの一覧

次の方法で共有