Compartir a través de

MetricsQueryClient class

  • Referencia
Paquete:
@azure/monitor-query

Un cliente que puede consultar métricas, obtener definiciones de métricas y obtener espacios de nombres de métricas.

Constructores

MetricsQueryClient(TokenCredential, MetricsClientOptions)

Crea metricsQueryClient.

Métodos

listMetricDefinitions(string, ListMetricDefinitionsOptions)

/**

Devuelve un iterador asincrónico para enumerar las definiciones de métricas.

Ejemplo de uso de for await la sintaxis:

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);
}

Ejemplo con 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();
}

Obtenga una lista de definiciones de métricas, dado un URI de recurso.
listMetricNamespaces(string, ListMetricNamespacesOptions)

Devuelve un iterador asincrónico para enumerar los espacios de nombres de métricas.

Ejemplo de uso de for await la sintaxis:

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);
}

Ejemplo con 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();
}

Obtenga una lista de espacios de nombres de métricas, dado un URI de recurso.
queryResource(string, string[], MetricsQueryOptions)

Métricas de consulta, dada una URI de recurso

Detalles del constructor

MetricsQueryClient(TokenCredential, MetricsClientOptions)

Crea metricsQueryClient.

new MetricsQueryClient(tokenCredential: TokenCredential, options?: MetricsClientOptions)

Parámetros

tokenCredential
TokenCredential

TokenCredential que tiene derechos para consultar métricas en recursos.

options
MetricsClientOptions

Opciones para el cliente como controlar los reintentos de solicitud.

Detalles del método

listMetricDefinitions(string, ListMetricDefinitionsOptions)

/**

Devuelve un iterador asincrónico para enumerar las definiciones de métricas.

Ejemplo de uso de for await la sintaxis:

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);
}

Ejemplo con 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();
}

Obtenga una lista de definiciones de métricas, dado un URI de recurso.

function listMetricDefinitions(resourceUri: string, options?: ListMetricDefinitionsOptions): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

Parámetros

resourceUri

string

Identificador URI del recurso para el que se van a obtener definiciones de métricas.

options
ListMetricDefinitionsOptions

Opciones para obtener definiciones de métricas.

Devoluciones

PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

Definiciones de métricas para un URI de recurso determinado.

listMetricNamespaces(string, ListMetricNamespacesOptions)

Devuelve un iterador asincrónico para enumerar los espacios de nombres de métricas.

Ejemplo de uso de for await la sintaxis:

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);
}

Ejemplo con 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();
}

Obtenga una lista de espacios de nombres de métricas, dado un URI de recurso.

function listMetricNamespaces(resourceUri: string, options?: ListMetricNamespacesOptions): PagedAsyncIterableIterator<MetricNamespace, MetricNamespace[], PageSettings>

Parámetros

resourceUri

string

Identificador URI del recurso para el que se van a obtener los espacios de nombres de métricas.

options
ListMetricNamespacesOptions

Opciones para obtener espacios de nombres de métricas.

Devoluciones

PagedAsyncIterableIterator<MetricNamespace, MetricNamespace[], PageSettings>

Espacios de nombres de métricas para un URI de recurso determinado.

queryResource(string, string[], MetricsQueryOptions)

Métricas de consulta, dada una URI de recurso

function queryResource(resourceUri: string, metricNames: string[], options?: MetricsQueryOptions): Promise<MetricsQueryResult>

Parámetros

resourceUri

string

Identificador URI del recurso que se va a consultar.

metricNames

string[]

Nombres de las métricas que se van a recuperar.

options
MetricsQueryOptions

Opciones para consultar métricas.

Devoluciones

Promise<MetricsQueryResult>

Respuesta que contiene métricas.