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:50
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

queryLogs

queryLogs(workspaceId: string, query: string, timespan: string, options?: QueryLogsOptions): Promise<QueryLogsResult>

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

Parameters
- workspaceId: string
  
  The 'Workspace Id' for the Log Analytics Workspace
- query: string
  
  A Log Analytics Query
- timespan: string
  
  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: QueryLogsOptions
  
  Options to adjust various aspects of the request.
Returns Promise<QueryLogsResult>

The result of the query.

queryLogsBatch

queryLogsBatch(batch: QueryLogsBatch, options?: QueryLogsBatchOptions): Promise<QueryLogsBatchResult>

- Defined in logsQueryClient.ts:119
Query logs with multiple queries, in a batch.

Parameters
- batch: QueryLogsBatch
  
  A batch of queries to run. Each query can be configured to run against separate workspaces.
- Optional options: QueryLogsBatchOptions
  
  Options for querying logs in a batch.
Returns Promise<QueryLogsBatchResult>

The log query results for all the queries.

Generated using TypeDoc