Поделиться через

MetricsQueryClient class

Пакет:
@azure/monitor-query

Клиент, который может запрашивать метрики, получать определения метрик и получать пространства имен метрик.

Конструкторы

MetricsQueryClient(TokenCredential, MetricsClientOptions)

Создает MetricsQueryClient.

Методы

listMetricDefinitions(string, ListMetricDefinitionsOptions)

/**

Возвращает асинхронный итератор для перечисления определений метрик.

Пример использования синтаксиса for await:

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

Пример с использованием 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();
}

Получение списка определений метрик с учетом URI ресурса.
listMetricNamespaces(string, ListMetricNamespacesOptions)

Возвращает асинхронный итератор для перечисления пространств имен метрик.

Пример использования синтаксиса for await:

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

Пример с использованием 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();
}

Получите список пространств имен метрик с учетом URI ресурса.
queryResource(string, string[], MetricsQueryOptions)

Метрики запросов с учетом URI ресурса

Сведения о конструкторе

MetricsQueryClient(TokenCredential, MetricsClientOptions)

Создает MetricsQueryClient.

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

Параметры

tokenCredential
TokenCredential

ТокенCredential, имеющий права на запрос метрик на ресурсы.

options
MetricsClientOptions

Параметры для клиента, например управление повторными попытками запроса.

Сведения о методе

listMetricDefinitions(string, ListMetricDefinitionsOptions)

/**

Возвращает асинхронный итератор для перечисления определений метрик.

Пример использования синтаксиса for await:

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

Пример с использованием 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();
}

Получение списка определений метрик с учетом URI ресурса.

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

Параметры

resourceUri

string

URI ресурса для получения определений метрик.

options
ListMetricDefinitionsOptions

Параметры получения определений метрик.

Возвращаемое значение

PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

Определения метрик для заданного URI ресурса.

listMetricNamespaces(string, ListMetricNamespacesOptions)

Возвращает асинхронный итератор для перечисления пространств имен метрик.

Пример использования синтаксиса for await:

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

Пример с использованием 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();
}

Получите список пространств имен метрик с учетом URI ресурса.

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

Параметры

resourceUri

string

URI ресурса для получения пространств имен метрик.

options
ListMetricNamespacesOptions

Параметры получения пространств имен метрик.

Возвращаемое значение

PagedAsyncIterableIterator<MetricNamespace, MetricNamespace[], PageSettings>

Пространства имен метрик для заданного URI ресурса.

queryResource(string, string[], MetricsQueryOptions)

Метрики запросов с учетом URI ресурса

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

Параметры

resourceUri

string

URI ресурса для запроса.

metricNames

string[]

Имена полученных метрик.

options
MetricsQueryOptions

Параметры запроса метрик.

Возвращаемое значение

Promise<MetricsQueryResult>

Ответ, содержащий метрики.