通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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

有权查询资源指标的 TokenCredential。

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>

包含指标的响应。