@azure/monitor-query package

Classes

LogsQueryClient

Client for Azure Log Analytics

MetricsQueryClient

A client that can query metrics, get metric definitions and get metric namespaces.

Interfaces

ListMetricDefinitionsOptions

Options used when getting metric definitions.

ListMetricNamespacesOptions

Options used when getting metric namespaces.

LogsColumn

A column in a table.

LogsErrorInfo

The code and message for an error.

LogsQueryBatchOptions

Configurable HTTP request settings for the Logs query batch operation.

LogsQueryClientOptions

Options for the LogsQueryClient.

LogsQueryError

Result type for Failure Scenario representing error for logs queryWorkspace and queryBatch operations.

LogsQueryOptions

Options for querying logs.

LogsQueryPartialResult

Result type for Partial Failure Scenario for logs queryWorkspace and queryBatch operations.

LogsQuerySuccessfulResult

Result type for Success Scenario for logs query workspace and query batch operations.

LogsTable

Contains the columns and rows for one table in a query response.

MetadataValue

Represents a metric metadata value.

Metric

The result data of a query.

MetricAvailability

Metric availability specifies the time grain (aggregation interval or frequency) and the retention period for that time grain.

MetricDefinition

Metric definition class specifies the metadata for a metric.

MetricNamespace

Metric namespace class specifies the metadata for a metric namespace.

MetricValue

Represents a metric value.

MetricsClientOptions

Options for the MetricsQueryClient.

MetricsQueryOptions

Options used when querying metrics.

MetricsQueryResult

Metrics, including additional information like cost, the resourceRegion, etc...

QueryBatch

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

TimeSeriesElement

A time series result type. The discriminator value is always TimeSeries in this case.

Type Aliases

AggregationType

Defines values for AggregationType.

LogsColumnType

Defines values for LogsColumnType.
<xref:KnownLogsColumnType> can be used interchangeably with LogsColumnType, this enum contains the known values that the service supports.

Known values supported by the service

bool
datetime
dynamic
int
long
real
string
guid
decimal
timespan

LogsQueryBatchResult

Results for a batch query. Each result in the array is either of type LogsQueryError or LogsQueryPartialResult or LogsQuerySuccessfulResult

LogsQueryResult

Tables and statistic results from a logs query.

MetricClass

Defines values for MetricClass.
<xref:KnownMetricClass> can be used interchangeably with MetricClass, this enum contains the known values that the service supports.

Known values supported by the service

Availability
Transactions
Errors
Latency
Saturation

MetricUnit

Defines values for MetricUnit.
<xref:KnownMetricUnit> can be used interchangeably with MetricUnit, this enum contains the known values that the service supports.

Known values supported by the service

Count
Bytes
Seconds
CountPerSecond
BytesPerSecond
Percent
MilliSeconds
ByteSeconds
Unspecified
Cores
MilliCores
NanoCores
BitsPerSecond

NamespaceClassification

Defines values for NamespaceClassification.
<xref:KnownNamespaceClassification> can be used interchangeably with NamespaceClassification, this enum contains the known values that the service supports.

Known values supported by the service

Platform
Custom
Qos

QueryTimeInterval

Time Interval type for specifying timespan for querying logs and metrics. A time interval is the intervening time between two time points. The amount of intervening time is expressed by a duration The two time points (start and end) are expressed by either a combined date and time representation or just a date representation.There are four ways to express a time interval:

  • duration
  • start time, end time
  • start time, duration
  • duration, end time
ResultType

Defines values for ResultType.

Enums

LogsQueryResultStatus

Indicates if a query succeeded or failed or partially failed. Represented by PartialFailure" | "Success" | "Failure".