MetricsQueryClient class
Klient, který může dotazovat metriky, získat definice metrik a získat obory názvů metrik.
Konstruktory
| Metrics |
Vytvoří MetricsQueryClient. |
Metody
| list |
/** Vrátí asynchronní iterátor pro výpis definic metrik. Příklad použití syntaxe
Příklad použití
Získejte seznam definic metrik vzhledem k identifikátoru URI prostředku. |
| list |
Vrátí asynchronní iterátor pro výpis oborů názvů metrik. Příklad použití syntaxe
Příklad použití
Získejte seznam oborů názvů metrik s identifikátorem URI prostředku. |
| query |
Dotazování na metriky s využitím identifikátoru URI prostředku |
Podrobnosti konstruktoru
MetricsQueryClient(TokenCredential, MetricsClientOptions)
Vytvoří MetricsQueryClient.
new MetricsQueryClient(tokenCredential: TokenCredential, options?: MetricsClientOptions)
Parametry
- tokenCredential
- TokenCredential
TokenCredential, který má práva k dotazování metrik na prostředky.
- options
- MetricsClientOptions
Možnosti pro klienta, jako je řízení opakování požadavků
Podrobnosti metody
listMetricDefinitions(string, ListMetricDefinitionsOptions)
/**
Vrátí asynchronní iterátor pro výpis definic metrik.
Příklad použití syntaxe 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);
}
Příklad použití 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();
}
Získejte seznam definic metrik vzhledem k identifikátoru URI prostředku.
function listMetricDefinitions(resourceUri: string, options?: ListMetricDefinitionsOptions): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>
Parametry
- resourceUri
-
string
Identifikátor URI prostředku pro získání definic metrik.
- options
- ListMetricDefinitionsOptions
Možnosti pro získání definic metrik
Návraty
Definice metrik pro daný identifikátor URI prostředku
listMetricNamespaces(string, ListMetricNamespacesOptions)
Vrátí asynchronní iterátor pro výpis oborů názvů metrik.
Příklad použití syntaxe 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);
}
Příklad použití 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();
}
Získejte seznam oborů názvů metrik s identifikátorem URI prostředku.
function listMetricNamespaces(resourceUri: string, options?: ListMetricNamespacesOptions): PagedAsyncIterableIterator<MetricNamespace, MetricNamespace[], PageSettings>
Parametry
- resourceUri
-
string
Identifikátor URI prostředku pro získání oborů názvů metrik.
- options
- ListMetricNamespacesOptions
Možnosti získání oborů názvů metrik
Návraty
Obory názvů metrik pro daný identifikátor URI prostředku
queryResource(string, string[], MetricsQueryOptions)
Dotazování na metriky s využitím identifikátoru URI prostředku
function queryResource(resourceUri: string, metricNames: string[], options?: MetricsQueryOptions): Promise<MetricsQueryResult>
Parametry
- resourceUri
-
string
Identifikátor URI prostředku, který se má dotazovat.
- metricNames
-
string[]
Názvy metrik, které se mají načíst.
- options
- MetricsQueryOptions
Možnosti dotazování metrik
Návraty
Promise<MetricsQueryResult>
Odpověď obsahující metriky.