次の方法で共有


Metrics Batch - Batch

複数のリソースのメトリック値をListsします。

POST {endpoint}/subscriptions/{subscriptionId}/metrics:getBatch?metricnamespace={metricnamespace}&metricnames={metricnames}&api-version=2023-10-01
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

URI パラメーター

名前 / 必須 説明
endpoint
path True

string

url

使用するリージョン エンドポイント (例: https://eastus.metrics.monitor.azure.com)。 リージョンは、要求されたリソースのリージョンと一致している必要があります。 グローバル リソースの場合、リージョンは "グローバル" である必要があります。

subscriptionId
path True

string

uuid

このバッチ内のリソースのサブスクリプション識別子。

api-version
query True

string

クライアント API のバージョン。

metricnames
query True

string[]

取得するメトリックの名前 (コンマ区切り)。

metricnamespace
query True

string

要求されたメトリック名を含むメトリック名前空間。

aggregation
query

string

取得する集計の種類 (コンマ区切り) の一覧。 例: average、minimum、maximum

endtime
query

string

クエリの終了時刻。 これは、'yyyy-MM-ddTHH:mm:ss.fffZ' の形式の文字列です。

filter
query

string

フィルターは、返されるメトリック データのセットを減らすために使用されます。
例:
メトリックには、メタデータ A、B、C が含まれます。
- A = a1 と B = b1 または b2 の C のすべての時系列を返します
filter=A eq 'a1' と B eq 'b1' または B eq 'b2' と C eq '*'
- 無効なバリアント:
filter=A eq 'a1' と B eq 'b1' と C eq '*' または B = 'b2'
論理または演算子は 2 つの異なるメタデータ名を区切ることができないため、これは無効です。
- A = a1、B = b1、C = c1 のすべての時系列を返します。
filter=A eq 'a1' と B eq 'b1' と C eq 'c1'
- A = a1 のすべての時系列を返します
filter=A eq 'a1' と B eq '' と C eq ''

interval
query

string

ISO 8601 期間形式のクエリの間隔 (つまり、タイムグレイン)。 既定値は PT1M です。 要求された期間全体の単一データポイントを返す 'FULL' 値の特殊なケース。 例: PT15M、PT1H、P1D、FULL

orderby
query

string

結果の並べ替えに使用する集計と並べ替えの方向。 指定できる注文は 1 つだけです。 例: sum asc

rollupby
query

string

結果をロールアップするディメンション名。 たとえば、"City eq Seattle or City eq Tacoma" のようなフィルターを使用してメトリック値のみを表示したいが、市区町村ごとに個別の値を表示したくない場合は、"RollUpBy=City" を指定して、シアトルとタコマの結果を 1 つの時系列にロールアップして表示できます。

starttime
query

string

クエリの開始時刻。 これは、'yyyy-MM-ddTHH:mm:ss.fffZ' の形式の文字列です。 endtime パラメーターを指定した場合は、このパラメーターが必要です。 starttime のみを指定した場合、endtime の既定値は現在の時刻になります。 時間間隔を指定しない場合、既定値は 1 時間です。

top
query

integer

int32

要求内のリソース ID ごとに取得するレコードの最大数。 filter が指定されている場合にのみ有効です。 既定値は 10 です。

要求本文

名前 説明
resourceids

string[]

メトリックのクエリを実行するリソース ID の一覧。

応答

名前 説明
200 OK

MetricResultsResponse

メトリック クエリへの応答。

Other Status Codes

ErrorResponse

エラー応答の形式について説明します。

ヘッダー

x-ms-error-code: string

セキュリティ

AADToken

Azure Active Directory OAuth2 認証

型: oauth2
フロー: application
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/v2.0/token

スコープ

名前 説明
https://metrics.monitor.azure.com/.default https://metrics.monitor.azure.com/.default

Query Redis Metrics summary
Query Storage Metrics

Query Redis Metrics summary

要求のサンプル

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

応答のサンプル

{
  "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"
    }
  ]
}
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

要求のサンプル

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

応答のサンプル

{
  "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"
    }
  ]
}
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}"
  }
}

定義

名前 説明
ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

LocalizableString

ローカライズ可能な文字列クラス。

MetadataValue

メトリック メタデータ値を表します。

Metric

クエリの結果データ。

MetricResultsResponse

リソースのメトリックの結果。

MetricUnit

メトリックの単位。

MetricValue

メトリック値を表します。

ResourceIdList

メトリックのクエリを実行するリソース ID のコンマ区切りの一覧。

TimeSeriesElement

時系列の結果の種類。 この場合、識別子の値は常に TimeSeries です。

Values

メトリックごとのリソースごとのメトリック データ応答のコレクション。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。

LocalizableString

ローカライズ可能な文字列クラス。

名前 説明
localizedValue

string

表示名です。

value

string

不変値。

MetadataValue

メトリック メタデータ値を表します。

名前 説明
name

LocalizableString

メタデータの名前。

value

string

メタデータの値。

Metric

クエリの結果データ。

名前 説明
displayDescription

string

このメトリックの詳細な説明。

errorCode

string

"成功" またはこのメトリックのクエリ エラーに関するエラーの詳細。

errorMessage

string

この特定のメトリックに対してクエリを実行するエラー メッセージが発生しました。

id

string

メトリック ID。

name

LocalizableString

メトリックの名前と表示名、つまりローカライズ可能な文字列です。

timeseries

TimeSeriesElement[]

データ クエリの実行時に返される時系列。

type

string

メトリック リソースのリソースの種類。

unit

MetricUnit

メトリックの単位。

MetricResultsResponse

リソースのメトリックの結果。

名前 説明
values

Values[]

メトリックごとのリソースごとのメトリック データ応答のコレクション。

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 分の 1)。

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

時間範囲内のすべての値の合計。

ResourceIdList

メトリックのクエリを実行するリソース ID のコンマ区切りの一覧。

名前 説明
resourceids

string[]

メトリックのクエリを実行するリソース ID の一覧。

TimeSeriesElement

時系列の結果の種類。 この場合、識別子の値は常に TimeSeries です。

名前 説明
data

MetricValue[]

メトリック値を表すデータ ポイントの配列。 これは、結果のデータ型が指定されている場合にのみ返されます。

metadatavalues

MetadataValue[]

呼び出しで$filterが指定された場合に返されるメタデータ値。

Values

メトリックごとのリソースごとのメトリック データ応答のコレクション。

名前 説明
endtime

string

データが取得された終了日時 (datetime 形式)。

interval

string

メトリック データが ISO 8601 期間形式で返された間隔 (ウィンドウ サイズ) 。要求された期間全体の単一データポイントを返す 'FULL' 値の特殊なケース (例: PT15M、PT1H、P1D、FULL)。 これは、AutoAdjustTimegrain=true が指定されている場合に最初に要求されたものとは異なる調整を行う場合があります。

namespace

string

クエリが実行されたメトリックの名前空間

resourceid

string

メトリックに対してクエリが実行されたリソース。

resourceregion

string

リソースのリージョンに対してメトリックのクエリが実行されました。

starttime

string

データが取得された開始時刻 (datetime 形式)。

value

Metric[]

コレクションの値。