Query - Execute With Resource Id

Service:

Log Analytics

API Version:

v1

Execute an Analytics query using resource ID
Executes an Analytics query for data in the context of a resource. Here is an example for using POST with an Analytics query.

POST {endpoint}/{apiVersion}/{resourceId}/query

URI Parameters

Name	In	Required	Type	Description
apiVersion	path	True	string	The service API version.
endpoint	path	True	string (uri)	The Log Analytics service endpoint.
resourceId	path	True	string	The identifier of the resource.

Request Header

Name	Required	Type	Description
Prefer		string	Optional. The prefer header to set server timeout, query statistics and visualization information.

Request Body

Name	Required	Type	Description
query	True	string	The query to execute.
timespan		string	Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression.
workspaces		string[]	A list of workspaces to query in addition to the primary workspace.

Responses

Name	Type	Description
200 OK	QueryResults	The request has succeeded.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://api.loganalytics.io/.default

Examples

Simple resource-centric POST query

Sample request

HTTP

POST {endpoint}/{apiVersion}/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"
}

Sample response

Status code:

200

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

Definitions

Name	Description
Column	A column in a table.
ColumnDataType	The data type of a column.
ErrorDetail	Error details.
ErrorInfo	The code and message for an error.
ErrorResponse	Contains details when the response code indicates an error.
QueryBody	The Analytics query. Learn more about the Analytics query syntax
QueryResults	Contains the tables, columns & rows resulting from a query.
Table	Contains the columns and rows for one table in a query response.

Column

Object

A column in a table.

Name	Type	Description
name	string	The name of this column.
type	ColumnDataType	The data type of this column.

ColumnDataType

Enumeration

The data type of a column.

Value	Description
bool	Boolean data type
datetime	DateTime data type
dynamic	Dynamic data type
int	Integer data type
long	Long integer data type
real	Real/floating point data type
string	String data type
guid	GUID data type
decimal	Decimal data type
timespan	Timespan data type

ErrorDetail

Object

Error details.

Name	Type	Description
additionalProperties		Additional properties that can be provided on the error details object
code	string	The error's code.
message	string	A human readable error message.
resources	string[]	Indicates resources which were responsible for the error.
target	string	Indicates which property in the request is responsible for the error.
value	string	Indicates which value in 'target' is responsible for the error.

ErrorInfo

Object

The code and message for an error.

Name	Type	Description
additionalProperties		Additional properties that can be provided on the error info object
code	string	A machine readable error code.
details	ErrorDetail[]	error details.
innererror	ErrorInfo	Inner error details if they exist.
message	string	A human readable error message.

ErrorResponse

Object

Contains details when the response code indicates an error.

Name	Type	Description
error	ErrorInfo	The error details.

QueryBody

Object

The Analytics query. Learn more about the Analytics query syntax

Name	Type	Description
query	string	The query to execute.
timespan	string	Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression.
workspaces	string[]	A list of workspaces to query in addition to the primary workspace.

QueryResults

Object

Contains the tables, columns & rows resulting from a query.

Name	Type	Description
error	ErrorInfo	The code and message for an error.
render		Visualization data in JSON format.
statistics		Statistics represented in JSON format.
tables	Table[]	The results of the query in tabular format.

Table

Object

Contains the columns and rows for one table in a query response.

Name	Type	Description
columns	Column[]	The list of columns in this table.
name	string	The name of the table.
rows	Rows[]	The resulting rows from this query.