Metadata - Get
メタデータ情報を取得します
ワークスペースのメタデータ情報 (スキーマ、関数、ワークスペース情報、カテゴリなど) を取得します。
GET https://api.loganalytics.io/v1/workspaces/{workspaceId}/metadata
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
workspace
|
path | True |
string |
ワークスペースの ID。 これは、Azure portalの [プロパティ] ブレードのワークスペース ID です。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK です。 API 呼び出しが成功し、メタデータの結果が応答ペイロードに含まれる |
|
Other Status Codes |
エラー応答オブジェクト。 |
セキュリティ
oauth2
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
metadataGet
要求のサンプル
GET https://api.loganalytics.io/v1/workspaces/b438b4f6-912a-46d5-9cb1-b44069212abc/metadata
応答のサンプル
{
"tables": [
{
"id": "ADAssessmentRecommendation",
"name": "ADAssessmentRecommendation",
"description": "Recommendations generated by AD assessments that are started through a scheduled task. When you schedule the assessment it runs by default every 7 days and upload the data into Azure Log Analytics",
"timespanColumn": "TimeGenerated",
"columns": [
{
"name": "SourceSystem",
"type": "string",
"isPreferredFacet": true
},
{
"name": "AssessmentId",
"type": "string",
"isPreferredFacet": true
},
{
"name": "RecommendationId",
"type": "string",
"isPreferredFacet": true
},
{
"name": "Recommendation",
"type": "string",
"isPreferredFacet": true
},
{
"name": "Description",
"type": "string"
},
{
"name": "RecommendationResult",
"type": "string",
"isPreferredFacet": true
},
{
"name": "TimeGenerated",
"type": "datetime"
},
{
"name": "FocusAreaId",
"type": "string",
"isPreferredFacet": true
},
{
"name": "FocusArea",
"type": "string",
"isPreferredFacet": true
},
{
"name": "ActionAreaId",
"type": "string",
"isPreferredFacet": true
},
{
"name": "ActionArea",
"type": "string",
"isPreferredFacet": true
},
{
"name": "RecommendationWeight",
"type": "real"
},
{
"name": "Computer",
"type": "string",
"isPreferredFacet": true
},
{
"name": "AffectedObjectType",
"type": "string",
"isPreferredFacet": true
},
{
"name": "AffectedObjectName",
"type": "string",
"isPreferredFacet": true
},
{
"name": "Forest",
"type": "string",
"isPreferredFacet": true
},
{
"name": "Domain",
"type": "string",
"isPreferredFacet": true
},
{
"name": "DomainController",
"type": "string",
"isPreferredFacet": true
},
{
"name": "Technology",
"type": "string"
},
{
"name": "CustomData",
"type": "string"
},
{
"name": "TargetCount",
"type": "int"
},
{
"name": "IsRollup",
"type": "bool",
"isPreferredFacet": true
},
{
"name": "IsCopied",
"type": "bool",
"isPreferredFacet": true
},
{
"name": "RecommendationPeriod",
"type": "string",
"isPreferredFacet": true
},
{
"name": "Type",
"type": "string"
},
{
"name": "_ResourceId",
"type": "string"
}
],
"related": {
"categories": [
"workloads"
],
"solutions": [
"ADAssessment"
],
"resourceTypes": [
"microsoft.compute/virtualmachines"
]
}
},
{
"id": "custom_CL",
"name": "custom_CL",
"timespanColumn": "TimeGenerated",
"columns": [
{
"name": "SourceSystem",
"type": "string",
"isPreferredFacet": true
},
{
"name": "ManagementGroupName",
"type": "string",
"isPreferredFacet": true
},
{
"name": "TimeGenerated",
"type": "datetime",
"isPreferredFacet": true
},
{
"name": "Computer",
"type": "string",
"isPreferredFacet": true
},
{
"name": "RawData",
"type": "string"
},
{
"name": "Type",
"type": "string"
},
{
"name": "_ResourceId",
"type": "string"
}
],
"related": {
"workspaces": [
"b438b4f6-912a-46d5-9cb1-b44069212abc"
]
}
}
],
"solutions": [
{
"id": "ADAssessment",
"name": "ADAssessment",
"displayName": "Active Directory Health Check",
"description": "Assess the risk and health of Active Directory environments.",
"related": {
"tables": [
"ADAssessmentRecommendation"
],
"functions": [
"dwad"
],
"workspaces": [
"b438b4f6-912a-46d5-9cb1-b44069212abc"
]
}
}
],
"functions": [
{
"id": "dwad",
"name": "dwad",
"displayName": "dasd",
"body": "Heartbeat\r\n| where ResourceGroup != \"rg-SAP-DEVQA-005\" and ResourceGroup != \"rg-SAP-DEVQA-006\" and Computer contains \"\"\r\n| limit 500000\r\n| sort by Computer asc\r\n| distinct Computer\r\n",
"related": {
"solutions": [
"ADAssessment"
],
"workspaces": [
"b438b4f6-912a-46d5-9cb1-b44069212abc"
]
}
}
],
"resourceTypes": [
{
"id": "microsoft.compute/virtualmachines",
"type": "Microsoft.Compute/VirtualMachines",
"displayName": "Virtual machines",
"related": {
"tables": [
"ADAssessmentRecommendation"
]
}
}
],
"workspaces": [
{
"id": "b438b4f6-912a-46d5-9cb1-b44069212abc",
"resourceId": "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourceGroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-IT",
"name": "contosoretail-IT",
"region": "eastus",
"related": {
"resourceTypes": [
"microsoft.compute/virtualmachines"
],
"tables": [
"custom_CL"
],
"solutions": [
"ADAssessment"
],
"functions": [
"dwad"
]
}
}
],
"categories": [
{
"id": "workloads",
"displayName": "Workloads",
"related": {
"tables": [
"ADAssessmentRecommendation",
"ADReplicationResult",
"SQLAssessmentRecommendation",
"WorkloadMonitoringPerf"
]
}
}
]
}
定義
名前 | 説明 |
---|---|
Applications |
メタデータ要求の Application Insights アプリのアクセス許可を示します。 |
Columns |
テーブルで定義されている列の一覧 |
error |
エラーの詳細。 |
error |
エラーのコードとメッセージ。 |
error |
エラーの詳細。 |
metadata |
Application Insights アプリケーション。 |
metadata |
メタデータ カテゴリ。 |
Metadata |
列のデータ型 |
metadata |
格納されている関数。 |
metadata |
アクセス許可情報。 |
metadata |
格納されているクエリ。 |
metadata |
Azure のリソースの種類。 |
metadata |
メタデータ応答。 |
metadata |
Log Analytics ソリューション。 |
metadata |
ワークスペース スキーマに含まれるデータ テーブル。 |
metadata |
Log Analytics ワークスペース。 |
Related |
カテゴリの関連メタデータ項目 |
Resources |
メタデータ要求での Azure リソースのアクセス許可を示します。 |
Workspaces |
メタデータ要求のワークスペースのアクセス許可を示します。 |
Applications
メタデータ要求の Application Insights アプリのアクセス許可を示します。
名前 | 型 | 説明 |
---|---|---|
resourceId |
string |
アクセス許可を示すリソース ID。 |
Columns
テーブルで定義されている列の一覧
名前 | 型 | 説明 |
---|---|---|
description |
string |
列の説明 |
isPreferredFacet |
boolean |
この列が優先ファセットであることを示すフラグ |
name |
string |
列の名前 |
source |
object |
列のソースを示します。複数のワークスペースに列の定義が競合している場合にのみ使用されます |
type |
列のデータ型 |
errorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalProperties |
object |
エラー詳細オブジェクトで指定できる追加のプロパティ |
code |
string |
エラーのコード。 |
message |
string |
人間が判読できるエラー メッセージ。 |
resources |
string[] |
エラーの原因となったリソースを示します。 |
target |
string |
要求のどのプロパティがエラーの原因であるかを示します。 |
value |
string |
"target" のどの値がエラーの原因であるかを示します。 |
errorInfo
エラーのコードとメッセージ。
名前 | 型 | 説明 |
---|---|---|
additionalProperties |
object |
エラー情報オブジェクトで指定できる追加のプロパティ |
code |
string |
コンピューターで読み取り可能なエラー コード。 |
details |
エラーの詳細。 |
|
innererror |
エラーのコードとメッセージ。 |
|
message |
string |
人間が判読できるエラー メッセージ。 |
errorResponse
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
error |
エラーのコードとメッセージ。 |
metadataApplication
Application Insights アプリケーション。
名前 | 型 | 説明 |
---|---|---|
id |
string |
Application Insights アプリの ID。 |
name |
string |
Application Insights アプリの名前。 |
region |
string |
Application Insights アプリの Azure リージョン。 |
related |
Application Insights アプリの関連メタデータ項目。 |
|
resourceId |
string |
Application Insights アプリの ARM リソース ID。 |
metadataCategory
メタデータ カテゴリ。
名前 | 型 | 説明 |
---|---|---|
description |
string |
カテゴリの説明 |
displayName |
string |
カテゴリの表示名 |
id |
string |
カテゴリの ID |
related |
カテゴリの関連メタデータ項目 |
MetadataColumnDataType
列のデータ型
名前 | 型 | 説明 |
---|---|---|
bool |
string |
|
datetime |
string |
|
decimal |
string |
|
dynamic |
string |
|
guid |
string |
|
int |
string |
|
long |
string |
|
real |
string |
|
string |
string |
|
timespan |
string |
metadataFunction
格納されている関数。
名前 | 型 | 説明 |
---|---|---|
body |
string |
関数の KQL 本体。 |
description |
string |
関数の説明。 |
displayName |
string |
関数の表示名。 |
id |
string |
関数の ID。 |
name |
string |
クエリで使用される関数の名前。 |
parameters |
string |
関数のパラメーター/引数 (存在する場合)。 |
properties |
object |
関数のプロパティ。 |
related |
関数の関連メタデータ項目。 |
|
tags |
object |
関数に関連付けられているタグ。 |
metadataPermissions
アクセス許可情報。
名前 | 型 | 説明 |
---|---|---|
applications |
メタデータ要求の Application Insights アプリのアクセス許可を示します。 |
|
resources |
メタデータ要求での Azure リソースのアクセス許可を示します。 |
|
workspaces |
メタデータ要求のワークスペースのアクセス許可を示します。 |
metadataQuery
格納されているクエリ。
名前 | 型 | 説明 |
---|---|---|
body |
string |
クエリの KQL 本文。 |
description |
string |
クエリの説明。 |
displayName |
string |
クエリの表示名。 |
id |
string |
クエリの ID。 |
labels |
string[] |
クエリに関連付けられているユーザー定義ラベル。 |
properties |
object |
クエリのプロパティ。 |
related |
クエリの関連メタデータ項目。 |
|
tags |
object |
クエリに関連付けられているタグ。 |
metadataResourceType
Azure のリソースの種類。
名前 | 型 | 説明 |
---|---|---|
description |
string |
リソースの種類の説明 |
displayName |
string |
リソースの種類の表示名 |
id |
string |
リソースの種類の ID |
labels |
string[] |
リソースの種類のユーザー定義ラベル |
properties |
object |
リソースの種類のプロパティ |
related |
リソースの種類の関連メタデータ項目 |
|
tags |
object |
リソースの種類に関連付けられているタグ |
type |
string |
リソースの種類の種類 |
metadataResults
メタデータ応答。
名前 | 型 | 説明 |
---|---|---|
applications |
メタデータ要求で参照された Application Insights アプリの一覧。 |
|
categories |
このメタデータ応答で参照されるカテゴリの一覧。 |
|
functions |
ワークスペースに格納されている関数、またはソリューションなどで導入された関数の一覧。 |
|
permissions |
メタデータ要求に影響を与えたアクセス許可規則の一覧。 |
|
queries |
ワークスペースに保存されている、またはソリューション、リソースの種類などで導入された保存済みクエリの一覧。 |
|
resourceTypes |
このメタデータ応答で参照されるリソースの種類の一覧。 |
|
resources |
metadata |
メタデータ要求で参照された Azure リソースの一覧。 |
solutions |
ワークスペースにインストールされている Log Analytics ソリューションの一覧。 |
|
tables |
ワークスペースのスキーマを構成するテーブルと列の一覧。 |
|
workspaces |
メタデータ要求で参照された Log Analytics ワークスペースの一覧。 |
metadataSolution
Log Analytics ソリューション。
名前 | 型 | 説明 |
---|---|---|
description |
string |
Log Analytics ソリューションの説明 |
displayName |
string |
Log Analytics ソリューションの表示名 |
id |
string |
Log Analytics ソリューションの ID |
name |
string |
Log Analytics ソリューションの名前 |
properties |
object |
Log Analytics ソリューションのプロパティ |
related |
Log Analytics ソリューションの関連メタデータ項目 |
|
tags |
object |
Log Analytics ソリューションに関連付けられているタグ |
metadataTable
ワークスペース スキーマに含まれるデータ テーブル。
名前 | 型 | 説明 |
---|---|---|
columns |
Columns[] |
テーブルで定義されている列の一覧 |
description |
string |
テーブルの説明 |
id |
string |
テーブルの ID |
labels |
string[] |
テーブルのユーザー定義ラベル |
name |
string |
テーブルの名前 |
properties |
object |
テーブルのプロパティ |
related |
テーブルの関連メタデータ項目 |
|
tags |
object |
テーブルに関連付けられているタグ |
timespanColumn |
string |
テーブルの timespan クエリ パラメーターに関連付けられている列 |
metadataWorkspace
Log Analytics ワークスペース。
名前 | 型 | 説明 |
---|---|---|
id |
string |
Log Analytics ワークスペースの ID。 |
name |
string |
Log Analytics ワークスペースの名前。 |
region |
string |
Log Analytics ワークスペースの Azure リージョン。 |
related |
Log Analytics ワークスペースの関連メタデータ項目。 |
|
resourceId |
string |
Log Analytics ワークスペースの ARM リソース ID。 |
Related
カテゴリの関連メタデータ項目
名前 | 型 | 説明 |
---|---|---|
functions |
string[] |
カテゴリに関連する関数 |
queries |
string[] |
カテゴリに関連する保存されたクエリ |
resourceTypes |
string[] |
カテゴリに関連するリソースの種類 |
solutions |
string[] |
カテゴリに関連する Log Analytics ソリューション |
tables |
string[] |
カテゴリに関連するテーブル |
Resources
メタデータ要求での Azure リソースのアクセス許可を示します。
名前 | 型 | 説明 |
---|---|---|
denyTables |
string[] |
リソース ID のアクセスが拒否されたテーブルの一覧。 |
resourceId |
string |
アクセス許可を示すリソース ID。 |
Workspaces
メタデータ要求のワークスペースのアクセス許可を示します。
名前 | 型 | 説明 |
---|---|---|
denyTables |
string[] |
リソース ID のアクセスが拒否されたテーブルの一覧。 |
resourceId |
string |
アクセス許可を示すリソース ID。 |