Baselines - List

Service:: Monitor

Version d'API:: 2019-03-01

Répertorie les valeurs de référence des métriques d’une ressource.

GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metricBaselines?api-version=2019-03-01

Avec des paramètres facultatifs:

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 minLength: 1	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étrique 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'* Ceci n’est pas valide, car l’opérateur logique ou 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 spécial : lorsque le nom de dimension ou la valeur de dimension utilise des crochets arrondis. 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 im (test) 3 et la valeur de dimension sont dim3 (test) val au lieu d’utiliser $filter= « dim (test) 3 eq 'dim3 (test) val' " utiliser $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 (c.-à-d. timegrain) de la requête.
metricnames	query		string	Noms des métriques (séparées par des virgules) à récupérer. Cas spécial : si un nom de métrique lui-même a une virgule dans celle-ci, utilisez %2 pour l’indiquer. Par exemple : « Metric,Name1 » doit être « Metric%2Name1 »
metricnamespace	query		string	Espace de noms de métrique qui contient les noms de métriques demandés.
resultType	query		ResultType	Autorise la récupération uniquement des métadonnées de la base de référence. À 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 suivant « 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 pourquoi l’opération a échoué.

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

HTTP

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

Code d’état:: 200

{
  "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
AdditionalInfo	Tableau d’objets avec les propriétés « type » et « info ». Le schéma de « info » est propre au service et dépend de la chaîne « type ».
BaselineMetadata	Représente une valeur de métadonnées de référence.
BaselineSensitivity	sensibilité de la ligne de base.
Error
ErrorDetail	Décrit les détails d’une réponse d’erreur.
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	Autorise la récupération uniquement des métadonnées de la base de référence. À la demande de données, toutes les informations sont récupérées.
SingleBaseline	Valeurs de base d’une valeur de confidentialité unique.
SingleMetricBaseline	Résultats de référence d’une seule métrique.
TimeSeriesBaseline	Valeurs de référence pour une série chronologique unique.

AdditionalInfo

Objet

Tableau d’objets avec les propriétés « type » et « info ». Le schéma de « info » est propre au service et dépend de la chaîne « type ».

Nom	Type	Description
info	object	Informations supplémentaires spécifiques au type.
type	string	Type d’informations supplémentaires.

BaselineMetadata

Objet

Représente une valeur de métadonnées de référence.

Nom	Type	Description
name	string	Nom des métadonnées de base.
value	string	Valeur des métadonnées de base.

BaselineSensitivity

Énumération

sensibilité de la ligne de base.

Valeur	Description
Low
Medium
High

Error

Objet

Nom	Type	Description
additionalInfo	AdditionalInfo[]	Tableau d’objets avec les propriétés « type » et « info ». Le schéma de « info » est propre au service et dépend de la chaîne « type ».
code	string	Chaîne non localisée qui peut être utilisée pour identifier l’erreur par programmation.
details	ErrorDetail[]	Tableau d’objets d’informations de réponse d’erreur imbriqués supplémentaires, comme décrit par ce contrat.
message	string	Décrit l’erreur en détail et fournit des informations de débogage. Si Accept-Language est défini dans la requête, elle doit être localisée dans cette langue.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur).

ErrorDetail

Objet

Décrit les détails d’une réponse d’erreur.

Nom	Type	Description
additionalInfo	AdditionalInfo[]	Tableau d’objets avec les propriétés « type » et « info ». Le schéma de « info » est propre au service et dépend de la chaîne « type ».
code	string	Chaîne non localisée qui peut être utilisée pour identifier l’erreur par programmation.
message	string	Décrit l’erreur en détail et fournit des informations de débogage.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur).

ErrorResponse

Objet

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

Nom	Type	Description
error	Error

MetricBaselinesResponse

Objet

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

Objet

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

Énumération

Autorise la récupération uniquement des métadonnées de la base de référence. À la demande de données, toutes les informations sont récupérées.

Valeur	Description
Data
Metadata

SingleBaseline

Objet

Valeurs de base d’une valeur de confidentialité unique.

Nom	Type	Description
highThresholds	number[] (double)	Seuils élevés de la ligne de base.
lowThresholds	number[] (double)	Seuils bas de la ligne de base.
sensitivity	BaselineSensitivity	sensibilité de la ligne de base.

SingleMetricBaseline

Objet

Résultats de référence d’une seule métrique.

Nom	Type	Description
id	string	ID de la base de référence des métriques.
name	string	Nom de la métrique pour laquelle les lignes de base ont été récupérées.
properties.baselines	TimeSeriesBaseline[]	Base de référence pour chaque série chronologique interrogée.
properties.interval	string (duration)	Intervalle (taille de fenêtre) pour lequel les données de métrique 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ées.
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 des métriques.

TimeSeriesBaseline

Objet

Valeurs de référence pour une série chronologique unique.

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 des métadonnées de base.
timestamps	string[] (date-time)	Liste des horodatages des lignes de base.

Partager via

Baselines - List

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

Get metric baselines

Exemple de requête

Exemple de réponse

Définitions

AdditionalInfo

BaselineMetadata

BaselineSensitivity

Error

ErrorDetail

ErrorResponse

MetricBaselinesResponse

MetricSingleDimension

ResultType

SingleBaseline

SingleMetricBaseline

TimeSeriesBaseline