Metrics - List At Subscription Scope Post

Service:

Monitor

API Version:

2023-10-01

Listen die Metrikdaten für ein Abonnement. Parameter können entweder für Abfrageparameter oder für den Text angegeben werden.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metrics?api-version=2023-10-01&region={region}

With optional parameters:

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metrics?api-version=2023-10-01&region={region}&timespan={timespan}&interval={interval}&metricnames={metricnames}&aggregation={aggregation}&top={top}&orderby={orderby}&$filter={$filter}&resultType={resultType}&metricnamespace={metricnamespace}&AutoAdjustTimegrain={AutoAdjustTimegrain}&ValidateDimensions={ValidateDimensions}&rollupby={rollupby}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
region	query	True	string	Die Region, in der sich die gewünschten Metriken befinden.
$filter	query		string	Die $filter wird verwendet, um den Satz der zurückgegebenen Metrikdaten zu reduzieren. Beispiel: Metrik enthält die Metadaten A, B und C. - Gibt alle Zeitreihen von C zurück, wobei A = a1 und B = b1 oder b2 $filter=A eq 'a1' und B eq 'b1' oder B eq 'b2' und C eq '*' - Ungültige Variante: $filter=A eq 'a1' und B eq 'b1' und C eq '*' oder B = 'b2' Dies ist ungültig, da der logische Oder Operator nicht zwei verschiedene Metadatennamen trennen kann. - Gibt alle Zeitreihen zurück, wobei A = a1, B = b1 und C = c1: $filter=A eq 'a1' und B eq 'b1' und C eq 'c1' - Gibt alle Zeitreihen zurück, wobei A = a1 $filter=A eq 'a1' und B eq '' und C eq ''.
aggregation	query		string	Die Liste der abzurufenden Aggregationstypen (durch Kommas getrennt). Beispiele: Durchschnitt, Minimum, Maximum
AutoAdjustTimegrain	query		boolean	Wenn der übergebene Zeitraum von dieser Metrik nicht unterstützt wird, gibt die API das Ergebnis unter Verwendung des nächstgelegenen unterstützten Zeitbereichs zurück. Wenn auf false festgelegt ist, wird ein Fehler für ungültige Timepanparameter zurückgegeben. Der Standardwert ist „false“.
interval	query		string	Das Intervall (d. h. Zeitgrain) der Abfrage im ISO 8601-Dauerformat. Die Standardwerte sind PT1M. Sonderfall für den Wert "FULL", der einen einzelnen Datenpunkt für die gesamte angeforderte Zeitspanne zurückgibt. Beispiele: PT15M, PT1H, P1D, FULL
metricnames	query		string	Die Namen der abzurufenden Metriken (kommastrennt).
metricnamespace	query		string	Metriknamespace, in dem sich die gewünschten Metriken befinden.
orderby	query		string	Die Aggregation, die zum Sortieren von Ergebnissen verwendet werden soll, und die Richtung der Sortierung. Es kann nur eine Bestellung angegeben werden. Beispiele: summe asc
resultType	query		MetricResultType	Reduziert den gesammelten Datensatz. Die zulässige Syntax hängt vom Vorgang ab. Weitere Informationen finden Sie in der Beschreibung des Vorgangs.
rollupby	query		string	Dimensionsnamen zum Rollup der Ergebnisse. Wenn Sie beispielsweise nur Metrikwerte mit einem Filter wie "City eq Seattle" oder "City eq Tacoma" anzeigen möchten, aber keine separaten Werte für jede Stadt anzeigen möchten, können Sie "RollUpBy=City" angeben, um die Ergebnisse für Seattle und Tacoma in einer Zeitreihe anzuzeigen.
timespan	query		string	Die Zeitspanne der Abfrage. Es handelt sich um eine Zeichenfolge mit dem folgenden Format "startDateTime_ISO/endDateTime_ISO".
top	query		integer int32	Die maximale Anzahl von Datensätzen, die pro Ressourcen-ID in der Anforderung abgerufen werden sollen. Nur gültig, wenn Filter angegeben ist. Der Standardwert ist 10.
ValidateDimensions	query		boolean	Wenn auf false festgelegt ist, werden ungültige Filterparameterwerte ignoriert. Wenn auf TRUE festgelegt ist, wird für ungültige Filterparameter ein Fehler zurückgegeben. Der Standardwert ist TRUE.

Anforderungstext

