Microsoft.OperationalInsights (stable:v1)

2025/07/21 • 3 updated methods

Query_ExecuteWithResourceId (updated)
Description :  Executes an Analytics query for data in the context of a resource. [Here](https://learn.microsoft.com/azure/azure-monitor/logs/api/azure-resource-queries) is an example for using POST with an Analytics query.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Query_ExecuteWithResourceId",
  "$parameters": {
    "body": {
      "Description": {
        "new": "The Analytics query. Learn more about the\n[Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)",
        "old": "The Analytics query. Learn more about the [Analytics query\nsyntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)"
      }
    }
  }
}

⚼ Request

POST:  /{resourceId}/query
{
resourceId:
{
Description: The identifier of the resource. ,
Required: True ,
}
string ,
Prefer:
{
Description: Optional. The prefer header to set server timeout, query statistics and visualization information. ,
Required: False ,
}
string ,
body:
{
Description: The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/) ,
Required: True ,
}
{
query:
{
Description: The query to execute. ,
Required: True ,
}
string ,
timespan:
{
Description: 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. ,
Required: False ,
}
string ,
workspaces:
{
Description: A list of workspaces to query in addition to the primary workspace. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
tables:
{
Description: The results of the query in tabular format. ,
Required: True ,
}
[
{
name:
{
Description: The name of the table. ,
Required: True ,
}
string ,
columns:
{
Description: The list of columns in this table. ,
Required: True ,
}
[
{
name:
{
Description: The name of this column. ,
Required: True ,
}
string ,
type:
{
Description: The data type of this column. ,
Enum:
{
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 ,
}
,
Required: True ,
}
enum ,
}
,
]
,
rows:
{
Description: The resulting rows from this query. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
statistics:
{
Description: Statistics represented in JSON format. ,
Required: False ,
}
object ,
render:
{
Description: Visualization data in JSON format. ,
Required: False ,
}
object ,
error:
{
Description: The code and message for an error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
value:
{
Description: Indicates which value in 'target' is responsible for the error. ,
Required: False ,
}
string ,
resources:
{
Description: Indicates resources which were responsible for the error. ,
Required: False ,
}
[
string ,
]
,
additionalProperties:
{
Description: Additional properties that can be provided on the error details object ,
Required: False ,
}
object ,
}
,
]
,
innererror:
{
Required: False ,
}
string ,
additionalProperties:
{
Description: Additional properties that can be provided on the error info object ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
value:
{
Description: Indicates which value in 'target' is responsible for the error. ,
Required: False ,
}
string ,
resources:
{
Description: Indicates resources which were responsible for the error. ,
Required: False ,
}
[
string ,
]
,
additionalProperties:
{
Description: Additional properties that can be provided on the error details object ,
Required: False ,
}
object ,
}
,
]
,
innererror:
{
Required: False ,
}
string ,
additionalProperties:
{
Description: Additional properties that can be provided on the error info object ,
Required: False ,
}
object ,
}
,
}
Query_Batch (updated)
Description :  Executes a batch of Analytics queries for data. [Here](https://learn.microsoft.com/azure/azure-monitor/logs/api/batch-queries) is an example for using POST with an Analytics query.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Query_Batch",
  "$parameters": {
    "body": {
      "$properties": {
        "requests": {
          "$properties": [
            {
              "#name": "body",
              "Description": {
                "new": "The Analytics query. Learn more about the\n[Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)",
                "old": "The Analytics query. Learn more about the [Analytics query\nsyntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)"
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

POST:  /$batch
{
body:
{
Description: The batch request body ,
Required: True ,
}
{
requests:
{
Description: An single request in a batch. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID corresponding to each request in the batch. ,
Required: True ,
}
string ,
headers:
{
Description: Headers of the request. Can use prefer header to set server timeout and to query statistics and visualization information. ,
Required: False ,
}
object ,
body:
{
Description: The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/) ,
Required: True ,
}
{
query:
{
Description: The query to execute. ,
Required: True ,
}
string ,
timespan:
{
Description: 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. ,
Required: False ,
}
string ,
workspaces:
{
Description: A list of workspaces to query in addition to the primary workspace. ,
Required: False ,
}
[
string ,
]
,
}
,
path:
{
Description: The query path of a single request in a batch. ,
Required: True ,
}
string ,
method:
{
Description: The method of a single request in a batch, defaults to GET ,
Required: True ,
}
string ,
workspace:
{
Description: Primary Workspace ID of the query. This is the Workspace ID from the Properties blade in the Azure portal. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
responses:
{
Description: An array of responses corresponding to each individual request in a batch. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID corresponding to each request in the batch. ,
Required: False ,
}
string ,
status:
{
Description: The HTTP status code of the response. ,
Format: int32 ,
Required: False ,
}
integer ,
body:
{
Description: Contains the tables, columns & rows resulting from a query. ,
Required: False ,
}
{
tables:
{
Description: The results of the query in tabular format. ,
Required: False ,
}
[
{
name:
{
Description: The name of the table. ,
Required: True ,
}
string ,
columns:
{
Description: The list of columns in this table. ,
Required: True ,
}
[
{
name:
{
Description: The name of this column. ,
Required: True ,
}
string ,
type:
{
Description: The data type of this column. ,
Enum:
{
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 ,
}
,
Required: True ,
}
enum ,
}
,
]
,
rows:
{
Description: The resulting rows from this query. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
statistics:
{
Description: Statistics represented in JSON format. ,
Required: False ,
}
object ,
render:
{
Description: Visualization data in JSON format. ,
Required: False ,
}
object ,
error:
{
Description: The code and message for an error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
value:
{
Description: Indicates which value in 'target' is responsible for the error. ,
Required: False ,
}
string ,
resources:
{
Description: Indicates resources which were responsible for the error. ,
Required: False ,
}
[
string ,
]
,
additionalProperties:
{
Description: Additional properties that can be provided on the error details object ,
Required: False ,
}
object ,
}
,
]
,
innererror:
{
Required: False ,
}
string ,
additionalProperties:
{
Description: Additional properties that can be provided on the error info object ,
Required: False ,
}
object ,
}
,
}
,
headers:
{
Description: Dictionary of ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
value:
{
Description: Indicates which value in 'target' is responsible for the error. ,
Required: False ,
}
string ,
resources:
{
Description: Indicates resources which were responsible for the error. ,
Required: False ,
}
[
string ,
]
,
additionalProperties:
{
Description: Additional properties that can be provided on the error details object ,
Required: False ,
}
object ,
}
,
]
,
innererror:
{
Required: False ,
}
string ,
additionalProperties:
{
Description: Additional properties that can be provided on the error info object ,
Required: False ,
}
object ,
}
,
}
Query_Execute (updated)
Description :  Executes an Analytics query for data. [Here](https://learn.microsoft.com/azure/azure-monitor/logs/api/request-format) is an example for using POST with an Analytics query.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Query_Execute",
  "$parameters": {
    "body": {
      "Description": {
        "new": "The Analytics query. Learn more about the\n[Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)",
        "old": "The Analytics query. Learn more about the [Analytics query\nsyntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)"
      }
    }
  }
}

⚼ Request

POST:  /workspaces/{workspaceId}/query
{
workspaceId:
{
Description: Primary Workspace ID of the query. This is the Workspace ID from the Properties blade in the Azure portal. ,
Required: True ,
}
string ,
Prefer:
{
Description: Optional. The prefer header to set server timeout, query statistics and visualization information. ,
Required: False ,
}
string ,
body:
{
Description: The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/) ,
Required: True ,
}
{
query:
{
Description: The query to execute. ,
Required: True ,
}
string ,
timespan:
{
Description: 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. ,
Required: False ,
}
string ,
workspaces:
{
Description: A list of workspaces to query in addition to the primary workspace. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
tables:
{
Description: The results of the query in tabular format. ,
Required: True ,
}
[
{
name:
{
Description: The name of the table. ,
Required: True ,
}
string ,
columns:
{
Description: The list of columns in this table. ,
Required: True ,
}
[
{
name:
{
Description: The name of this column. ,
Required: True ,
}
string ,
type:
{
Description: The data type of this column. ,
Enum:
{
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 ,
}
,
Required: True ,
}
enum ,
}
,
]
,
rows:
{
Description: The resulting rows from this query. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
statistics:
{
Description: Statistics represented in JSON format. ,
Required: False ,
}
object ,
render:
{
Description: Visualization data in JSON format. ,
Required: False ,
}
object ,
error:
{
Description: The code and message for an error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
value:
{
Description: Indicates which value in 'target' is responsible for the error. ,
Required: False ,
}
string ,
resources:
{
Description: Indicates resources which were responsible for the error. ,
Required: False ,
}
[
string ,
]
,
additionalProperties:
{
Description: Additional properties that can be provided on the error details object ,
Required: False ,
}
object ,
}
,
]
,
innererror:
{
Required: False ,
}
string ,
additionalProperties:
{
Description: Additional properties that can be provided on the error info object ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
value:
{
Description: Indicates which value in 'target' is responsible for the error. ,
Required: False ,
}
string ,
resources:
{
Description: Indicates resources which were responsible for the error. ,
Required: False ,
}
[
string ,
]
,
additionalProperties:
{
Description: Additional properties that can be provided on the error details object ,
Required: False ,
}
object ,
}
,
]
,
innererror:
{
Required: False ,
}
string ,
additionalProperties:
{
Description: Additional properties that can be provided on the error info object ,
Required: False ,
}
object ,
}
,
}