Metadata - Get

參考

服務:: Log Analytics

API 版本:: 2022-10-27_Preview

取得元數據資訊
擷取工作區的元數據資訊，包括其架構、函式、工作區資訊、類別等。

GET https://api.loganalytics.io/v1/workspaces/{workspaceId}/metadata

URI 參數

名稱	位於	必要	類型	Description
workspaceId	path	True	string	工作區的標識碼。這是 Azure 入口網站中 [屬性] 刀鋒視窗中的 [工作區標識符]。

回應

名稱	類型	Description
200 OK	metadataResults	正常。 API 呼叫成功，且元數據結果位於響應承載中
Other Status Codes	errorResponse	錯誤回應物件。

安全性

oauth2

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

metadataGet

範例要求

HTTP

GET https://api.loganalytics.io/v1/workspaces/b438b4f6-912a-46d5-9cb1-b44069212abc/metadata

範例回覆

狀態碼:: 200

{
  "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"
        ]
      }
    }
  ]
}

定義

名稱	Description
Applications	元數據要求上 Application Insights 應用程式的許可權指示。
Columns	數據表上定義的數據列清單
errorDetail	錯誤詳細數據。
errorInfo	錯誤的程式代碼和訊息。
errorResponse	錯誤詳細數據。
metadataApplication	Application Insights 應用程式。
metadataCategory	元數據類別。
MetadataColumnDataType	數據行的數據類型
metadataFunction	預存函式。
metadataPermissions	許可權資訊。
metadataQuery	預存查詢。
metadataResourceType	Azure 中的資源類型。
metadataResults	元數據回應。
metadataSolution	Log Analytics 解決方案。
metadataTable	參與工作區架構的數據表。
metadataWorkspace	Log Analytics 工作區。
Related	類別的相關元數據專案
Resources	元數據要求上 Azure 資源的許可權指示。
Workspaces	元數據要求上工作區的許可權指示。

Applications

元數據要求上 Application Insights 應用程式的許可權指示。

名稱	類型	Description
resourceId	string	許可權指示上的資源標識碼。

Columns

數據表上定義的數據列清單

名稱	類型	Description
description	string	數據行的描述
isPreferredFacet	boolean	指出此數據行為慣用 Facet 的旗標
name	string	資料行的名稱
source	object	數據行來源的指示，只有在多個工作區具有數據行的衝突定義時，才會使用
type	MetadataColumnDataType	數據行的數據類型

errorDetail

錯誤詳細數據。

名稱	類型	Description
additionalProperties	object	可在錯誤詳細數據物件上提供的其他屬性
code	string	錯誤的程序代碼。
message	string	人類可讀取的錯誤訊息。
resources	string[]	指出負責錯誤的資源。
target	string	指出要求中的哪個屬性負責錯誤。
value	string	指出『target』中的哪個值負責錯誤。

errorInfo

錯誤的程式代碼和訊息。

名稱	類型	Description
additionalProperties	object	可在錯誤信息物件上提供的其他屬性
code	string	計算機可讀取的錯誤碼。
details	errorDetail[]	錯誤詳細數據。
innererror	errorInfo	錯誤的程式代碼和訊息。如果內部錯誤詳細資料存在，則為。
message	string	人類可讀取的錯誤訊息。

errorResponse

錯誤詳細數據。

名稱	類型	Description
error	errorInfo	錯誤的程式代碼和訊息。錯誤詳細資料。

metadataApplication

Application Insights 應用程式。

名稱	類型	Description
id	string	Application Insights 應用程式的標識碼。
name	string	Application Insights 應用程式的名稱。
region	string	Application Insights 應用程式的 Azure 區域。
related	Related	Application Insights 應用程式的相關元數據專案。
resourceId	string	Application Insights 應用程式的 ARM 資源識別碼。

metadataCategory

元數據類別。

名稱	類型	Description
description	string	類別的描述
displayName	string	類別的顯示名稱
id	string	類別目錄的識別碼
related	Related	類別的相關元數據專案

MetadataColumnDataType

數據行的數據類型

名稱	類型	Description
bool	string
datetime	string
decimal	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string
timespan	string

metadataFunction

預存函式。

名稱	類型	Description
body	string	函式的 KQL 主體。
description	string	函式的說明。
displayName	string	函式的顯示名稱。
id	string	函式的識別碼。
name	string	要用於查詢的函式名稱。
parameters	string	函式的參數/自變數，如果有的話。
properties	object	函式的屬性。
related	Related	函式的相關元數據專案。
tags	object	與函式相關聯的標記。

