MetricsQueryClient class
Um cliente que pode consultar métricas, obter definições de métricas e obter namespaces de métricas.
Construtores
| Metrics |
Cria um MetricsQueryClient. |
Métodos
| list |
/** Retorna um iterador iterável assíncrono para listar definições de métrica. Exemplo usando sintaxe
Exemplo usando
Obtenha uma lista de definições de métrica, dado um URI de recurso. |
| list |
Retorna um iterador iterável assíncrono para listar namespaces de métrica. Exemplo usando sintaxe
Exemplo usando
Obtenha uma lista de namespaces métricos, dado um URI de recurso. |
| query |
Métricas de consulta, dado 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 as tentativas de solicitação.
Detalhes de Método
listMetricDefinitions(string, ListMetricDefinitionsOptions)
/**
Retorna um iterador iterável assíncrono para listar definições de métrica.
Exemplo usando sintaxe 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);
}
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, dado um URI de recurso.
function listMetricDefinitions(resourceUri: string, options?: ListMetricDefinitionsOptions): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>
Parâmetros
- resourceUri
-
string
O URI do recurso para obter definições de métrica.
- options
- ListMetricDefinitionsOptions
Opções para obter definições métricas.
Devoluções
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 sintaxe 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);
}
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 métricos, dado um URI de recurso.
function listMetricNamespaces(resourceUri: string, options?: ListMetricNamespacesOptions): PagedAsyncIterableIterator<MetricNamespace, MetricNamespace[], PageSettings>
Parâmetros
- resourceUri
-
string
O URI do recurso para obter namespaces de métrica.
- options
- ListMetricNamespacesOptions
Opções para obter namespaces métricos.
Devoluções
Namespaces de métrica para um determinado URI de recurso.
queryResource(string, string[], MetricsQueryOptions)
Métricas de consulta, dado 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.
Devoluções
Promise<MetricsQueryResult>
Uma resposta contendo métricas.