Metrics - List At Subscription Scope
サブスクリプションのメトリック データをListsします。
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 パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
region
|
query | True |
string |
必要なメトリックが存在するリージョン。 |
$filter
|
query |
string |
$filterは、返されるメトリック データのセットを減らすために使用されます。 |
|
aggregation
|
query |
string |
取得する集計の種類 (コンマ区切り) の一覧。 例: average、minimum、maximum |
|
Auto
|
query |
boolean |
true に設定すると、渡されたタイムスパンがこのメトリックでサポートされていない場合、API は最も近いサポートされているタイムスパンを使用して結果を返します。 false に設定すると、無効なタイムスパン パラメーターに対してエラーが返されます。 既定値は false です。 |
|
interval
|
query |
string |
ISO 8601 期間形式のクエリの間隔 (つまり、タイムグレイン)。 既定値は PT1M です。 要求された期間全体の単一データポイントを返す 'FULL' 値の特殊なケース。 例: PT15M、PT1H、P1D、FULL |
|
metricnames
|
query |
string |
取得するメトリックの名前 (コンマ区切り)。 |
|
metricnamespace
|
query |
string |
必要なメトリックが存在するメトリック名前空間。 |
|
orderby
|
query |
string |
結果の並べ替えに使用する集計と並べ替えの方向。 指定できる注文は 1 つだけです。 例: sum asc |
|
result
|
query |
収集されるデータのセットを減らします。 使用できる構文は、操作によって異なります。 詳細については、操作の説明を参照してください。 |
||
rollupby
|
query |
string |
結果をロールアップするディメンション名。 たとえば、"City eq Seattle or City eq Tacoma" のようなフィルターを使用してメトリック値のみを表示したいが、市区町村ごとに個別の値を表示したくない場合は、"RollUpBy=City" を指定して、シアトルとタコマの結果を 1 つの時系列にロールアップして表示できます。 |
|
timespan
|
query |
string |
クエリの期間。 "startDateTime_ISO/endDateTime_ISO" という形式の文字列です。 |
|
top
|
query |
integer int32 |
要求内のリソース ID ごとに取得するレコードの最大数。 filter が指定されている場合にのみ有効です。 既定値は 10 です。 |
|
Validate
|
query |
boolean |
false に設定すると、無効なフィルター パラメーター値は無視されます。 true に設定すると、無効なフィルター パラメーターに対してエラーが返されます。 既定値は true です。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
メトリック値の一覧を取得する要求が成功しました。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
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"
}
定義
名前 | 説明 |
---|---|
Error |
リソース管理エラーの追加情報。 |
Error |
エラー応答 |
Error |
エラー応答 |
Localizable |
ローカライズ可能な文字列クラス。 |
Metadata |
メトリック メタデータ値を表します。 |
Metric |
クエリの結果データ。 |
Metric |
収集されるデータのセットを減らします。 使用できる構文は、操作によって異なります。 詳細については、操作の説明を参照してください。 |
Metric |
メトリックの単位。 |
Metric |
メトリック値を表します。 |
Response |
メトリック クエリに対する応答。 |
Time |
時系列の結果の種類。 この場合、識別子の値は常に TimeSeries です。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorContract
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
エラー応答 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
LocalizableString
ローカライズ可能な文字列クラス。
名前 | 型 | 説明 |
---|---|---|
localizedValue |
string |
表示名です。 |
value |
string |
不変値。 |
MetadataValue
メトリック メタデータ値を表します。
名前 | 型 | 説明 |
---|---|---|
name |
メタデータの名前。 |
|
value |
string |
メタデータの値。 |
Metric
クエリの結果データ。
名前 | 型 | 説明 |
---|---|---|
displayDescription |
string |
このメトリックの詳細な説明。 |
errorCode |
string |
'Success' またはこのメトリックのクエリ エラーに関するエラーの詳細。 |
errorMessage |
string |
この特定のメトリックに対してクエリを実行するエラー メッセージが発生しました。 |
id |
string |
メトリック ID。 |
name |
メトリックの名前と表示名 (つまり、ローカライズ可能な文字列)。 |
|
timeseries |
データ クエリの実行時に返される時系列。 |
|
type |
string |
メトリック リソースのリソースの種類。 |
unit |
メトリックの単位。 |
MetricResultType
収集されるデータのセットを減らします。 使用できる構文は、操作によって異なります。 詳細については、操作の説明を参照してください。
名前 | 型 | 説明 |
---|---|---|
Data |
string |
|
Metadata |
string |
MetricUnit
メトリックの単位。
名前 | 型 | 説明 |
---|---|---|
BitsPerSecond |
string |
1 秒あたりの 2 進数のレート単位。 |
ByteSeconds |
string |
データ転送またはストレージの単位。 これは、データのサイズ (バイト単位) に、データの転送または格納にかかる時間を秒単位で乗算したものです。 |
Bytes |
string |
メモリの単位 (バイト単位)。 |
BytesPerSecond |
string |
1 秒あたりのメモリのレート単位 (バイト単位)。 |
Cores |
string |
処理能力の単位。 |
Count |
string |
未加工数量の単位。 |
CountPerSecond |
string |
1 秒あたりの未加工数量のレート単位。 |
MilliCores |
string |
CPU コアの 1/1000 分の 1 の処理能力の単位。 |
MilliSeconds |
string |
時間の単位 (秒の 1/1000)。 |
NanoCores |
string |
CPU コアの 10 億分の 1 の処理能力の単位。 |
Percent |
string |
パーセンテージの単位。 |
Seconds |
string |
時間の単位 (秒)。 |
Unspecified |
string |
指定された単位はありません。 |
MetricValue
メトリック値を表します。
名前 | 型 | 説明 |
---|---|---|
average |
number |
時間範囲の平均値。 |
count |
number |
時間範囲内のサンプルの数。 平均値に寄与した値の数を決定するために使用できます。 |
maximum |
number |
時間範囲内の最大値。 |
minimum |
number |
時間範囲内の最小の値。 |
timeStamp |
string |
ISO 8601 形式のメトリック値のタイムスタンプ。 |
total |
number |
時間範囲内のすべての値の合計。 |
Response
メトリック クエリに対する応答。
名前 | 型 | 説明 |
---|---|---|
cost |
number |
クエリの相対コストを表す整数値。 |
interval |
string |
メトリック データが ISO 8601 期間形式で返された間隔 (ウィンドウ サイズ) で、要求された期間全体の単一データポイントを返す 'FULL' 値の特殊なケース (例: PT15M、PT1H、P1D、FULL)。 これは、AutoAdjustTimegrain=true を指定した場合に最初に要求されたものとは異なる調整を行う場合があります。 メタデータ要求が行われた場合、これは存在しません。 |
namespace |
string |
クエリ対象のメトリックの名前空間 |
resourceregion |
string |
メトリックのクエリを実行するリソースのリージョン。 |
timespan |
string |
データが取得された期間。 その値は、'/' で区切られた 2 つの datetimes で構成されます。 これは将来調整され、最初に要求されたものから返される可能性があります。 |
value |
Metric[] |
コレクションの値。 |
TimeSeriesElement
時系列の結果の種類。 この場合、識別子の値は常に TimeSeries です。
名前 | 型 | 説明 |
---|---|---|
data |
メトリック値を表すデータ ポイントの配列。 これは、結果のデータ型が指定されている場合にのみ返されます。 |
|
metadatavalues |
$filterが呼び出しで指定された場合に返されるメタデータ値。 |