MetricsQueryClient class

Paquet:
@azure/monitor-query

Client capable d’interroger des métriques, d’obtenir des définitions de métriques et d’obtenir des espaces de noms de métriques.

Constructeurs

MetricsQueryClient(TokenCredential, MetricsClientOptions)

Crée un MetricsQueryClient.

Méthodes

listMetricDefinitions(string, ListMetricDefinitionsOptions)

/**

Retourne un itérateur itérable asynchrone pour répertorier les définitions de métriques.

Exemple utilisant for await syntaxe :

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);
}

Exemple utilisant 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();
}

Obtenez la liste des définitions de métriques, en fonction d’un URI de ressource.
listMetricNamespaces(string, ListMetricNamespacesOptions)

Retourne un itérateur itérable asynchrone pour répertorier les espaces de noms de métriques.

Exemple utilisant for await syntaxe :

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);
}

Exemple utilisant 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();
}

Obtenez la liste des espaces de noms de métriques, en fonction d’un URI de ressource.
queryResource(string, string[], MetricsQueryOptions)

Interroger des métriques, en fonction d’un URI de ressource

Détails du constructeur

MetricsQueryClient(TokenCredential, MetricsClientOptions)

Crée un MetricsQueryClient.

new MetricsQueryClient(tokenCredential: TokenCredential, options?: MetricsClientOptions)

Paramètres

tokenCredential
TokenCredential

JetonCredential qui a les droits d’interroger les métriques sur les ressources.

options
MetricsClientOptions

Options pour le client, telles que le contrôle des nouvelles tentatives de demande.

Détails de la méthode

listMetricDefinitions(string, ListMetricDefinitionsOptions)

/**

Retourne un itérateur itérable asynchrone pour répertorier les définitions de métriques.

Exemple utilisant for await syntaxe :

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);
}

Exemple utilisant 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();
}

Obtenez la liste des définitions de métriques, en fonction d’un URI de ressource.

function listMetricDefinitions(resourceUri: string, options?: ListMetricDefinitionsOptions): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

Paramètres

resourceUri

string

URI de ressource pour lequel obtenir des définitions de métriques.

options
ListMetricDefinitionsOptions

Options d’obtention des définitions de métriques.

Retours

PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

Définitions de métriques pour un URI de ressource donné.

listMetricNamespaces(string, ListMetricNamespacesOptions)

Retourne un itérateur itérable asynchrone pour répertorier les espaces de noms de métriques.

Exemple utilisant for await syntaxe :

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);
}

Exemple utilisant 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();
}

Obtenez la liste des espaces de noms de métriques, en fonction d’un URI de ressource.

function listMetricNamespaces(resourceUri: string, options?: ListMetricNamespacesOptions): PagedAsyncIterableIterator<MetricNamespace, MetricNamespace[], PageSettings>

Paramètres

resourceUri

string

URI de ressource pour lequel obtenir des espaces de noms de métriques.

options
ListMetricNamespacesOptions

Options d’obtention d’espaces de noms de métriques.

Retours

PagedAsyncIterableIterator<MetricNamespace, MetricNamespace[], PageSettings>

Espaces de noms de métriques pour un URI de ressource donné.

queryResource(string, string[], MetricsQueryOptions)

Interroger des métriques, en fonction d’un URI de ressource

function queryResource(resourceUri: string, metricNames: string[], options?: MetricsQueryOptions): Promise<MetricsQueryResult>

Paramètres

resourceUri

string

URI de ressource à interroger.

metricNames

string[]

Noms des métriques à récupérer.

options
MetricsQueryOptions

Options d’interrogation des métriques.

Retours

Promise<MetricsQueryResult>

Réponse contenant des métriques.