MetricsQueryOptions interface

Options utilisées lors de l’interrogation des métriques.

Extends

Propriétés

aggregations

Liste des types d’agrégation (séparés par des virgules) à récupérer.

filter

La $filter est utilisée pour réduire l’ensemble de données de métrique retournées.
Exemple:
La métrique contient les métadonnées A, B et C.
- Retourner toutes les séries chronologiques de C où A = a1 et B = b1 ou b2
$filter=A eq 'a1' et B eq 'b1' ou B eq 'b2' et C eq '*'
- Variante non valide :
$filter=A eq 'a1' et B eq 'b1' et C eq '*' ou B = 'b2'
Cela n’est pas valide, car l’opérateur ou logique ne peut pas séparer deux noms de métadonnées différents.
- Retourne toutes les séries chronologiques où A = a1, B = b1 et C = c1 :
$filter=A eq 'a1' et B eq 'b1' et C eq 'c1'
- Retourner toutes les séries chronologiques où A = a1
$filter=A eq 'a1' et B eq '' et C eq ''.

granularity

Intervalle (c.-à-d. timegrain) de la requête. Durées helper contient des alias pour certaines durées de ISO8601 courantes. Il s’agit d’une valeur de durée ISO8601 au format P[n]Y[n]M[n]DT[n]H[n]M[n]S où P est l’indicateur de durée (pour la période) placé au début de la représentation de durée. Y est l’indicateur d’année qui suit la valeur du nombre d’années. M est l’indicateur de mois qui suit la valeur du nombre de mois. W est l’indicateur de semaine qui suit la valeur du nombre de semaines. D est l’indicateur de jour qui suit la valeur du nombre de jours. T est l’indicateur de temps qui précède les composants de temps de la représentation. H est l’indicateur d’heure qui suit la valeur du nombre d’heures. M est l’indicateur de minute qui suit la valeur du nombre de minutes. S est le deuxième indicateur qui suit la valeur pour le nombre de secondes.

metricNamespace

Espace de noms de métrique pour lequel interroger les définitions de métriques.

orderBy

Agrégation à utiliser pour trier les résultats et la direction du tri. Une seule commande peut être spécifiée. Exemples : sum asc.

resultType

Réduit le jeu de données collectées. La syntaxe autorisée dépend de l’opération. Pour plus d’informations, consultez la description de l’opération.

timespan

Intervalle de temps englobant pour les métriques.

top

Nombre maximal d’enregistrements à récupérer. Valide uniquement si $filter est spécifié. La valeur par défaut est 10.

Propriétés héritées

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.

requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.

serializerOptions

Options permettant de remplacer le comportement de sérialisation/de désérialisation.

tracingOptions

Options utilisées lorsque le suivi est activé.

Détails de la propriété

aggregations

Liste des types d’agrégation (séparés par des virgules) à récupérer.

aggregations?: AggregationType[]

Valeur de propriété

filter

La $filter est utilisée pour réduire l’ensemble de données de métrique retournées.
Exemple:
La métrique contient les métadonnées A, B et C.
- Retourner toutes les séries chronologiques de C où A = a1 et B = b1 ou b2
$filter=A eq 'a1' et B eq 'b1' ou B eq 'b2' et C eq '*'
- Variante non valide :
$filter=A eq 'a1' et B eq 'b1' et C eq '*' ou B = 'b2'
Cela n’est pas valide, car l’opérateur ou logique ne peut pas séparer deux noms de métadonnées différents.
- Retourne toutes les séries chronologiques où A = a1, B = b1 et C = c1 :
$filter=A eq 'a1' et B eq 'b1' et C eq 'c1'
- Retourner toutes les séries chronologiques où A = a1
$filter=A eq 'a1' et B eq '' et C eq ''.

filter?: string

Valeur de propriété

string

granularity

Intervalle (c.-à-d. timegrain) de la requête. Durées helper contient des alias pour certaines durées de ISO8601 courantes. Il s’agit d’une valeur de durée ISO8601 au format P[n]Y[n]M[n]DT[n]H[n]M[n]S où P est l’indicateur de durée (pour la période) placé au début de la représentation de durée. Y est l’indicateur d’année qui suit la valeur du nombre d’années. M est l’indicateur de mois qui suit la valeur du nombre de mois. W est l’indicateur de semaine qui suit la valeur du nombre de semaines. D est l’indicateur de jour qui suit la valeur du nombre de jours. T est l’indicateur de temps qui précède les composants de temps de la représentation. H est l’indicateur d’heure qui suit la valeur du nombre d’heures. M est l’indicateur de minute qui suit la valeur du nombre de minutes. S est le deuxième indicateur qui suit la valeur pour le nombre de secondes.

granularity?: string

Valeur de propriété

string

metricNamespace

Espace de noms de métrique pour lequel interroger les définitions de métriques.

metricNamespace?: string

Valeur de propriété

string

orderBy

Agrégation à utiliser pour trier les résultats et la direction du tri. Une seule commande peut être spécifiée. Exemples : sum asc.

orderBy?: string

Valeur de propriété

string

resultType

Réduit le jeu de données collectées. La syntaxe autorisée dépend de l’opération. Pour plus d’informations, consultez la description de l’opération.

resultType?: ResultType

Valeur de propriété

timespan

Intervalle de temps englobant pour les métriques.

timespan?: QueryTimeInterval

Valeur de propriété

top

Nombre maximal d’enregistrements à récupérer. Valide uniquement si $filter est spécifié. La valeur par défaut est 10.

top?: number

Valeur de propriété

number

Détails de la propriété héritée

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

héritée de OperationOptions.abortSignal

onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.

onResponse?: RawResponseCallback

Valeur de propriété

héritée de OperationOptions.onResponse

requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.

requestOptions?: OperationRequestOptions

Valeur de propriété

héritée de OperationOptions.requestOptions

serializerOptions

Options permettant de remplacer le comportement de sérialisation/de désérialisation.

serializerOptions?: SerializerOptions

Valeur de propriété

héritée de OperationOptions.serializerOptions

tracingOptions

Options utilisées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

héritée de OperationOptions.tracingOptions