Name	Typ	Beschreibung
aggregation	string	Die Liste der abzurufenden Aggregationstypen (durch Kommas getrennt).
autoAdjustTimegrain	boolean	Wenn der übergebene Zeitraum von dieser Metrik nicht unterstützt wird, gibt die API das Ergebnis unter Verwendung des nächstgelegenen unterstützten Zeitbereichs zurück. Wenn auf false festgelegt ist, wird ein Fehler für ungültige Timepanparameter zurückgegeben. Der Standardwert ist „false“.
filter	string	Die $filter wird verwendet, um den Satz der zurückgegebenen Metrikdaten zu reduzieren. Beispiel: Metrik enthält die Metadaten A, B und C. - Gibt alle Zeitreihen von C zurück, wobei A = a1 und B = b1 oder b2 $filter=A eq 'a1' und B eq 'b1' oder B eq 'b2' und C eq '*' - Ungültige Variante: $filter=A eq 'a1' und B eq 'b1' und C eq '*' oder B = 'b2' Dies ist ungültig, da der logische Oder Operator nicht zwei verschiedene Metadatennamen trennen kann. - Gibt alle Zeitreihen zurück, wobei A = a1, B = b1 und C = c1: $filter=A eq 'a1' und B eq 'b1' und C eq 'c1' - Gibt alle Zeitreihen zurück, wobei A = a1 $filter=A eq 'a1' und B eq '' und C eq ''.
interval	string	Das Intervall (d. h. Zeitgrain) der Abfrage im ISO 8601-Dauerformat. Die Standardwerte sind PT1M. Sonderfall für den Wert "FULL", der einen einzelnen Datenpunkt für die gesamte angeforderte Zeitspanne zurückgibt. Beispiele: PT15M, PT1H, P1D, FULL
metricNames	string	Die Namen der abzurufenden Metriken (kommastrennt).
metricNamespace	string	Metriknamespace, in dem sich die gewünschten Metriken befinden.
orderBy	string	Die Aggregation, die zum Sortieren von Ergebnissen verwendet werden soll, und die Richtung der Sortierung. Es kann nur eine Bestellung angegeben werden. Beispiele: summe asc.
resultType	MetricResultType	Reduziert den gesammelten Datensatz. Die zulässige Syntax hängt vom Vorgang ab. Weitere Informationen finden Sie in der Beschreibung des Vorgangs.
rollUpBy	string	Dimensionsnamen zum Rollup der Ergebnisse. Wenn Sie beispielsweise nur Metrikwerte mit einem Filter wie "City eq Seattle" oder "City eq Tacoma" anzeigen möchten, aber keine separaten Werte für jede Stadt anzeigen möchten, können Sie "RollUpBy=City" angeben, um die Ergebnisse für Seattle und Tacoma in einer Zeitreihe anzuzeigen.
timespan	string	Die Zeitspanne der Abfrage. Es handelt sich um eine Zeichenfolge mit dem folgenden Format "startDateTime_ISO/endDateTime_ISO".
top	integer	Die maximale Anzahl der abzurufenden Datensätze. Nur gültig, wenn $filter angegeben ist. Der Standardwert ist 10.
validateDimensions	boolean	Wenn auf false festgelegt ist, werden ungültige Filterparameterwerte ignoriert. Wenn auf TRUE festgelegt ist, wird für ungültige Filterparameter ein Fehler zurückgegeben. Der Standardwert ist TRUE.

Antworten

Name	Typ	Beschreibung
200 OK	Response	Erfolgreiche Anforderung zum Abrufen der Liste der Metrikwerte.
Other Status Codes	ErrorContract	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Post request for subscription level metric data

Post request for subscription level metric data using body params

Post request for subscription level metric metadata

Post request for subscription level metric data

Sample Request

HTTP

POST https://management.azure.com/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics?api-version=2023-10-01&region=westus2&timespan=2021-06-08T19:00:00Z/2021-06-12T01:00:00Z&interval=PT6H&metricnames=Data Disk Max Burst IOPS&aggregation=count&top=10&orderby=count desc&$filter=LUN eq '0' and Microsoft.ResourceId eq '*'&metricnamespace=microsoft.compute/virtualmachines&AutoAdjustTimegrain=True&ValidateDimensions=False

Sample Response

Status code:

200

