QueryBatch interface

Package:

@azure/monitor-query

The Kusto query. For more information about Kusto, see Kusto query overview.

Properties

additionalWorkspaces	A list of workspaces that are included in the query, except for the one set as the workspaceId parameter These may consist of the following identifier formats: Qualified workspace names Workspace IDs Azure resource IDs
includeQueryStatistics	Results will also include statistics about the query.
includeVisualization	Results will also include visualization information, in JSON format.
query	The query to execute.
serverTimeoutInSeconds	The maximum amount of time the server will spend processing the query. Default: 180 seconds (3 minutes), maximum allowed is 600 seconds (10 minutes)
timespan	The timespan over which to query data. This timespan is applied in addition to any that are specified in the query expression.
workspaceId	The workspace for this query.

Property Details

additionalWorkspaces

A list of workspaces that are included in the query, except for the one set as the workspaceId parameter These may consist of the following identifier formats:

• Qualified workspace names
• Workspace IDs
• Azure resource IDs

additionalWorkspaces?: string[]

Property Value

string[]

includeQueryStatistics

Results will also include statistics about the query.

includeQueryStatistics?: boolean

Property Value

boolean

includeVisualization

Results will also include visualization information, in JSON format.

includeVisualization?: boolean

Property Value

boolean

query

The query to execute.

query: string

Property Value

string

serverTimeoutInSeconds

The maximum amount of time the server will spend processing the query. Default: 180 seconds (3 minutes), maximum allowed is 600 seconds (10 minutes)

serverTimeoutInSeconds?: number

Property Value

number

timespan

The timespan over which to query data. This timespan is applied in addition to any that are specified in the query expression.

timespan: QueryTimeInterval

Property Value

QueryTimeInterval

workspaceId

The workspace for this query.

workspaceId: string

Property Value

string