Query - Resource Get Xms

サービス:

Log Analytics

API バージョン:

2022-10-27_Preview

リソース URI を使用して Analytics クエリを実行する
リソースのコンテキスト内のデータに対して Analytics クエリを実行します。 ここで は、分析クエリで POST を使用する例です。

GET https://api.loganalytics.io/v1/{resourceId}/query?disambiguation_dummy&query={query}

省略可能なパラメーターを含む:

GET https://api.loganalytics.io/v1/{resourceId}/query?disambiguation_dummy&query={query}&timespan={timespan}

URI パラメーター

名前	/	必須	型	説明
resourceId	path	True	string	リソースの識別子。
query	query	True	string	Analytics クエリ。 Analytics クエリ構文の詳細については、
timespan	query		string (duration)	任意 データのクエリを実行する期間。 これは、ISO8601期間の値です。 この期間は、クエリ式で指定された期間に加えて適用されます。

応答

名前	型	説明
200 OK	queryResults	わかりました。 API 呼び出しが成功し、Analytics クエリの結果が応答ペイロードに含まれる
Other Status Codes	errorResponse	エラー応答オブジェクト。

セキュリティ

oauth2

Azure Active Directory OAuth2 フロー

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

スコープ

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

例

simple-query

要求のサンプル

HTTP

GET https://api.loganalytics.io/v1//subscriptions/fffa080af-c2d8-40ad-9cce-e1a450bawb57/resourceGroups/test-resourcegroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/query?disambiguation_dummy&query=StorageBlobLogs | summarize count() by OperationName | top 10 by count_ desc&timespan=PT24H

応答のサンプル

状態コード:

200

x-ms-request-id: 58a37988-2c05-427a-891f-5e0e1266fcc5
x-ms-correlation-request-id: 58a37988-2c05-427a-891f-5e0e1266fcc5

{
  "tables": [
    {
      "name": "PrimaryResult",
      "columns": [
        {
          "name": "OperationName",
          "type": "string"
        },
        {
          "name": "count_",
          "type": "long"
        }
      ],
      "rows": [
        [
          "operation1",
          "10"
        ]
      ]
    }
  ]
}

定義

名前	説明
column	テーブル列。
errorDetail	エラーの詳細。
errorInfo	エラーのコードとメッセージ。
errorResponse	エラーの詳細。
logsColumnType	この列のデータ型。
queryResults	クエリ応答。
Render	JSON 形式の視覚化データ。
Statistics	JSON 形式で表される統計。
table	クエリ応答テーブル。

column

Object

テーブル列。

名前	型	説明
name	string	この列の名前。
type	logsColumnType	この列のデータ型。

errorDetail

Object

エラーの詳細。

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

errorInfo

Object

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

名前	型	説明
additionalProperties	object	エラー情報オブジェクトに指定できる追加のプロパティ
code	string	コンピューターが読み取り可能なエラー コード。
details	errorDetail[]	エラーの詳細。
innererror	errorInfo	エラーのコードとメッセージ。 内部エラーの詳細 (存在する場合)。
message	string	人間が判読できるエラー メッセージ。

errorResponse

Object

エラーの詳細。

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

logsColumnType

列挙

この列のデータ型。

値	説明
bool
datetime
decimal
dynamic
guid
int
long
real
string
timespan

queryResults

Object

クエリ応答。

名前	型	説明
error	errorInfo	エラーのコードとメッセージ。
render	Render	JSON 形式の視覚化データ。
statistics	Statistics	JSON 形式で表される統計。
tables	table[]	テーブル、列、行の一覧。

Render

Object

JSON 形式の視覚化データ。

Statistics

Object

JSON 形式で表される統計。

table

Object

クエリ応答テーブル。

名前	型	説明
columns	column[]	このテーブル内の列の一覧。
name	string	テーブルの名前。
rows	object[]	このクエリの結果の行。