Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricsQueryClient

Package version

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

Hierarchy

  • MetricsQueryClient

Index

Constructors

constructor

Methods

listMetricDefinitions

  • /**

    Returns an async iterable iterator to list metric definitions.

    Example using for await syntax:

    const metricsQueryClient = new MetricsQueryClient(tokenCredential);
    const metricDefinitions = client.listMetricDefinitions(resourceUri, options);
    let i = 1;
    for await (const metricDefinition of metricDefinitions) {
      console.log(`metricDefinition ${i++}:`);
      console.log(metricDefinition);
    }

    Example using iter.next():

    let iter = client.listMetricDefinitions(resourceUri, options);
    let result = await iter.next();
    while (!result.done) {
      console.log(` metricDefinitions - ${result.value.id}, ${result.value.name}`);
      result = await iter.next();
    }

    Get a list of metric definitions, given a resource URI.

    Parameters

    • resourceUri: string

      The resource URI to get metric definitions for.

    • Optional options: ListMetricDefinitionsOptions

      Options for getting metric definitions.

    Returns PagedAsyncIterableIterator<MetricDefinition>

    Metric definitions for a given resource URI.

listMetricNamespaces

  • Returns an async iterable iterator to list metric namespaces.

    Example using for await syntax:

    const metricsQueryClient = new MetricsQueryClient(tokenCredential);
    const metricNamespaces = client.listMetricNamespaces(resourceUri, options);
    let i = 1;
    for await (const metricNamespace of metricNamespaces) {
      console.log(`metricNamespace ${i++}:`);
      console.log(metricNamespace);
    }

    Example using iter.next():

    let iter = client.listMetricNamespaces(resourceUri, options);
    let result = await iter.next();
    while (!result.done) {
      console.log(` metricNamespace - ${result.value.id}, ${result.value.name}`);
      result = await iter.next();
    }

    Get a list of metric namespaces, given a resource URI.

    Parameters

    • resourceUri: string

      The resource URI to get metric namespaces for.

    • Optional options: ListMetricNamespacesOptions

      Options for getting metric namespaces.

    Returns PagedAsyncIterableIterator<MetricNamespace>

    Metric namespaces for a given resource URI.

query

  • Query metrics, given a resource URI

    Parameters

    • resourceUri: string

      The resource URI to query.

    • metricNames: string[]

      The names of the metrics to retrieve.

    • Optional options: MetricsQueryOptions

      Options for querying metrics.

    Returns Promise<MetricsQueryResult>

    A response containing metrics.

Generated using TypeDoc