Metrics Batch - Batch

Référence

Service:: Monitor

Version d'API:: 2023-10-01

Listes les valeurs de métrique pour plusieurs ressources.

POST {endpoint}/subscriptions/{subscriptionId}/metrics:getBatch?metricnamespace={metricnamespace}&metricnames={metricnames}&api-version=2023-10-01

Avec des paramètres facultatifs:

POST {endpoint}/subscriptions/{subscriptionId}/metrics:getBatch?starttime={starttime}&endtime={endtime}&interval={interval}&metricnamespace={metricnamespace}&metricnames={metricnames}&aggregation={aggregation}&top={top}&orderby={orderby}&filter={filter}&rollupby={rollupby}&api-version=2023-10-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string url	Point de terminaison régional à utiliser, par exemple https://eastus.metrics.monitor.azure.com. La région doit correspondre à la région des ressources demandées. Pour les ressources globales, la région doit être « globale ».
subscriptionId	path	True	string uuid	Identificateur d’abonnement pour les ressources de ce lot.
api-version	query	True	string	Version de l’API cliente.
metricnames	query	True	string[]	Noms des métriques (séparés par des virgules) à récupérer.
metricnamespace	query	True	string	Espace de noms de métrique qui contient les noms de métriques demandés.
aggregation	query		string	Liste des types d’agrégation (séparés par des virgules) à récupérer. Exemples : moyenne, minimale, maximale
endtime	query		string	Heure de fin de la requête. Il s’agit d’une chaîne au format « aaaa-MM-ddTHH :mm :ss.fffZ ».
filter	query		string	Le filtre 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' and B eq 'b1' and C eq '' or 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' and B eq 'b1' and C eq 'c1' - Retourner toutes les séries chronologiques où A = a1 *filter=A eq 'a1' et B eq '' et C eq ''*.
interval	query		string	Intervalle (c’est-à-dire timegrain) de la requête au format de durée ISO 8601. La valeur par défaut est PT1M. Cas particulier pour la valeur « FULL » qui retourne un seul point de données pour l’ensemble de la durée demandée. Exemples : PT15M, PT1H, P1D, FULL
orderby	query		string	Agrégation à utiliser pour trier les résultats et la direction du tri. Une seule commande peut être spécifiée. Exemples : sum asc
rollupby	query		string	Nom(s) de dimension pour les résultats cumulatifs par. Par exemple, si vous souhaitez uniquement afficher des valeurs de métriques avec un filtre comme « City eq Seattle ou City eq Tacoma », mais que vous ne souhaitez pas voir des valeurs distinctes pour chaque ville, vous pouvez spécifier « RollUpBy=City » pour afficher les résultats pour Seattle et Tacoma regroupés en une seule série chronologique.
starttime	query		string	Heure de début de la requête. Il s’agit d’une chaîne au format « aaaa-MM-ddTHH :mm :ss.fffZ ». Si vous avez spécifié le paramètre endtime, ce paramètre est obligatoire. Si seule l’heure de début est spécifiée, l’heure de fin correspond par défaut à l’heure actuelle. Si aucun intervalle de temps n’est spécifié, la valeur par défaut est de 1 heure.
top	query		integer int32	Nombre maximal d’enregistrements à récupérer par ID de ressource dans la demande. Valide uniquement si le filtre est spécifié. La valeur par défaut est 10.

Corps de la demande

Nom	Type	Description
resourceids	string[]	Liste des ID de ressource à rechercher pour les métriques.

Réponses

Nom	Type	Description
200 OK	MetricResultsResponse	Réponse à une requête de métriques.
Other Status Codes	ErrorResponse	Décrit le format de réponse d’erreur. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

MetricResultsResponse

Réponse à une requête de métriques.

Other Status Codes

ErrorResponse

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

En-têtes

x-ms-error-code: string

Sécurité

AADToken

Authentification OAuth2 Azure Active Directory

Type: oauth2
Flux: application
URL du jeton: https://login.microsoftonline.com/common/oauth2/v2.0/token

Étendues

Nom	Description
https://metrics.monitor.azure.com/.default	https://metrics.monitor.azure.com/.default

Exemples

Query Redis Metrics summary

Query Storage Metrics

Query Redis Metrics summary

Exemple de requête

HTTP

POST {endpoint}/subscriptions/12345678-abcd-1234-abcd-123456789abc/metrics:getBatch?starttime=2023-11-07T14:00:00.000Z&endtime=2023-11-07T18:00:00.000Z&interval=FULL&metricnamespace=Microsoft.Cache/Redis&metricnames=cacheWrite&aggregation=average&top=10&orderby=average desc&filter=ShardId eq '0'&rollupby=ShardId&api-version=2023-10-01

