MetricsQueryClient class
Ein Client, der Metriken abfragen, Metrikdefinitionen abrufen und Metriknamespaces abrufen kann.
Konstruktoren
| Metrics |
Erstellt einen MetricsQueryClient. |
Methoden
| list |
/** Gibt einen asynchronen iterierbaren Iterator zurück, um Metrikdefinitionen auflisten zu können. Beispiel mit
Beispiel für die Verwendung von
Dient zum Abrufen einer Liste von Metrikdefinitionen, wenn ein Ressourcen-URI angegeben ist. |
| list |
Gibt einen asynchronen iterierbaren Iterator zurück, um Metriknamespaces auflisten zu können. Beispiel mit
Beispiel für die Verwendung von
Ruft eine Liste der Metriknamespaces ab, wenn ein Ressourcen-URI angegeben ist. |
| query |
Abfragemetriken aufgrund eines Ressourcen-URI |
Details zum Konstruktor
MetricsQueryClient(TokenCredential, MetricsClientOptions)
Erstellt einen MetricsQueryClient.
new MetricsQueryClient(tokenCredential: TokenCredential, options?: MetricsClientOptions)
Parameter
- tokenCredential
- TokenCredential
Eine TokenCredential, die Über Berechtigungen zum Abfragen von Metriken für Ressourcen verfügt.
- options
- MetricsClientOptions
Optionen für den Client wie das Steuern von Anforderungs-Wiederholungen.
Details zur Methode
listMetricDefinitions(string, ListMetricDefinitionsOptions)
/**
Gibt einen asynchronen iterierbaren Iterator zurück, um Metrikdefinitionen auflisten zu können.
Beispiel mit for await Syntax:
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);
}
Beispiel für die Verwendung von 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();
}
Dient zum Abrufen einer Liste von Metrikdefinitionen, wenn ein Ressourcen-URI angegeben ist.
function listMetricDefinitions(resourceUri: string, options?: ListMetricDefinitionsOptions): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>
Parameter
- resourceUri
-
string
Der Ressourcen-URI zum Abrufen von Metrikdefinitionen.
- options
- ListMetricDefinitionsOptions
Optionen zum Abrufen von Metrikdefinitionen.
Gibt zurück
Metrikdefinitionen für einen bestimmten Ressourcen-URI.
listMetricNamespaces(string, ListMetricNamespacesOptions)
Gibt einen asynchronen iterierbaren Iterator zurück, um Metriknamespaces auflisten zu können.
Beispiel mit for await Syntax:
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);
}
Beispiel für die Verwendung von 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();
}
Ruft eine Liste der Metriknamespaces ab, wenn ein Ressourcen-URI angegeben ist.
function listMetricNamespaces(resourceUri: string, options?: ListMetricNamespacesOptions): PagedAsyncIterableIterator<MetricNamespace, MetricNamespace[], PageSettings>
Parameter
- resourceUri
-
string
Der Ressourcen-URI, für den metrische Namespaces abgerufen werden sollen.
- options
- ListMetricNamespacesOptions
Optionen zum Abrufen von Metriknamespaces.
Gibt zurück
Metrische Namespaces für einen bestimmten Ressourcen-URI.
queryResource(string, string[], MetricsQueryOptions)
Abfragemetriken aufgrund eines Ressourcen-URI
function queryResource(resourceUri: string, metricNames: string[], options?: MetricsQueryOptions): Promise<MetricsQueryResult>
Parameter
- resourceUri
-
string
Der zu abfragende Ressourcen-URI.
- metricNames
-
string[]
Die Namen der abzurufenden Metriken.
- options
- MetricsQueryOptions
Optionen zum Abfragen von Metriken.
Gibt zurück
Promise<MetricsQueryResult>
Eine Antwort, die Metriken enthält.