Metrics - List At Subscription Scope
Listák az előfizetés metrikaadatait.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metrics?api-version=2023-10-01®ion={region}
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metrics?api-version=2023-10-01®ion={region}×pan={timespan}&interval={interval}&metricnames={metricnames}&aggregation={aggregation}&top={top}&orderby={orderby}&$filter={$filter}&resultType={resultType}&metricnamespace={metricnamespace}&AutoAdjustTimegrain={AutoAdjustTimegrain}&ValidateDimensions={ValidateDimensions}&rollupby={rollupby}
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
A cél-előfizetés azonosítója. |
api-version
|
query | True |
string |
A művelethez használandó API-verzió. |
region
|
query | True |
string |
Az a régió, ahol a kívánt metrikák találhatók. |
$filter
|
query |
string |
A $filter a visszaadott metrikaadatok halmazának csökkentésére szolgál. |
|
aggregation
|
query |
string |
A lekérendő összesítési típusok listája (vesszővel elválasztva). Példák: átlag, minimum, maximum |
|
Auto
|
query |
boolean |
Igaz értékre állítva, ha a metrika nem támogatja a megadott időtartományt, az API a legközelebbi támogatott időtartomány használatával adja vissza az eredményt. Ha false (hamis) értékre van állítva, a rendszer hibát ad vissza érvénytelen időtartomány-paraméterek esetén. Az alapértelmezett érték a hamis. |
|
interval
|
query |
string |
A lekérdezés időköze (azaz időgrain) ISO 8601-es időtartamformátumban. Alapértelmezés szerint PT1M. A "FULL" érték speciális esete, amely egyetlen adatpontot ad vissza a kért teljes időtartamra vonatkozóan. Példák: PT15M, PT1H, P1D, FULL |
|
metricnames
|
query |
string |
A lekérendő metrikák neve (vesszővel elválasztva). |
|
metricnamespace
|
query |
string |
A metrikanévtér, ahol a metrikákat el szeretné helyezni. |
|
orderby
|
query |
string |
Az eredmények rendezéséhez használandó összesítés és a rendezés iránya. Csak egy rendelés adható meg. Példák: sum asc |
|
result
|
query |
Csökkenti az összegyűjtött adatok halmazát. Az engedélyezett szintaxis a művelettől függ. A részletekért tekintse meg a művelet leírását. |
||
rollupby
|
query |
string |
Dimenziónév(ek) az eredmények összesítéséhez. Ha például csak a "City eq Seattle vagy City eq Tacoma" szűrővel szeretné megtekinteni a metrikaértékeket, de nem szeretne külön értékeket megjeleníteni az egyes városokhoz, megadhatja a "RollUpBy=City" értéket, hogy a Seattle és a Tacoma eredményeit egy időzóna szerint összesítse. |
|
timespan
|
query |
string |
A lekérdezés időtartománya. Ez egy "startDateTime_ISO/endDateTime_ISO" formátumú sztring. |
|
top
|
query |
integer int32 |
A kérelemben erőforrás-azonosítónként lekérhető rekordok maximális száma. Csak akkor érvényes, ha a szűrő meg van adva. Alapértelmezés szerint 10. |
|
Validate
|
query |
boolean |
Ha false (hamis) értékre van állítva, a rendszer figyelmen kívül hagyja az érvénytelen szűrőparaméter-értékeket. Ha igaz értékre van állítva, a rendszer hibát ad vissza érvénytelen szűrőparaméterek esetén. Alapértelmezés szerint igaz. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Sikeres kérés a metrikaértékek listájának lekéréséhez. |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
Get subscription level metric data |
Get subscription level metric metadata |
Get subscription level metric data
Sample Request
GET https://management.azure.com/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics?api-version=2023-10-01®ion=westus2×pan=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
{
"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"
}
{
"error": {
"code": "BadRequest",
"message": "Missing required region params"
}
}
Get subscription level metric metadata
Sample Request
GET https://management.azure.com/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics?api-version=2023-10-01®ion=westus2×pan=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
{
"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"
}
Definíciók
Name | Description |
---|---|
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
Hibaválasz |
Error |
Hibaválasz |
Localizable |
A honosítható sztringosztály. |
Metadata |
A metrika metaadatainak értékét jelöli. |
Metric |
Egy lekérdezés eredményadatai. |
Metric |
Csökkenti az összegyűjtött adatok készletét. Az engedélyezett szintaxis a művelettől függ. A részletekért tekintse meg a művelet leírását. |
Metric |
A metrika egysége. |
Metric |
Metrikaértéket jelöl. |
Response |
A metrikák lekérdezésére adott válasz. |
Time |
Idősor eredménytípusa. Ebben az esetben a diszkriminatív érték mindig TimeSeries. |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
Name | Típus | Description |
---|---|---|
info |
object |
A további információk. |
type |
string |
A további információtípus. |
ErrorContract
Hibaválasz
Name | Típus | Description |
---|---|---|
error |
Hibaválasz |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
additionalInfo |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hibacél. |
LocalizableString
A honosítható sztringosztály.
Name | Típus | Description |
---|---|---|
localizedValue |
string |
A megjelenítendő név. |
value |
string |
Az invariáns érték. |
MetadataValue
A metrika metaadatainak értékét jelöli.
Name | Típus | Description |
---|---|---|
name |
A metaadatok neve. |
|
value |
string |
A metaadatok értéke. |
Metric
Egy lekérdezés eredményadatai.
Name | Típus | Description |
---|---|---|
displayDescription |
string |
A metrika részletes leírása. |
errorCode |
string |
A "Sikeres" vagy a metrika lekérdezési hibáival kapcsolatos hiba részletei. |
errorMessage |
string |
Hibaüzenet jelenik meg az adott metrika lekérdezése közben. |
id |
string |
A metrika azonosítója. |
name |
A metrika neve és megjelenítendő neve, azaz honosítható sztring. |
|
timeseries |
Az adat lekérdezés végrehajtásakor visszaadott idősor. |
|
type |
string |
A metrikaerőforrás erőforrástípusa. |
unit |
A metrika egysége. |
MetricResultType
Csökkenti az összegyűjtött adatok készletét. Az engedélyezett szintaxis a művelettől függ. A részletekért tekintse meg a művelet leírását.
Name | Típus | Description |
---|---|---|
Data |
string |
|
Metadata |
string |
MetricUnit
A metrika egysége.
Name | Típus | Description |
---|---|---|
BitsPerSecond |
string |
Bináris számjegyek másodpercenkénti sebességegysége. |
ByteSeconds |
string |
Az adatátvitel vagy a tárolás egysége. Ez az adatok bájtban megadott mérete, megszorozva az adatok átviteléhez vagy tárolásához szükséges idővel másodpercek alatt. |
Bytes |
string |
Memóriaegység bájtban. |
BytesPerSecond |
string |
Memóriaegység másodpercenként bájtban kifejezve. |
Cores |
string |
A feldolgozási teljesítmény mértékegysége. |
Count |
string |
A nyers mennyiség mértékegysége. |
CountPerSecond |
string |
A másodpercenkénti nyers mennyiség rátaegysége. |
MilliCores |
string |
A processzormag 1/1000-edik feldolgozási teljesítményegysége. |
MilliSeconds |
string |
Időegység egy másodperc 1/1000-ében. |
NanoCores |
string |
A processzormag egymilliárd része feldolgozási teljesítményegysége. |
Percent |
string |
Százalékegység. |
Seconds |
string |
Időegység másodpercben. |
Unspecified |
string |
Nincs megadva egység. |
MetricValue
Metrikaértéket jelöl.
Name | Típus | Description |
---|---|---|
average |
number |
Az időtartomány átlagos értéke. |
count |
number |
Az időtartományban lévő minták száma. Az átlagértékhez hozzájáruló értékek számának meghatározására használható. |
maximum |
number |
Az időtartomány legnagyobb értéke. |
minimum |
number |
Az időtartomány legkisebb értéke. |
timeStamp |
string |
A metrikaérték időbélyege ISO 8601 formátumban. |
total |
number |
Az időtartomány összes értékének összege. |
Response
A metrikák lekérdezésére adott válasz.
Name | Típus | Description |
---|---|---|
cost |
number |
A lekérdezés relatív költségét jelölő egész szám. |
interval |
string |
Az az intervallum (ablakméret), amelyre vonatkozóan a metrikaadatokat ISO 8601-es időtartamformátumban adták vissza, a "FULL" érték speciális esetével, amely egyetlen adatpontot ad vissza a kért teljes időtartamhoz (például: PT15M, PT1H, P1D, FULL). Ez módosítható, és eltérhet az eredetileg kérttől, ha az AutoAdjustTimegrain=true érték meg van adva. Ez nem jelenik meg, ha metaadat-kérés történt. |
namespace |
string |
A lekérdezett metrikák névtere |
resourceregion |
string |
A lekérdezett erőforrás régiója a metrikákhoz. |
timespan |
string |
Az az időtartomány, amelyre vonatkozóan lekérte az adatokat. Értéke két összefűzött datetime-ból áll, amelyeket "/" választ el egymástól. Ez a jövőben módosítható, és visszatérhet az eredetileg kérttől. |
value |
Metric[] |
A gyűjtemény értéke. |
TimeSeriesElement
Idősor eredménytípusa. Ebben az esetben a diszkriminatív érték mindig TimeSeries.
Name | Típus | Description |
---|---|---|
data |
A metrikaértékeket képviselő adatpontok tömbje. Ezt csak akkor adja vissza a rendszer, ha meg van adva eredmény típusú adat. |
|
metadatavalues |
A visszaadott metaadat-értékek, ha $filter meg lett adva a hívásban. |