{
  "cost": 4679,
  "timespan": "2021-06-08T19:00:00Z/2021-06-12T01:00:00Z",
  "interval": "PT6H",
  "value": [
    {
      "id": "subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics/Data Disk Max Burst IOPS",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "Data Disk Max Burst IOPS",
        "localizedValue": "Data Disk Max Burst IOPS"
      },
      "displayDescription": "Maximum IOPS Data Disk can achieve with bursting",
      "unit": "Count",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas1/providers/Microsoft.Compute/virtualMachines/sas1-dev"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 413
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas2/providers/Microsoft.Compute/virtualMachines/sas2-vm"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 133
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas3/providers/Microsoft.Compute/virtualMachines/sas3-vm"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 78
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas4/providers/Microsoft.Compute/virtualMachines/sas4-vm"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas5/providers/Microsoft.Compute/virtualMachines/sas5-vm-asc"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        }
      ],
      "errorCode": "Success"
    }
  ],
  "namespace": "microsoft.compute/virtualmachines",
  "resourceregion": "westus2"
}

Status code:

default

{
  "error": {
    "code": "BadRequest",
    "message": "Missing required region params"
  }
}

Post request for subscription level metric data using body params

Sample Request

HTTP

POST https://management.azure.com/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics?api-version=2023-10-01&region=westus2

{
  "timespan": "2021-06-08T19:00:00Z/2021-06-12T01:00:00Z",
  "metricNames": "Data Disk Max Burst IOPS",
  "metricNamespace": "microsoft.compute/virtualmachines",
  "filter": "LUN eq '0' and Microsoft.ResourceId eq '*'",
  "rollUpBy": "LUN",
  "top": 10,
  "orderBy": "count desc",
  "aggregation": "count",
  "interval": "PT6H",
  "autoAdjustTimegrain": true,
  "validateDimensions": false
}

Sample Response

Status code:

200

{
  "cost": 4679,
  "timespan": "2021-06-08T19:00:00Z/2021-06-12T01:00:00Z",
  "interval": "PT6H",
  "value": [
    {
      "id": "subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics/Data Disk Max Burst IOPS",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "Data Disk Max Burst IOPS",
        "localizedValue": "Data Disk Max Burst IOPS"
      },
      "displayDescription": "Maximum IOPS Data Disk can achieve with bursting",
      "unit": "Count",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas1/providers/Microsoft.Compute/virtualMachines/sas1-dev"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 413
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas2/providers/Microsoft.Compute/virtualMachines/sas2-vm"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 133
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas3/providers/Microsoft.Compute/virtualMachines/sas3-vm"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 78
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas4/providers/Microsoft.Compute/virtualMachines/sas4-vm"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas5/providers/Microsoft.Compute/virtualMachines/sas5-vm-asc"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        }
      ],
      "errorCode": "Success"
    }
  ],
  "namespace": "microsoft.compute/virtualmachines",
  "resourceregion": "westus2"
}

Status code:

default

{
  "error": {
    "code": "BadRequest",
    "message": "Missing required region params"
  }
}

Post request for subscription level metric metadata

Sample Request

HTTP

POST https://management.azure.com/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics?api-version=2023-10-01&region=westus2&timespan=2021-06-10T02:23:16.129Z/2021-06-12T02:23:16.129Z&metricnames=Data Disk Max Burst IOPS&$filter=LUN eq '0'&metricnamespace=microsoft.compute/virtualmachines

Sample Response

Status code:

200

{
  "timespan": "2021-06-10T02:23:16Z/2021-06-12T02:23:16Z",
  "interval": "PT1M",
  "value": [
    {
      "id": "subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics/Data Disk Read Bytes/sec",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "Data Disk Read Bytes/sec",
        "localizedValue": "Data Disk Read Bytes/Sec"
      },
      "displayDescription": "Bytes/Sec read from a single disk during monitoring period",
      "unit": "BytesPerSecond",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "lun",
                "localizedValue": "lun"
              },
              "value": "0"
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "lun",
                "localizedValue": "lun"
              },
              "value": "1"
            }
          ]
        }
      ]
    }
  ],
  "namespace": "microsoft.compute/virtualmachines",
  "resourceregion": "westus2"
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorContract	Fehlerantwort
ErrorResponse	Fehlerantwort
LocalizableString	Die lokalisierbare Zeichenfolgenklasse.
MetadataValue	Stellt einen Metrikmetadatenwert dar.
Metric	Die Ergebnisdaten einer Abfrage.
MetricResultType	Reduziert den gesammelten Datensatz. Die zulässige Syntax hängt vom Vorgang ab. Weitere Informationen finden Sie in der Beschreibung des Vorgangs.
MetricUnit	Die Einheit der Metrik.
MetricValue	Stellt einen Metrikwert dar.
Response	Die Antwort auf eine Metrikabfrage.
SubscriptionScopeMetricsRequestBodyParameters	Abfrageparameter können auch im Text angegeben werden. Das Angeben desselben Parameters sowohl im Text als auch im Abfrageparameter führt zu einem Fehler.
TimeSeriesElement	Ein Zeitreihenergebnistyp. Der Diskriminatorwert ist in diesem Fall immer TimeSeries.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorContract

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Das Fehlerobjekt.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

