Class LogsQueryClient

Package version

Client for Azure Log Analytics

Hierarchy

LogsQueryClient

Index

Constructors

constructor

Methods

Constructors

constructor

new LogsQueryClient(tokenCredential: TokenCredential, options?: LogsQueryClientOptions): LogsQueryClient

- Defined in logsQueryClient.ts:54
Construct a LogsClient that can be used to query logs using the Log Analytics Query language.

Parameters
- tokenCredential: TokenCredential
  
  A token credential.
- Optional options: LogsQueryClientOptions
  
  Options for the LogsClient.
Returns LogsQueryClient

Methods

query

query(workspaceId: string, query: string, timespan: TimeInterval, options?: LogsQueryOptions): Promise<LogsQueryResult>

- Defined in logsQueryClient.ts:89
Queries logs in a Log Analytics Workspace.

Parameters
- workspaceId: string
  
  The 'Workspace Id' for the Log Analytics Workspace
- query: string
  
  A Kusto query.
- timespan: TimeInterval
  
  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. Some common durations can be found in the Durations object.
- Optional options: LogsQueryOptions
  
  Options to adjust various aspects of the request.
Returns Promise<LogsQueryResult>

The result of the query.

queryBatch

queryBatch(batch: QueryBatch[], options?: LogsQueryBatchOptions): Promise<LogsQueryBatchResult>

- Defined in logsQueryClient.ts:152
Query Logs with multiple queries, in a batch.

Parameters
- batch: QueryBatch[]
  
  A batch of Kusto queries to execute. Each query can be configured to run against separate workspaces.
- Optional options: LogsQueryBatchOptions
  
  Options for querying logs in a batch.
Returns Promise<LogsQueryBatchResult>

The Logs query results for all the queries.

Generated using TypeDoc