Microsoft.OperationalInsights (stable:v1)

2025/07/17 • 7 new methods

Query_GetWithResourceId (new)
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 ¶

⚼ Request

GET:  /{resourceId}/query
{
resourceId:
{
Description: The identifier of the resource. ,
Required: True ,
}
string ,
query:
{
Description: The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/) ,
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. ,
Format: duration ,
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_ExecuteWithResourceId (new)
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 ¶

⚼ 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 (new)
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 ¶

⚼ 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, defaults to /query ,
Enum:
{
/query: No description available. ,
}
,
Required: False ,
}
enum ,
method:
{
Description: The method of a single request in a batch, defaults to POST ,
Enum:
{
POST: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
Metadata_Get (new)
Description :  Retrieve the metadata information for the workspace, including its schema, functions, workspace info, categories etc.
Reference :  Link ¶

⚼ Request

GET:  /workspaces/{workspaceId}/metadata
{
workspaceId:
{
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)

{
categories:
{
Description: The list of categories that are referenced in this metadata response. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the category ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the category ,
Required: True ,
}
string ,
description:
{
Description: The description of the category ,
Required: False ,
}
string ,
related:
{
Description: The related metadata items for the category ,
Required: False ,
}
{
tables:
{
Description: The tables related to the category ,
Required: False ,
}
[
string ,
]
,
functions:
{
Description: The functions related to the category ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The resource types related to the category ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: The saved queries related to the category ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The Log Analytics solutions related to the category ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
resourceTypes:
{
Description: The list of resource types that are referenced in this metadata response. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the resource-type ,
Required: True ,
}
string ,
type:
{
Description: The type of the resource-type ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the resource-type ,
Required: False ,
}
string ,
description:
{
Description: The description of the resource-type ,
Required: False ,
}
string ,
labels:
{
Description: The user-defined labels of the resource-type ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The tags associated with the resource-type ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the resource-type ,
Required: False ,
}
object ,
related:
{
Description: The related metadata items for the resource-type ,
Required: False ,
}
{
tables:
{
Description: The tables related to the resource-type ,
Required: False ,
}
[
string ,
]
,
functions:
{
Description: The functions related to the resource-type ,
Required: False ,
}
[
string ,
]
,
categories:
{
Description: The categories related to the resource-type ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: The queries related to the resource-type ,
Required: False ,
}
[
string ,
]
,
workspaces:
{
Description: The Log Analytics workspaces related to the resource-type ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The Azure resources related to the resource-type ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
solutions:
{
Description: The list of Log Analytics solutions installed on the workspace. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the Log Analytics solution ,
Required: True ,
}
string ,
name:
{
Description: The name of the Log Analytics solution ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the Log Analytics solution ,
Required: False ,
}
string ,
description:
{
Description: The description of the Log Analytics solution ,
Required: False ,
}
string ,
tags:
{
Description: The tags that are associated with the Log Analytics solution ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the Log Analytics solution ,
Required: False ,
}
object ,
related:
{
Description: The related metadata items for the Log Analytics solution ,
Required: True ,
}
{
tables:
{
Description: The tables related to the Log Analytics solution ,
Required: True ,
}
[
string ,
]
,
functions:
{
Description: The functions related to the Log Analytics solution ,
Required: False ,
}
[
string ,
]
,
categories:
{
Description: The categories related to the Log Analytics solution ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: The saved queries related to the Log Analytics solution ,
Required: False ,
}
[
string ,
]
,
workspaces:
{
Description: The Workspaces referenced in the metadata request that are related to the Log Analytics solution ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
tables:
{
Description: The list of tables and columns that comprise the schema of the workspace. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the table ,
Required: True ,
}
string ,
name:
{
Description: The name of the table ,
Required: True ,
}
string ,
description:
{
Description: The description of the table ,
Required: False ,
}
string ,
timespanColumn:
{
Description: The column associated with the timespan query parameter for the table ,
Required: False ,
}
string ,
labels:
{
Description: The user defined labels of the table ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The tags associated with the table ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the table ,
Required: False ,
}
object ,
columns:
{
Description: The list of columns defined on the table ,
Required: False ,
}
[
{
name:
{
Description: The name of the column ,
Required: True ,
}
string ,
description:
{
Description: The description of the column ,
Required: False ,
}
string ,
type:
{
Description: The data type of the 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 ,
isPreferredFacet:
{
Description: A flag indicating this column is a preferred facet ,
Required: False ,
}
boolean ,
source:
{
Description: An indication of the source of the column, used only when multiple workspaces have conflicting definition for the column ,
Required: False ,
}
object ,
}
,
]
,
related:
{
Description: The related metadata items for the table ,
Required: False ,
}
{
categories:
{
Description: The related categories for the table ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The related Log Analytics solutions for the table ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The related resource types for the table ,
Required: False ,
}
[
string ,
]
,
workspaces:
{
Description: The related Log Analytics workspaces for the table ,
Required: False ,
}
[
string ,
]
,
functions:
{
Description: The related functions for the table ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: The related saved queries for the table ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
functions:
{
Description: The list of functions stored on the workspace, or introduced by solutions etc. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the function. ,
Required: True ,
}
string ,
name:
{
Description: The name of the function, to be used in queries. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters/arguments of the function, if any. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the function. ,
Required: False ,
}
string ,
description:
{
Description: The description of the function. ,
Required: False ,
}
string ,
body:
{
Description: The KQL body of the function. ,
Required: True ,
}
string ,
tags:
{
Description: The tags associated with the function. ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the function. ,
Required: False ,
}
object ,
related:
{
Description: The related metadata items for the function. ,
Required: False ,
}
{
tables:
{
Description: The related tables for the function. ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The related Log Analytics solutions for the function. ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The related resource types for the function. ,
Required: False ,
}
[
string ,
]
,
categories:
{
Description: The related categories for the function. ,
Required: False ,
}
[
string ,
]
,
workspaces:
{
Description: The related workspaces for the function. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
queries:
{
Description: The list of saved queries stored on the workspace, or introduced by solutions, resource types, etc. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the query. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the query. ,
Required: False ,
}
string ,
description:
{
Description: The description of the query. ,
Required: False ,
}
string ,
body:
{
Description: The KQL body of the query. ,
Required: True ,
}
string ,
labels:
{
Description: The user defined labels associated with the query. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The tags associated with the query. ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the query. ,
Required: False ,
}
object ,
related:
{
Description: The related metadata items for the query. ,
Required: False ,
}
{
categories:
{
Description: The related categories for the query. ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The related Log Analytics solutions for the query. ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The related resource types for the query. ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The related tables for the query. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
applications:
{
Description: The list of Application Insights apps that were referenced in the metadata request. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the Application Insights app. ,
Required: True ,
}
string ,
resourceId:
{
Description: The ARM resource ID of the Application Insights app. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Application Insights app. ,
Required: True ,
}
string ,
region:
{
Description: The Azure region of the Application Insights app. ,
Required: True ,
}
string ,
related:
{
Description: The related metadata items for the Application Insights app. ,
Required: False ,
}
{
tables:
{
Description: The related tables for the Application Insights app. ,
Required: False ,
}
[
string ,
]
,
functions:
{
Description: The related functions for the Application Insights app. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
workspaces:
{
Description: The list of Log Analytics workspaces that were referenced in the metadata request. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the Log Analytics workspace. ,
Required: True ,
}
string ,
resourceId:
{
Description: The ARM resource ID of the Log Analytics workspace. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Log Analytics workspace. ,
Required: True ,
}
string ,
region:
{
Description: The Azure region of the Log Analytics workspace. ,
Required: True ,
}
string ,
related:
{
Description: The related metadata items for the Log Analytics workspace. ,
Required: False ,
}
{
tables:
{
Description: The related tables for the Log Analytics workspace. ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The related Log Analytics solutions for the Log Analytics workspace. ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The related resource types for the Log Analytics workspace. ,
Required: False ,
}
[
string ,
]
,
functions:
{
Description: The related functions for the Log Analytics workspace. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The related Azure resources for the Log Analytics workspace. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
resources:
{
Description: The list of Azure resources that were referenced in the metadata request. ,
Required: False ,
}
[
string ,
]
,
permissions:
{
Description: The list of permission rules that affected the metadata request. ,
Required: False ,
}
[
{
workspaces:
{
Description: The permission indication for the workspaces on the metadata request. ,
Required: True ,
}
[
{
resourceId:
{
Description: The resource ID on the permission indication. ,
Required: True ,
}
string ,
denyTables:
{
Description: The list of tables that were denied access for the resource ID. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
resources:
{
Description: The permission indication for the Azure resources on the metadata request. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID on the permission indication. ,
Required: True ,
}
string ,
denyTables:
{
Description: The list of tables that were denied access for the resource ID. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applications:
{
Description: The permission indication for the Application Insights apps on the metadata request. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID on the permission indication. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ 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 ,
}
,
}
Metadata_Post (new)
Description :  Retrieve the metadata information for the workspace, including its schema, functions, workspace info, categories etc.
Reference :  Link ¶

⚼ Request

POST:  /workspaces/{workspaceId}/metadata
{
workspaceId:
{
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)

{
categories:
{
Description: The list of categories that are referenced in this metadata response. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the category ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the category ,
Required: True ,
}
string ,
description:
{
Description: The description of the category ,
Required: False ,
}
string ,
related:
{
Description: The related metadata items for the category ,
Required: False ,
}
{
tables:
{
Description: The tables related to the category ,
Required: False ,
}
[
string ,
]
,
functions:
{
Description: The functions related to the category ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The resource types related to the category ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: The saved queries related to the category ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The Log Analytics solutions related to the category ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
resourceTypes:
{
Description: The list of resource types that are referenced in this metadata response. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the resource-type ,
Required: True ,
}
string ,
type:
{
Description: The type of the resource-type ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the resource-type ,
Required: False ,
}
string ,
description:
{
Description: The description of the resource-type ,
Required: False ,
}
string ,
labels:
{
Description: The user-defined labels of the resource-type ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The tags associated with the resource-type ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the resource-type ,
Required: False ,
}
object ,
related:
{
Description: The related metadata items for the resource-type ,
Required: False ,
}
{
tables:
{
Description: The tables related to the resource-type ,
Required: False ,
}
[
string ,
]
,
functions:
{
Description: The functions related to the resource-type ,
Required: False ,
}
[
string ,
]
,
categories:
{
Description: The categories related to the resource-type ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: The queries related to the resource-type ,
Required: False ,
}
[
string ,
]
,
workspaces:
{
Description: The Log Analytics workspaces related to the resource-type ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The Azure resources related to the resource-type ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
solutions:
{
Description: The list of Log Analytics solutions installed on the workspace. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the Log Analytics solution ,
Required: True ,
}
string ,
name:
{
Description: The name of the Log Analytics solution ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the Log Analytics solution ,
Required: False ,
}
string ,
description:
{
Description: The description of the Log Analytics solution ,
Required: False ,
}
string ,
tags:
{
Description: The tags that are associated with the Log Analytics solution ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the Log Analytics solution ,
Required: False ,
}
object ,
related:
{
Description: The related metadata items for the Log Analytics solution ,
Required: True ,
}
{
tables:
{
Description: The tables related to the Log Analytics solution ,
Required: True ,
}
[
string ,
]
,
functions:
{
Description: The functions related to the Log Analytics solution ,
Required: False ,
}
[
string ,
]
,
categories:
{
Description: The categories related to the Log Analytics solution ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: The saved queries related to the Log Analytics solution ,
Required: False ,
}
[
string ,
]
,
workspaces:
{
Description: The Workspaces referenced in the metadata request that are related to the Log Analytics solution ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
tables:
{
Description: The list of tables and columns that comprise the schema of the workspace. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the table ,
Required: True ,
}
string ,
name:
{
Description: The name of the table ,
Required: True ,
}
string ,
description:
{
Description: The description of the table ,
Required: False ,
}
string ,
timespanColumn:
{
Description: The column associated with the timespan query parameter for the table ,
Required: False ,
}
string ,
labels:
{
Description: The user defined labels of the table ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The tags associated with the table ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the table ,
Required: False ,
}
object ,
columns:
{
Description: The list of columns defined on the table ,
Required: False ,
}
[
{
name:
{
Description: The name of the column ,
Required: True ,
}
string ,
description:
{
Description: The description of the column ,
Required: False ,
}
string ,
type:
{
Description: The data type of the 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 ,
isPreferredFacet:
{
Description: A flag indicating this column is a preferred facet ,
Required: False ,
}
boolean ,
source:
{
Description: An indication of the source of the column, used only when multiple workspaces have conflicting definition for the column ,
Required: False ,
}
object ,
}
,
]
,
related:
{
Description: The related metadata items for the table ,
Required: False ,
}
{
categories:
{
Description: The related categories for the table ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The related Log Analytics solutions for the table ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The related resource types for the table ,
Required: False ,
}
[
string ,
]
,
workspaces:
{
Description: The related Log Analytics workspaces for the table ,
Required: False ,
}
[
string ,
]
,
functions:
{
Description: The related functions for the table ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: The related saved queries for the table ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
functions:
{
Description: The list of functions stored on the workspace, or introduced by solutions etc. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the function. ,
Required: True ,
}
string ,
name:
{
Description: The name of the function, to be used in queries. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters/arguments of the function, if any. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the function. ,
Required: False ,
}
string ,
description:
{
Description: The description of the function. ,
Required: False ,
}
string ,
body:
{
Description: The KQL body of the function. ,
Required: True ,
}
string ,
tags:
{
Description: The tags associated with the function. ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the function. ,
Required: False ,
}
object ,
related:
{
Description: The related metadata items for the function. ,
Required: False ,
}
{
tables:
{
Description: The related tables for the function. ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The related Log Analytics solutions for the function. ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The related resource types for the function. ,
Required: False ,
}
[
string ,
]
,
categories:
{
Description: The related categories for the function. ,
Required: False ,
}
[
string ,
]
,
workspaces:
{
Description: The related workspaces for the function. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
queries:
{
Description: The list of saved queries stored on the workspace, or introduced by solutions, resource types, etc. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the query. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the query. ,
Required: False ,
}
string ,
description:
{
Description: The description of the query. ,
Required: False ,
}
string ,
body:
{
Description: The KQL body of the query. ,
Required: True ,
}
string ,
labels:
{
Description: The user defined labels associated with the query. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The tags associated with the query. ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the query. ,
Required: False ,
}
object ,
related:
{
Description: The related metadata items for the query. ,
Required: False ,
}
{
categories:
{
Description: The related categories for the query. ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The related Log Analytics solutions for the query. ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The related resource types for the query. ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The related tables for the query. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
applications:
{
Description: The list of Application Insights apps that were referenced in the metadata request. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the Application Insights app. ,
Required: True ,
}
string ,
resourceId:
{
Description: The ARM resource ID of the Application Insights app. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Application Insights app. ,
Required: True ,
}
string ,
region:
{
Description: The Azure region of the Application Insights app. ,
Required: True ,
}
string ,
related:
{
Description: The related metadata items for the Application Insights app. ,
Required: False ,
}
{
tables:
{
Description: The related tables for the Application Insights app. ,
Required: False ,
}
[
string ,
]
,
functions:
{
Description: The related functions for the Application Insights app. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
workspaces:
{
Description: The list of Log Analytics workspaces that were referenced in the metadata request. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the Log Analytics workspace. ,
Required: True ,
}
string ,
resourceId:
{
Description: The ARM resource ID of the Log Analytics workspace. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Log Analytics workspace. ,
Required: True ,
}
string ,
region:
{
Description: The Azure region of the Log Analytics workspace. ,
Required: True ,
}
string ,
related:
{
Description: The related metadata items for the Log Analytics workspace. ,
Required: False ,
}
{
tables:
{
Description: The related tables for the Log Analytics workspace. ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The related Log Analytics solutions for the Log Analytics workspace. ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The related resource types for the Log Analytics workspace. ,
Required: False ,
}
[
string ,
]
,
functions:
{
Description: The related functions for the Log Analytics workspace. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The related Azure resources for the Log Analytics workspace. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
resources:
{
Description: The list of Azure resources that were referenced in the metadata request. ,
Required: False ,
}
[
string ,
]
,
permissions:
{
Description: The list of permission rules that affected the metadata request. ,
Required: False ,
}
[
{
workspaces:
{
Description: The permission indication for the workspaces on the metadata request. ,
Required: True ,
}
[
{
resourceId:
{
Description: The resource ID on the permission indication. ,
Required: True ,
}
string ,
denyTables:
{
Description: The list of tables that were denied access for the resource ID. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
resources:
{
Description: The permission indication for the Azure resources on the metadata request. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID on the permission indication. ,
Required: True ,
}
string ,
denyTables:
{
Description: The list of tables that were denied access for the resource ID. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applications:
{
Description: The permission indication for the Application Insights apps on the metadata request. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID on the permission indication. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ 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_Get (new)
Description :  Executes an Analytics query for data.
Reference :  Link ¶

⚼ Request

GET:  /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 ,
query:
{
Description: The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/) ,
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. ,
Format: duration ,
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_Execute (new)
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 ¶

⚼ 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 ,
}
,
}