{
  "resourceids": [
    "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis5",
    "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis3",
    "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis2"
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "values": [
    {
      "starttime": "2023-11-07T14:00:00Z",
      "endtime": "2023-11-07T18:00:00Z",
      "interval": "PT4H",
      "value": [
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis5/providers/Microsoft.Insights/metrics/cacheWrite",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "cacheWrite",
            "localizedValue": "Cache Write"
          },
          "displayDescription": "The amount of data written to the cache in bytes per second. For more details, see https://aka.ms/redis/metrics.",
          "unit": "BytesPerSecond",
          "timeseries": [
            {
              "metadatavalues": [],
              "data": [
                {
                  "timeStamp": "2023-11-07T14:00:00Z",
                  "average": 35513.760416666664
                }
              ]
            }
          ],
          "errorCode": "Success"
        }
      ],
      "namespace": "microsoft.cache/redis",
      "resourceregion": "westus2",
      "resourceid": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis5"
    },
    {
      "starttime": "2023-11-07T14:00:00Z",
      "endtime": "2023-11-07T18:00:00Z",
      "interval": "PT4H",
      "value": [
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis3/providers/Microsoft.Insights/metrics/cacheWrite",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "cacheWrite",
            "localizedValue": "Cache Write"
          },
          "displayDescription": "The amount of data written to the cache in bytes per second. For more details, see https://aka.ms/redis/metrics.",
          "unit": "BytesPerSecond",
          "timeseries": [
            {
              "metadatavalues": [],
              "data": [
                {
                  "timeStamp": "2023-11-07T14:00:00Z",
                  "average": 7135.0625
                }
              ]
            }
          ],
          "errorCode": "Success"
        }
      ],
      "namespace": "microsoft.cache/redis",
      "resourceregion": "westus2",
      "resourceid": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis3"
    },
    {
      "starttime": "2023-11-07T14:00:00Z",
      "endtime": "2023-11-07T18:00:00Z",
      "interval": "PT4H",
      "value": [
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis2/providers/Microsoft.Insights/metrics/cacheWrite",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "cacheWrite",
            "localizedValue": "Cache Write"
          },
          "displayDescription": "The amount of data written to the cache in bytes per second. For more details, see https://aka.ms/redis/metrics.",
          "unit": "BytesPerSecond",
          "timeseries": [
            {
              "metadatavalues": [],
              "data": [
                {
                  "timeStamp": "2023-11-07T14:00:00Z",
                  "average": 6723.489583333333
                }
              ]
            }
          ],
          "errorCode": "Success"
        }
      ],
      "namespace": "microsoft.cache/redis",
      "resourceregion": "westus2",
      "resourceid": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis2"
    }
  ]
}

Code d’état:: default

x-ms-error-code: BadRequest

{
  "error": {
    "additionalInfo": [
      {
        "type": "string",
        "info": "TraceId=dd033ebf1e260d815f4bccad149bbc15"
      },
      {
        "type": "string",
        "info": "ExceptionType=Microsoft.Online.Metrics.MetricsMP.Utilities.RPRequestFormatException"
      }
    ],
    "code": "BadRequest",
    "message": "Detected invalid time range parameters for API version 2023-10-01. Please use only starttime and endtime to specify a time range."
  }
}

Query Storage Metrics

Exemple de requête

HTTP

POST {endpoint}/subscriptions/12345678-abcd-1234-abcd-123456789abc/metrics:getBatch?starttime=2023-02-01T20:00:00.123Z&endtime=2023-02-01T23:00:00.345Z&interval=PT15M&metricnamespace=Microsoft.Storage/storageAccounts&metricnames=Ingress,Egress&aggregation=average,minimum,maximum&top=10&orderby=average desc&filter=ApiName eq 'GetBlob' or ApiName eq 'GetBlobServiceProperties' and Authentication eq '*'&api-version=2023-10-01

