LogsQueryOptions interface

Package:

@azure/monitor-query

Options for querying logs.

Extends

OperationOptions

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.
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)

Inherited Properties

abortSignal	The signal which can be used to abort requests.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
serializerOptions	Options to override serialization/de-serialization behavior.
tracingOptions	Options used when tracing is enabled.

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

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

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions