Query - Resource Execute

リファレンス

サービス:: Log Analytics

API バージョン:: 2022-10-27_Preview

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

POST https://api.loganalytics.io/v1/{resourceId}/query

URI パラメーター

名前	/	必須	型	説明
resourceId	path	True	string	リソースの識別子。

要求ヘッダー

名前	必須	型	説明
Prefer		string	省略可能。サーバータイムアウト、クエリ統計、視覚化情報を設定する優先ヘッダー。

要求本文

名前	必須	型	説明
query	True	string	実行するクエリ。
timespan		string	省略可能。データのクエリを実行する期間。これは、ISO8601期間の値です。この期間は、クエリ式で指定されているに加えて適用されます。
workspaces		string[]	クエリに含まれるワークスペースの一覧。

応答

名前	型	説明
200 OK	queryResults	OK です。 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

POST https://api.loganalytics.io/v1//subscriptions/fffa080af-c2d8-40ad-9cce-e1a450bawb57/resourceGroups/test-resourcegroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/query

{
  "query": "StorageBlobLogs | summarize count() by OperationName | top 10 by count_ desc",
  "timespan": "PT24H"
}

応答のサンプル

状態コード:: 200

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

定義

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

column

テーブル列。

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

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	エラーのコードとメッセージ。エラーの詳細です。

logsColumnType

この列のデータ型。

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

queryBody

Analytics クエリ。 Analytics クエリ構文の詳細を確認する

名前	型	説明
query	string	実行するクエリ。
timespan	string	省略可能。データのクエリを実行する期間。これは、ISO8601期間の値です。この期間は、クエリ式で指定されているに加えて適用されます。
workspaces	string[]	クエリに含まれるワークスペースの一覧。

queryResults

クエリ応答。

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

Render

JSON 形式の視覚化データ。

Statistics

JSON 形式で表される統計。

table

クエリ応答テーブル。

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

次の方法で共有