{
  "resourceids": [
    "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1",
    "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2"
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "values": [
    {
      "starttime": "2023-02-01T20:00:00.123Z",
      "endtime": "2023-02-01T23:00:00.345Z",
      "interval": "PT15M",
      "value": [
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1/providers/Microsoft.Insights/metrics/Ingress",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "Ingress",
            "localizedValue": "Ingress"
          },
          "displayDescription": "The amount of ingress data, in bytes. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.",
          "unit": "Bytes",
          "timeseries": [
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlob"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "SAS"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z",
                  "average": 438.0735294117647,
                  "minimum": 437,
                  "maximum": 583
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z",
                  "average": 437.54477611940297,
                  "minimum": 437,
                  "maximum": 583
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z",
                  "average": 438.0735294117647,
                  "minimum": 437,
                  "maximum": 583
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z",
                  "average": 437.54477611940297,
                  "minimum": 437,
                  "maximum": 583
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z",
                  "average": 438.0735294117647,
                  "minimum": 437,
                  "maximum": 583
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z",
                  "average": 437.542750929368,
                  "minimum": 437,
                  "maximum": 583
                }
              ]
            },
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlobServiceProperties"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "AccountKey"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 342,
                  "minimum": 342,
                  "maximum": 342
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z"
                }
              ]
            }
          ],
          "errorCode": "Success"
        },
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1/providers/Microsoft.Insights/metrics/Egress",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "Egress",
            "localizedValue": "Egress"
          },
          "displayDescription": "The amount of egress data. This number includes egress to external client from Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress.",
          "unit": "Bytes",
          "timeseries": [
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlobServiceProperties"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "AccountKey"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 796,
                  "minimum": 796,
                  "maximum": 796
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z"
                }
              ]
            },
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlob"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "SAS"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z",
                  "average": 365.83088235294116,
                  "minimum": 361,
                  "maximum": 1018
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z",
                  "average": 363.4514925373134,
                  "minimum": 361,
                  "maximum": 1018
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z",
                  "average": 365.83088235294116,
                  "minimum": 361,
                  "maximum": 1018
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z",
                  "average": 363.4514925373134,
                  "minimum": 361,
                  "maximum": 1018
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z",
                  "average": 365.83088235294116,
                  "minimum": 361,
                  "maximum": 1018
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z",
                  "average": 363.4423791821561,
                  "minimum": 361,
                  "maximum": 1018
                }
              ]
            }
          ],
          "errorCode": "Success"
        }
      ],
      "namespace": "microsoft.storage/storageaccounts",
      "resourceregion": "eastus",
      "resourceid": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1"
    },
    {
      "starttime": "2023-02-01T20:00:00.123Z",
      "endtime": "2023-02-01T23:00:00.345Z",
      "interval": "PT15M",
      "value": [
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2/providers/Microsoft.Insights/metrics/Ingress",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "Ingress",
            "localizedValue": "Ingress"
          },
          "displayDescription": "The amount of ingress data, in bytes. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.",
          "unit": "Bytes",
          "timeseries": [
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlobServiceProperties"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "AccountKey"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 330,
                  "minimum": 330,
                  "maximum": 330
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z"
                }
              ]
            }
          ],
          "errorCode": "Success"
        },
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2/providers/Microsoft.Insights/metrics/Egress",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "Egress",
            "localizedValue": "Egress"
          },
          "displayDescription": "The amount of egress data. This number includes egress to external client from Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress.",
          "unit": "Bytes",
          "timeseries": [
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlobServiceProperties"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "AccountKey"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 880,
                  "minimum": 880,
                  "maximum": 880
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z"
                }
              ]
            }
          ],
          "errorCode": "Success"
        }
      ],
      "namespace": "microsoft.storage/storageaccounts",
      "resourceregion": "eastus",
      "resourceid": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2"
    }
  ]
}

Code d’état:: default

x-ms-error-code: BadRequest