LocalizableString

Die lokalisierbare Zeichenfolgenklasse.

Name	Typ	Beschreibung
localizedValue	string	Neuer Anzeigename.
value	string	Der invariante Wert.

MetadataValue

Stellt einen Metrikmetadatenwert dar.

Name	Typ	Beschreibung
name	LocalizableString	Der Name der Metadaten.
value	string	Der Wert der Metadaten.

Metric

Die Ergebnisdaten einer Abfrage.

Name	Typ	Beschreibung
displayDescription	string	Ausführliche Beschreibung dieser Metrik.
errorCode	string	"Erfolg" oder die Fehlerdetails bei Abfragefehlern für diese Metrik.
errorMessage	string	Fehlermeldung beim Abfragen dieser spezifischen Metrik aufgetreten.
id	string	Die Metrik-ID.
name	LocalizableString	Der Name und der Anzeigename der Metrik, d. h. es handelt sich um eine lokalisierbare Zeichenfolge.
timeseries	TimeSeriesElement[]	Die Zeitreihe, die zurückgegeben wird, wenn eine Datenabfrage ausgeführt wird.
type	string	Der Ressourcentyp der Metrikressource.
unit	MetricUnit	Die Einheit der Metrik.

MetricResultType

Reduziert den gesammelten Datensatz. Die zulässige Syntax hängt vom Vorgang ab. Weitere Informationen finden Sie in der Beschreibung des Vorgangs.

Name	Typ	Beschreibung
Data	string
Metadata	string

MetricUnit

Die Einheit der Metrik.

Name	Typ	Beschreibung
BitsPerSecond	string	Rate einheit der binären Ziffern pro Sekunde.
ByteSeconds	string	Einheit der Datenübertragung oder des Speichers. Dabei handelt es sich um die Größe der Daten in Bytes multipliziert mit der Zeit, die zum Übertragen oder Speichern der Daten in Sekunden benötigt wird.
Bytes	string	Einheit des Arbeitsspeichers in Bytes.
BytesPerSecond	string	Rate einheit des Arbeitsspeichers in Bytes pro Sekunde.
Cores	string	Einheit der Verarbeitungsleistung.
Count	string	Einheit der Rohmenge.
CountPerSecond	string	Rate Einheit der Rohmenge pro Sekunde.
MilliCores	string	Einheit der Verarbeitungsleistung in 1/1000 eines CPU-Kerns.
MilliSeconds	string	Zeiteinheit in 1/1000 Sekunde.
NanoCores	string	Einheit der Verarbeitungsleistung in einem Milliardstel eines CPU-Kerns.
Percent	string	Prozentuale Einheit.
Seconds	string	Zeiteinheit in Sekunden.
Unspecified	string	Keine angegebene Einheit.

MetricValue

Stellt einen Metrikwert dar.

Name	Typ	Beschreibung
average	number	Der Durchschnittswert im Zeitbereich.
count	number	Die Anzahl der Stichproben im Zeitbereich. Kann verwendet werden, um die Anzahl der Werte zu bestimmen, die zum Durchschnittswert beigetragen haben.
maximum	number	Der höchste Wert im Zeitbereich.
minimum	number	Der niedrigste Wert im Zeitbereich.
timeStamp	string	Der Zeitstempel für den Metrikwert im ISO 8601-Format.
total	number	Die Summe aller Werte im Zeitbereich.

Response

Die Antwort auf eine Metrikabfrage.

Name	Typ	Beschreibung
cost	number	Der ganzzahlige Wert, der die relativen Kosten der Abfrage darstellt.
interval	string	Das Intervall (Fenstergröße), für das die Metrikdaten im ISO 8601-Dauerformat zurückgegeben wurden, mit einem Sonderfall für den Wert "FULL", der einen einzelnen Datenpunkt für die gesamte angeforderte Zeitspanne zurückgibt (Beispiele: PT15M, PT1H, P1D, FULL). Dies kann angepasst und von dem ursprünglich angeforderten abweichen, wenn AutoAdjustTimegrain=true angegeben ist. Dies ist nicht vorhanden, wenn eine Metadatenanforderung gestellt wurde.
namespace	string	Der Namespace der abgefragten Metriken
resourceregion	string	Die Region der Ressource, die nach Metriken abgefragt wird.
timespan	string	Die Zeitspanne, für die die Daten abgerufen wurden. Sein Wert besteht aus zwei datetimes verkettet, getrennt durch "/". Dies kann in Zukunft angepasst und von dem, was ursprünglich angefordert wurde, zurückgegeben werden.
value	Metric[]	Der Wert der Auflistung.

