MetricsQueryClient class
A client that can query metrics, get metric definitions and get metric namespaces.
Constructors
| Metrics |
Creates a MetricsQueryClient. |
Methods
| list |
/** Returns an async iterable iterator to list metric definitions. Example using Get a list of metric definitions, given a resource URI. |
| list |
Returns an async iterable iterator to list metric namespaces. Example using Get a list of metric namespaces, given a resource URI. |
| query |
Query metrics, given a resource URI |
Constructor Details
MetricsQueryClient(TokenCredential, MetricsQueryClientOptions)
Creates a MetricsQueryClient.
new MetricsQueryClient(tokenCredential: TokenCredential, options?: MetricsQueryClientOptions)Parameters
- tokenCredential
- TokenCredential
A TokenCredential that has rights to query metrics on resources.
- options
- MetricsClientOptions
Options for the client like controlling request retries.
Method Details
listMetricDefinitions(string, ListMetricDefinitionsOptions)
/**
Returns an async iterable iterator to list metric definitions.
Example using for await syntax:
import { DefaultAzureCredential } from "@azure/identity";
import { MetricsQueryClient } from "@azure/monitor-query";
const metricsResourceId = "<the Resource Id for your metrics resource>";
const tokenCredential = new DefaultAzureCredential();
const metricsQueryClient = new MetricsQueryClient(tokenCredential);
const metricDefinitions = metricsQueryClient.listMetricDefinitions(metricsResourceId);
for await (const { id, name } of metricDefinitions) {
console.log(` metricDefinitions - ${id}, ${name}`);
}
Get a list of metric definitions, given a resource URI.
function listMetricDefinitions(resourceUri: string, options?: ListMetricDefinitionsOptions): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>Parameters
- resourceUri
-
string
The resource URI to get metric definitions for.
- options
- ListMetricDefinitionsOptions
Options for getting metric definitions.
Returns
Metric definitions for a given resource URI.
listMetricNamespaces(string, ListMetricNamespacesOptions)
Returns an async iterable iterator to list metric namespaces.
Example using for await syntax:
import { DefaultAzureCredential } from "@azure/identity";
import { MetricsQueryClient } from "@azure/monitor-query";
const metricsResourceId = "<the Resource Id for your metrics resource>";
const tokenCredential = new DefaultAzureCredential();
const metricsQueryClient = new MetricsQueryClient(tokenCredential);
const metricNamespaces = metricsQueryClient.listMetricNamespaces(metricsResourceId);
for await (const { id, name } of metricNamespaces) {
console.log(` metricNamespaces - ${id}, ${name}`);
}
Get a list of metric namespaces, given a resource URI.
function listMetricNamespaces(resourceUri: string, options?: ListMetricNamespacesOptions): PagedAsyncIterableIterator<MetricNamespace, MetricNamespace[], PageSettings>Parameters
- resourceUri
-
string
The resource URI to get metric namespaces for.
- options
- ListMetricNamespacesOptions
Options for getting metric namespaces.
Returns
Metric namespaces for a given resource URI.
queryResource(string, string[], MetricsQueryOptions)
Query metrics, given a resource URI
function queryResource(resourceUri: string, metricNames: string[], options?: MetricsQueryOptions): Promise<MetricsQueryResult>Parameters
- resourceUri
-
string
The resource URI to query.
- metricNames
-
string[]
The names of the metrics to retrieve.
- options
- MetricsQueryOptions
Options for querying metrics.
Returns
Promise<MetricsQueryResult>
A response containing metrics.