Partager via


Baselines - List

Listes les valeurs de base de la métrique pour une ressource.

GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metricBaselines?api-version=2019-03-01
GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metricBaselines?metricnames={metricnames}&metricnamespace={metricnamespace}&timespan={timespan}&interval={interval}&aggregation={aggregation}&sensitivities={sensitivities}&$filter={$filter}&resultType={resultType}&api-version=2019-03-01

Paramètres URI

Nom Dans Obligatoire Type Description
resourceUri
path True

string

Identificateur de la ressource.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

$filter
query

string

La $filter est utilisée 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 : lorsque 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' »

aggregation
query

string

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

interval
query

string

duration

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

metricnames
query

string

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
query

string

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

resultType
query

ResultType

Permet de récupérer uniquement les métadonnées de la base de référence. Lors de la demande de données, toutes les informations sont récupérées.

sensitivities
query

string

Liste des sensibilités (séparées par des virgules) à récupérer.

timespan
query

string

Intervalle de temps de la requête. Il s’agit d’une chaîne au format « startDateTime_ISO/endDateTime_ISO ».

Réponses

Nom Type Description
200 OK

MetricBaselinesResponse

Demande réussie pour obtenir la liste des valeurs de référence des métriques.

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

Get metric baselines

Exemple de requête

GET https://management.azure.com/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Insights/metricBaselines?timespan=2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z&interval=PT1H&aggregation=average&sensitivities=Low,Medium&api-version=2019-03-01

Exemple de réponse

{
  "value": [
    {
      "id": "/subscriptions/11aeb0ed-456b-4ca0-8df5-b9fbdc63d0d3/resourceGroups/SmartAnalytics-DEV-VM/providers/Microsoft.Compute/virtualMachines/DemoVM1/providers/microsoft.insights/metricBaselines/Percentage CPU",
      "type": "microsoft.insights/metricBaselines",
      "name": "Percentage CPU",
      "properties": {
        "interval": "PT1H",
        "timespan": "2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z",
        "namespace": "microsoft.compute/virtualmachines",
        "baselines": [
          {
            "aggregation": "average",
            "dimensions": [],
            "metadataValues": [
              {
                "name": "ErrorType",
                "value": "TooManyAnomalies"
              },
              {
                "name": "SeasonalityFrequency",
                "value": "288"
              }
            ],
            "timestamps": [
              "2019-03-12T11:00:00.000Z",
              "2019-03-12T12:00:00.000Z"
            ],
            "data": [
              {
                "sensitivity": "Low",
                "lowThresholds": [
                  30,
                  31.1
                ],
                "highThresholds": [
                  90.3453,
                  91.3453
                ]
              },
              {
                "sensitivity": "Medium",
                "lowThresholds": [
                  50,
                  51.1
                ],
                "highThresholds": [
                  70.3453,
                  71.3453
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

Définitions

Nom Description
BaselineMetadata

Représente une valeur de métadonnées de base.

BaselineSensitivity

sensibilité de la ligne de base.

ErrorResponse

Décrit le format de la réponse d’erreur.

MetricBaselinesResponse

Liste des bases de référence des métriques.

MetricSingleDimension

Nom et valeur de la dimension de métrique.

ResultType

Permet de récupérer uniquement les métadonnées de la base de référence. Lors de la demande de données, toutes les informations sont récupérées.

SingleBaseline

Valeurs de base pour une valeur de sensibilité unique.

SingleMetricBaseline

Résultats de base d’une seule métrique.

TimeSeriesBaseline

Valeurs de base d’une seule série chronologique.

BaselineMetadata

Représente une valeur de métadonnées de base.

Nom Type Description
name

string

Nom des métadonnées de base.

value

string

Valeur des métadonnées de base.

BaselineSensitivity

sensibilité de la ligne de base.

Nom Type Description
High

string

Low

string

Medium

string

ErrorResponse

Décrit le format de la réponse d’erreur.

Nom Type Description
code

string

Code d'erreur

message

string

Message d’erreur indiquant la raison de l’échec de l’opération.

MetricBaselinesResponse

Liste des bases de référence des métriques.

Nom Type Description
value

SingleMetricBaseline[]

Liste des bases de référence des métriques.

MetricSingleDimension

Nom et valeur de la dimension de métrique.

Nom Type Description
name

string

Nom de la dimension.

value

string

Valeur de la dimension.

ResultType

Permet de récupérer uniquement les métadonnées de la base de référence. Lors de la demande de données, toutes les informations sont récupérées.

Nom Type Description
Data

string

Metadata

string

SingleBaseline

Valeurs de base pour une valeur de sensibilité unique.

Nom Type Description
highThresholds

number[]

Seuils élevés de la base de référence.

lowThresholds

number[]

Seuils bas de la base de référence.

sensitivity

BaselineSensitivity

sensibilité de la ligne de base.

SingleMetricBaseline

Résultats de base d’une seule métrique.

Nom Type Description
id

string

ID de base de référence de la métrique.

name

string

Nom de la métrique pour laquelle les bases de référence ont été récupérées.

properties.baselines

TimeSeriesBaseline[]

Base de référence pour chaque série chronologique interrogée.

properties.interval

string

Intervalle (taille de fenêtre) pour lequel les données de métriques ont été retournées. Cela peut être ajusté à l’avenir et retourné à partir de ce qui a été demandé à l’origine. Cela n’est pas présent si une demande de métadonnées a été effectuée.

properties.namespace

string

Espace de noms des métriques interrogé.

properties.timespan

string

Intervalle de temps pour lequel les données ont été récupérées. Sa valeur se compose de deux datetimes concaténées, séparées par « / ». Cela peut être ajusté à l’avenir et retourné à partir de ce qui a été demandé à l’origine.

type

string

Type de ressource de la ressource de référence de métrique.

TimeSeriesBaseline

Valeurs de base d’une seule série chronologique.

Nom Type Description
aggregation

string

Type d’agrégation de la métrique.

data

SingleBaseline[]

Valeurs de base pour chaque sensibilité.

dimensions

MetricSingleDimension[]

Dimensions de cette série chronologique.

metadataValues

BaselineMetadata[]

Valeurs de métadonnées de base.

timestamps

string[]

Liste des horodatages des lignes de base.