SubscriptionScopeMetricsRequestBodyParameters

Abfrageparameter können auch im Text angegeben werden. Das Angeben desselben Parameters sowohl im Text als auch im Abfrageparameter führt zu einem Fehler.

Name	Typ	Beschreibung
aggregation	string	Die Liste der abzurufenden Aggregationstypen (durch Kommas getrennt).
autoAdjustTimegrain	boolean	Wenn der übergebene Zeitraum von dieser Metrik nicht unterstützt wird, gibt die API das Ergebnis unter Verwendung des nächstgelegenen unterstützten Zeitbereichs zurück. Wenn auf false festgelegt ist, wird ein Fehler für ungültige Timepanparameter zurückgegeben. Der Standardwert ist „false“.
filter	string	Die $filter wird verwendet, um den Satz der zurückgegebenen Metrikdaten zu reduzieren. Beispiel: Metrik enthält die Metadaten A, B und C. - Gibt alle Zeitreihen von C zurück, wobei A = a1 und B = b1 oder b2 $filter=A eq 'a1' und B eq 'b1' oder B eq 'b2' und C eq '*' - Ungültige Variante: $filter=A eq 'a1' und B eq 'b1' und C eq '*' oder B = 'b2' Dies ist ungültig, da der logische Oder Operator nicht zwei verschiedene Metadatennamen trennen kann. - Gibt alle Zeitreihen zurück, wobei A = a1, B = b1 und C = c1: $filter=A eq 'a1' und B eq 'b1' und C eq 'c1' - Gibt alle Zeitreihen zurück, wobei A = a1 $filter=A eq 'a1' und B eq '' und C eq ''.
interval	string	Das Intervall (d. h. Zeitgrain) der Abfrage im ISO 8601-Dauerformat. Die Standardwerte sind PT1M. Sonderfall für den Wert "FULL", der einen einzelnen Datenpunkt für die gesamte angeforderte Zeitspanne zurückgibt. Beispiele: PT15M, PT1H, P1D, FULL
metricNames	string	Die Namen der abzurufenden Metriken (kommastrennt).
metricNamespace	string	Metriknamespace, in dem sich die gewünschten Metriken befinden.
orderBy	string	Die Aggregation, die zum Sortieren von Ergebnissen verwendet werden soll, und die Richtung der Sortierung. Es kann nur eine Bestellung angegeben werden. Beispiele: summe asc.
resultType	MetricResultType	Reduziert den gesammelten Datensatz. Die zulässige Syntax hängt vom Vorgang ab. Weitere Informationen finden Sie in der Beschreibung des Vorgangs.
rollUpBy	string	Dimensionsnamen zum Rollup der Ergebnisse. Wenn Sie beispielsweise nur Metrikwerte mit einem Filter wie "City eq Seattle" oder "City eq Tacoma" anzeigen möchten, aber keine separaten Werte für jede Stadt anzeigen möchten, können Sie "RollUpBy=City" angeben, um die Ergebnisse für Seattle und Tacoma in einer Zeitreihe anzuzeigen.
timespan	string	Die Zeitspanne der Abfrage. Es handelt sich um eine Zeichenfolge mit dem folgenden Format "startDateTime_ISO/endDateTime_ISO".
top	integer	Die maximale Anzahl der abzurufenden Datensätze. Nur gültig, wenn $filter angegeben ist. Der Standardwert ist 10.
validateDimensions	boolean	Wenn auf false festgelegt ist, werden ungültige Filterparameterwerte ignoriert. Wenn auf TRUE festgelegt ist, wird für ungültige Filterparameter ein Fehler zurückgegeben. Der Standardwert ist TRUE.

TimeSeriesElement

Ein Zeitreihenergebnistyp. Der Diskriminatorwert ist in diesem Fall immer TimeSeries.

Name	Typ	Beschreibung
data	MetricValue[]	Ein Array von Datenpunkten, die die Metrikwerte darstellen. Dies wird nur zurückgegeben, wenn ein Ergebnistyp von Daten angegeben wird.
metadatavalues	MetadataValue[]	Die Metadatenwerte, die zurückgegeben werden, wenn $filter im Aufruf angegeben wurde.