Partager via


MetricsListOptionalParams interface

Paramètres facultatifs.

Extends

Propriétés

aggregation

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

filter

Le $filter est utilisé pour réduire l’ensemble de données de métriques retournées. Exemple : La métrique contient les métadonnées A, B et C. - Retourne 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' Non valide, car l’opérateur logique ou l’opérateur 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' - Retourne toutes les séries chronologiques où A = a1 $filter=A eq 'a1' et B eq '' et C eq ''. Cas particulier : lorsque le nom de dimension ou la valeur de dimension utilise des crochets. Par exemple : quand le nom de la dimension est dim (test) 1 Au lieu d’utiliser $filter= « dim (test) 1 eq '' " , utilisez **$filter= « dim %2528test%2529 1 eq '' « ** Lorsque le nom de la dimension est faible (test) 3 et que la valeur de la dimension est dim3 (test) val Au lieu d’utiliser $filter= « dim (test) 3 eq 'dim3 (test) val' " use $filter= « dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' »

interval

Intervalle (par exemple, timegrain) de la requête.

metricnames

Noms des métriques (séparées par des virgules) à récupérer. Cas particulier : si un nom de métrique lui-même contient une virgule, utilisez %2 pour l’indiquer. Par exemple : 'Metric,Name1' doit être 'Metric%2Name1'

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 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 de la requête. Il s’agit d’une chaîne au format « startDateTime_ISO/endDateTime_ISO ».

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/désérialisation.

tracingOptions

Options utilisées lorsque le traçage est activé.

Détails de la propriété

aggregation

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

aggregation?: string

Valeur de propriété

string

filter

Le $filter est utilisé pour réduire l’ensemble de données de métriques retournées. Exemple : La métrique contient les métadonnées A, B et C. - Retourne 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' Non valide, car l’opérateur logique ou l’opérateur 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' - Retourne toutes les séries chronologiques où A = a1 $filter=A eq 'a1' et B eq '' et C eq ''. Cas particulier : lorsque le nom de dimension ou la valeur de dimension utilise des crochets. Par exemple : quand le nom de la dimension est dim (test) 1 Au lieu d’utiliser $filter= « dim (test) 1 eq '' " , utilisez **$filter= « dim %2528test%2529 1 eq '' « ** Lorsque le nom de la dimension est faible (test) 3 et que la valeur de la dimension est dim3 (test) val Au lieu d’utiliser $filter= « dim (test) 3 eq 'dim3 (test) val' " use $filter= « dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' »

filter?: string

Valeur de propriété

string

interval

Intervalle (par exemple, timegrain) de la requête.

interval?: string

Valeur de propriété

string

metricnames

Noms des métriques (séparées par des virgules) à récupérer. Cas particulier : si un nom de métrique lui-même contient une virgule, utilisez %2 pour l’indiquer. Par exemple : 'Metric,Name1' doit être 'Metric%2Name1'

metricnames?: 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 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 de la requête. Il s’agit d’une chaîne au format « startDateTime_ISO/endDateTime_ISO ».

timespan?: string

Valeur de propriété

string

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é de coreClient.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é de coreClient.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é de coreClient.OperationOptions.requestOptions

serializerOptions

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

serializerOptions?: SerializerOptions

Valeur de propriété

Hérité de coreClient.OperationOptions.serializerOptions

tracingOptions

Options utilisées lorsque le traçage est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

Hérité de coreClient.OperationOptions.tracingOptions