Metrics - List At Subscription Scope

Reference

Service:: Monitor

API Version:: 2023-10-01

Seznamy data metrik pro předplatné.

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

With optional parameters:

GET 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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
region	query	True	string	Oblast, ve které se nacházejí požadované metriky.
$filter	query		string	$filter se používá ke snížení sady vrácených dat metrik. Příklad: Metrika obsahuje metadata A, B a C. - Vrátit všechny časové řady C, kde A = a1 a B = b1 nebo b2 *$filter=A eq 'a1' a B eq 'b1' nebo B eq 'b2' a C eq '' - Neplatná varianta: $filter=A eq 'a1' a B eq 'b1' a C eq '' nebo B = 'b2'* To je neplatné, protože logický operátor nebo nemůže oddělit dva různé názvy metadat. - Vrátí všechny časové řady, kde A = a1, B = b1 a C = c1: $filter=A eq 'a1' a B eq 'b1' a C eq 'c1' - Vrátí všechny časové řady, kde A = a1 *$filter=A eq 'a1' a B eq '' a C eq ''*.
aggregation	query		string	Seznam typů agregace (oddělených čárkami), které se mají načíst. Příklady: průměr, minimum, maximum
AutoAdjustTimegrain	query		boolean	Pokud je nastavená hodnota true a předaný časový rozsah není touto metrikou podporován, rozhraní API vrátí výsledek s použitím nejbližšího podporovaného časového rozsahu. Pokud je nastavená hodnota false, vrátí se chyba pro neplatné parametry časového rozsahu. Výchozí hodnota je false.
interval	query		string	Interval (tj. časový interval) dotazu ve formátu doby trvání ISO 8601. Výchozí hodnota je PT1M. Zvláštní případ pro hodnotu FULL, která vrací jeden datový bod pro celé požadované časové období. Příklady: PT15M, PT1H, P1D, FULL
metricnames	query		string	Názvy metrik (oddělených čárkami), které se mají načíst.
metricnamespace	query		string	Obor názvů metrik, ve kterém se nacházejí požadované metriky.
orderby	query		string	Agregace, která se má použít pro řazení výsledků, a směr řazení. Je možné zadat pouze jednu objednávku. Příklady: součet asc
resultType	query		MetricResultType	Snižuje množství shromážděných dat. Povolená syntaxe závisí na operaci. Podrobnosti najdete v popisu operace.
rollupby	query		string	Názvy dimenzí, podle které se mají výsledky sčítá. Pokud například chcete zobrazit pouze hodnoty metrik pomocí filtru, jako je "City eq Seattle nebo City eq Tacoma", ale nechcete zobrazit samostatné hodnoty pro každé město, můžete zadat RollUpBy=City a zobrazit výsledky pro Seattle a Tacoma zahrnuté do jednoho časového období.
timespan	query		string	Časový rozsah dotazu. Jedná se o řetězec s následujícím formátem "startDateTime_ISO/endDateTime_ISO".
top	query		integer int32	Maximální počet záznamů, které se mají načíst na ID prostředku v požadavku. Platí pouze v případě, že je zadaný filtr. Výchozí hodnota je 10.
ValidateDimensions	query		boolean	Pokud je nastavená hodnota false, neplatné hodnoty parametrů filtru budou ignorovány. Pokud je nastavená hodnota true, vrátí se chyba kvůli neplatným parametrům filtru. Výchozí hodnota je true.

Odpovědi

Name	Typ	Description
200 OK	Response	Úspěšný požadavek na získání seznamu hodnot metrik.
Other Status Codes	ErrorContract	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get subscription level metric data

Get subscription level metric metadata

Get subscription level metric data

Sample Request

HTTP

GET 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"
  }
}

Get subscription level metric metadata

Sample Request

HTTP

GET 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"
}

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorContract	Odpověď na chybu
ErrorResponse	Odpověď na chybu
LocalizableString	Lokalizovatelný řetězec třídy.
MetadataValue	Představuje hodnotu metadat metriky.
Metric	Výsledná data dotazu.
MetricResultType	Zmenšuje sadu shromažďovaných dat. Povolená syntaxe závisí na operaci. Podrobnosti najdete v popisu operace.
MetricUnit	Jednotka metriky.
MetricValue	Představuje hodnotu metriky.
Response	Odpověď na dotaz na metriky.
TimeSeriesElement	Typ výsledku časové řady. V tomto případě je vždy diskriminační hodnota TimeSeries.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorContract

Odpověď na chybu

Name	Typ	Description
error	ErrorResponse	Odpověď na chybu Objekt chyby.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě
code	string	Kód chyby
details	ErrorResponse[]	Podrobnosti o chybě
message	string	Chybová zpráva
target	string	Cíl chyby.