{
  "error": {
    "additionalInfo": [
      {
        "type": "string",
        "info": "TraceId={00000000-0000-0000-0000-000000000000}"
      },
      {
        "type": "string",
        "info": "ExceptionType=Microsoft.Online.Metrics.MetricsMP.Utilities.RPRequestFormatException"
      }
    ],
    "code": "BadRequest",
    "message": "Query endTime: 06/06/2021 00:00:00 is out of the Max metrics retention period: 93.00:00:00, traceId: {00000000-0000-0000-0000-000000000000}"
  }
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
LocalizableString	Classe de chaîne localisable.
MetadataValue	Représente une valeur de métadonnées de métrique.
Metric	Données de résultat d’une requête.
MetricResultsResponse	Résultat des métriques pour une ressource.
MetricUnit	Unité de la métrique.
MetricValue	Représente une valeur de métrique.
ResourceIdList	Liste séparée par des virgules d’ID de ressource pour métriques.
TimeSeriesElement	Type de résultat de série chronologique. La valeur du discriminateur est toujours TimeSeries dans ce cas.
Values	Collection de réponses de données de métrique par ressource, par métrique.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

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

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

LocalizableString

Classe de chaîne localisable.

Nom	Type	Description
localizedValue	string	Le nom d’affichage.
value	string	Valeur invariante.

MetadataValue

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

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

Metric

Données de résultat d’une requête.

Nom	Type	Description
displayDescription	string	Description détaillée de cette métrique.
errorCode	string	« Réussite » ou les détails de l’erreur sur les échecs de requête pour cette métrique.
errorMessage	string	Un message d’erreur s’est produit lors de l’interrogation de cette métrique spécifique.
id	string	ID de métrique.
name	LocalizableString	Nom et nom d’affichage de la métrique, c’est-à-dire qu’il s’agit d’une chaîne localisable.
timeseries	TimeSeriesElement[]	Série chronologique retournée lors de l’exécution d’une requête de données.
type	string	Type de ressource de la ressource de métrique.
unit	MetricUnit	Unité de la métrique.

MetricResultsResponse

Résultat des métriques pour une ressource.

Nom	Type	Description
values	Values[]	Collection de réponses de données de métrique par ressource, par métrique.

MetricUnit

Unité de la métrique.

Nom	Type	Description
BitsPerSecond	string	Unité de taux de chiffres binaires par seconde.
ByteSeconds	string	Unité de transfert ou de stockage de données. Il s’agit de la taille des données en octets multipliée par le temps nécessaire pour transférer ou stocker les données en secondes.
Bytes	string	Unité de mémoire en octets.
BytesPerSecond	string	Unité de mémoire de débit en octets par seconde.
Cores	string	Unité de puissance de traitement.
Count	string	Unité de quantité brute.
CountPerSecond	string	Unité de débit de la quantité brute par seconde.
MilliCores	string	Unité de puissance de traitement dans 1/1000e d’un cœur de processeur.
MilliSeconds	string	Unité de temps en 1/1000e de seconde.
NanoCores	string	Unité de puissance de traitement dans un milliardième d’un cœur de processeur.
Percent	string	Unité de pourcentage.
Seconds	string	Unité de temps en secondes.
Unspecified	string	Aucune unité spécifiée.

MetricValue

Représente une valeur de métrique.

Nom	Type	Description
average	number	Valeur moyenne dans l’intervalle de temps.
count	number	Nombre d’exemples dans l’intervalle de temps. Peut être utilisé pour déterminer le nombre de valeurs qui ont contribué à la valeur moyenne.
maximum	number	Valeur la plus élevée dans l’intervalle de temps.
minimum	number	Valeur minimale dans l’intervalle de temps.
timeStamp	string	Horodatage de la valeur de métrique au format ISO 8601.
total	number	Somme de toutes les valeurs de l’intervalle de temps.

ResourceIdList

Liste séparée par des virgules d’ID de ressource pour métriques.

Nom	Type	Description
resourceids	string[]	Liste des ID de ressource à rechercher pour les métriques.

TimeSeriesElement

Type de résultat de série chronologique. La valeur du discriminateur est toujours TimeSeries dans ce cas.

Nom	Type	Description
data	MetricValue[]	Tableau de points de données représentant les valeurs de métrique. Cette valeur n’est retournée que si un type de résultat de données est spécifié.
metadatavalues	MetadataValue[]	Valeurs de métadonnées retournées si $filter a été spécifié dans l’appel.

Values

Collection de réponses de données de métrique par ressource, par métrique.

Nom	Type	Description
endtime	string	Heure de fin, au format datetime, pour laquelle les données ont été récupérées.
interval	string	Intervalle (taille de fenêtre) pour lequel les données de métrique ont été retournées au format de durée ISO 8601 avec un cas particulier pour la valeur « FULL » qui retourne un point de données unique pour l’ensemble de la durée demandée (exemples : PT15M, PT1H, P1D, FULL). Cela peut être ajusté et différent de ce qui a été demandé à l’origine si AutoAdjustTimegrain=true est spécifié.
namespace	string	Espace de noms des métriques interrogé
resourceid	string	Ressource qui a été interrogée pour les métriques.
resourceregion	string	La région de la ressource a été interrogée pour les métriques.
starttime	string	Heure de début, au format datetime, pour laquelle les données ont été récupérées.
value	Metric[]	Valeur de la collection.

Partager via

Metrics Batch - Batch

Paramètres URI

Corps de la demande

Réponses

Sécurité

AADToken

Étendues

Exemples

Query Redis Metrics summary

Exemple de requête

Exemple de réponse

Query Storage Metrics

Exemple de requête

Exemple de réponse

Définitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LocalizableString

MetadataValue

Metric

MetricResultsResponse

MetricUnit

MetricValue

ResourceIdList

TimeSeriesElement

Values

Ressources supplémentaires