MetricsQueryClient class
Um cliente que pode consultar métricas, obter definições de métrica e obter namespaces de métrica.
Construtores
| Metrics |
Cria um MetricsQueryClient. |
Métodos
| list |
/** Retorna um iterador iterável assíncrono para listar definições de métrica. Exemplo usando
Exemplo usando
Obtenha uma lista de definições de métrica, considerando um URI de recurso. |
| list |
Retorna um iterador iterável assíncrono para listar namespaces de métrica. Exemplo usando
Exemplo usando
Obtenha uma lista de namespaces de métrica, dado um URI de recurso. |
| query |
Métricas de consulta, considerando um URI de recurso |
Detalhes do construtor
MetricsQueryClient(TokenCredential, MetricsClientOptions)
Cria um MetricsQueryClient.
new MetricsQueryClient(tokenCredential: TokenCredential, options?: MetricsClientOptions)
Parâmetros
- tokenCredential
- TokenCredential
Um TokenCredential que tem direitos para consultar métricas em recursos.
- options
- MetricsClientOptions
Opções para o cliente, como controlar novas tentativas de solicitação.
Detalhes do método
listMetricDefinitions(string, ListMetricDefinitionsOptions)
/**
Retorna um iterador iterável assíncrono para listar definições de métrica.
Exemplo usando for await sintaxe:
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);
}
Exemplo usando 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();
}
Obtenha uma lista de definições de métrica, considerando um URI de recurso.
function listMetricDefinitions(resourceUri: string, options?: ListMetricDefinitionsOptions): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>
Parâmetros
- resourceUri
-
string
O URI do recurso para o qual obter definições de métrica.
- options
- ListMetricDefinitionsOptions
Opções para obter definições de métrica.
Retornos
Definições de métrica para um determinado URI de recurso.
listMetricNamespaces(string, ListMetricNamespacesOptions)
Retorna um iterador iterável assíncrono para listar namespaces de métrica.
Exemplo usando for await sintaxe:
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);
}
Exemplo usando 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();
}
Obtenha uma lista de namespaces de métrica, dado um URI de recurso.
function listMetricNamespaces(resourceUri: string, options?: ListMetricNamespacesOptions): PagedAsyncIterableIterator<MetricNamespace, MetricNamespace[], PageSettings>
Parâmetros
- resourceUri
-
string
O URI do recurso para o qual obter namespaces de métrica.
- options
- ListMetricNamespacesOptions
Opções para obter namespaces de métrica.
Retornos
Namespaces de métrica para um determinado URI de recurso.
queryResource(string, string[], MetricsQueryOptions)
Métricas de consulta, considerando um URI de recurso
function queryResource(resourceUri: string, metricNames: string[], options?: MetricsQueryOptions): Promise<MetricsQueryResult>
Parâmetros
- resourceUri
-
string
O URI do recurso a ser consultado.
- metricNames
-
string[]
Os nomes das métricas a serem recuperadas.
- options
- MetricsQueryOptions
Opções para consultar métricas.
Retornos
Promise<MetricsQueryResult>
Uma resposta que contém métricas.