metadataPermissions

許可權資訊。

名稱	類型	Description
applications	Applications[]	元數據要求上 Application Insights 應用程式的許可權指示。
resources	Resources[]	元數據要求上 Azure 資源的許可權指示。
workspaces	Workspaces[]	元數據要求上工作區的許可權指示。

metadataQuery

預存查詢。

名稱	類型	Description
body	string	查詢的 KQL 主體。
description	string	查詢的描述。
displayName	string	查詢的顯示名稱。
id	string	查詢的識別碼。
labels	string[]	與查詢相關聯的使用者定義標籤。
properties	object	查詢的屬性。
related	Related	查詢的相關元數據專案。
tags	object	與查詢相關聯的標記。

metadataResourceType

Azure 中的資源類型。

名稱	類型	Description
description	string	資源類型的描述
displayName	string	資源類型的顯示名稱
id	string	資源類型的識別碼
labels	string[]	資源類型的使用者定義標籤
properties	object	資源類型的屬性
related	Related	資源類型的相關元數據專案
tags	object	與資源類型相關聯的標記
type	string	資源類型的類型

metadataResults

元數據回應。

名稱	類型	Description
applications	metadataApplication[]	元數據要求中所參考的Application Insights 應用程式清單。
categories	metadataCategory[]	此元數據響應中所參考的類別清單。
functions	metadataFunction[]	儲存在工作區或解決方案等的函式清單。
permissions	metadataPermissions[]	影響元數據要求的許可權規則清單。
queries	metadataQuery[]	儲存在工作區或解決方案、資源類型等所導入的已儲存查詢清單。
resourceTypes	metadataResourceType[]	此元數據響應中所參考的資源類型清單。
resources	metadataResource[]	元數據要求中所參考的 Azure 資源清單。
solutions	metadataSolution[]	工作區上安裝的Log Analytics解決方案清單。
tables	metadataTable[]	組成工作區架構的數據表和數據行清單。
workspaces	metadataWorkspace[]	元數據要求中所參考的Log Analytics工作區清單。

metadataSolution

Log Analytics 解決方案。

名稱	類型	Description
description	string	Log Analytics 解決方案的描述
displayName	string	Log Analytics 解決方案的顯示名稱
id	string	Log Analytics 解決方案的標識碼
name	string	Log Analytics 解決方案的名稱
properties	object	Log Analytics 解決方案的屬性
related	Related	Log Analytics 解決方案的相關元數據專案
tags	object	與 Log Analytics 解決方案相關聯的標記

metadataTable

參與工作區架構的數據表。

名稱	類型	Description
columns	Columns[]	數據表上定義的數據列清單
description	string	數據表的描述
id	string	數據表的識別碼
labels	string[]	數據表的使用者定義標籤
name	string	資料表的名稱
properties	object	數據表的屬性
related	Related	數據表的相關元數據專案
tags	object	與數據表相關聯的標記
timespanColumn	string	與數據表之時間範圍查詢參數相關聯的數據行

metadataWorkspace

Log Analytics 工作區。

名稱	類型	Description
id	string	Log Analytics 工作區的識別碼。
name	string	Log Analytics 工作區的名稱。
region	string	Log Analytics 工作區的 Azure 區域。
related	Related	Log Analytics 工作區的相關元數據專案。
resourceId	string	Log Analytics 工作區的 ARM 資源識別碼。

類別的相關元數據專案

名稱	類型	Description
functions	string[]	與類別相關的函式
queries	string[]	與類別相關的已儲存查詢
resourceTypes	string[]	與類別相關的資源類型
solutions	string[]	與類別相關的Log Analytics解決方案
tables	string[]	與類別相關的數據表

Resources

元數據要求上 Azure 資源的許可權指示。

名稱	類型	Description
denyTables	string[]	資源標識元拒絕存取的數據表清單。
resourceId	string	許可權指示上的資源標識碼。

Workspaces

元數據要求上工作區的許可權指示。

名稱	類型	Description
denyTables	string[]	資源標識元拒絕存取的數據表清單。
resourceId	string	許可權指示上的資源標識碼。

共用方式為

Metadata - Get

URI 參數

回應

安全性

oauth2

範圍

範例

metadataGet

範例要求

範例回覆

定義

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Resources

Workspaces

其他資源

共用方式為

Metadata - Get

URI 參數

回應

安全性

oauth2

範圍

範例

metadataGet

範例要求

範例回覆

定義

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Related

Resources

Workspaces

其他資源