LocalizableString

Lokalizovatelný řetězec třídy.

Name	Typ	Description
localizedValue	string	Zobrazovaný název
value	string	Invariantní hodnota.

MetadataValue

Představuje hodnotu metadat metriky.

Name	Typ	Description
name	LocalizableString	Název metadat
value	string	Hodnota metadat.

Metric

Výsledná data dotazu.

Name	Typ	Description
displayDescription	string	Podrobný popis této metriky
errorCode	string	"Úspěch" nebo podrobnosti o chybách dotazů pro tuto metriku.
errorMessage	string	Při dotazování na tuto konkrétní metriku se zobrazila chybová zpráva.
id	string	ID metriky
name	LocalizableString	Název a zobrazovaný název metriky, tj. jedná se o lokalizovatelný řetězec.
timeseries	TimeSeriesElement[]	Časová řada vrácená při provedení dotazu na data
type	string	Typ prostředku metriky.
unit	MetricUnit	Jednotka metriky.

MetricResultType

Zmenšuje sadu shromažďovaných dat. Povolená syntaxe závisí na operaci. Podrobnosti najdete v popisu operace.

Name	Typ	Description
Data	string
Metadata	string

MetricUnit

Jednotka metriky.

Name	Typ	Description
BitsPerSecond	string	Sazba jednotek binárních číslic za sekundu.
ByteSeconds	string	Jednotka přenosu dat nebo úložiště. Jedná se o velikost dat v bajtech vynásobenou dobou potřebnou k přenosu nebo uložení dat v sekundách.
Bytes	string	Jednotka paměti v bajtech.
BytesPerSecond	string	Jednotka rychlosti paměti v bajtech za sekundu.
Cores	string	Jednotka výpočetního výkonu.
Count	string	Jednotka nezpracovaného množství.
CountPerSecond	string	Sazba jednotky nezpracovaného množství za sekundu.
MilliCores	string	Jednotka výpočetního výkonu v 1/1000th jádra procesoru.
MilliSeconds	string	Jednotka času v 1/1000th ze sekundy.
NanoCores	string	Jednotka výpočetního výkonu v jedné miliardthě procesorového jádra.
Percent	string	Procentuální jednotka.
Seconds	string	Jednotka času v sekundách.
Unspecified	string	Žádná zadaná jednotka.

MetricValue

Představuje hodnotu metriky.

Name	Typ	Description
average	number	Průměrná hodnota v časovém rozsahu.
count	number	Počet vzorků v časovém rozsahu Dá se použít k určení počtu hodnot, které přispěly k průměrné hodnotě.
maximum	number	Největší hodnota v časovém rozsahu.
minimum	number	Nejmenší hodnota v časovém rozsahu.
timeStamp	string	Časové razítko hodnoty metriky ve formátu ISO 8601.
total	number	Součet všech hodnot v časovém rozsahu.

Response

Odpověď na dotaz na metriky.

Name	Typ	Description
cost	number	Celočíselná hodnota představující relativní náklady dotazu.
interval	string	Interval (velikost okna), pro který byla vrácena data metriky ve formátu doby trvání ISO 8601, se speciálním případem pro hodnotu FULL, která vrací jeden datový bod pro celý požadovaný časový rozsah (příklady: PT15M, PT1H, P1D, FULL). Pokud je zadána hodnota AutoAdjustTimegrain=true, může být tato možnost upravena a může se lišit od původního požadavku. Pokud byl proveden požadavek na metadata, není k dispozici.
namespace	string	Obor názvů dotazovaných metrik
resourceregion	string	Oblast prostředku, který se dotazuje na metriky.
timespan	string	Časový rozsah, pro který byla data načtena. Jeho hodnota se skládá ze dvou zřetězených hodnot datetime oddělených parametrem '/'. To se může v budoucnu upravit a vrátit zpět z původního požadavku.
value	Metric[]	Hodnota kolekce.

TimeSeriesElement

Typ výsledku časové řady. V tomto případě je vždy diskriminační hodnota TimeSeries.

Name	Typ	Description
data	MetricValue[]	Pole datových bodů představující hodnoty metrik. Tato hodnota se vrátí pouze v případě, že je zadán typ výsledku dat.
metadatavalues	MetadataValue[]	Hodnoty metadat vrácených při zadání $filter ve volání.

Sdílet prostřednictvím

Metrics - List At Subscription Scope

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

Get subscription level metric data

Sample Request

Sample Response

Get subscription level metric metadata

Sample Request

Sample Response

Definice

ErrorAdditionalInfo

ErrorContract

ErrorResponse

LocalizableString

MetadataValue

Metric

MetricResultType

MetricUnit

MetricValue

Response

TimeSeriesElement

Další materiály