Microsoft.Insights (stable:2018-01-01)

2024/12/11 • 1 updated methods

Metrics_List (updated)
Description :  **Lists the metric values for a resource**. This API uses the [default ARM throttling limits](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling).
Reference :  Link ¶

⚶ Changes

{
  "#id": "Metrics_List",
  "Description": {
    "new": "**Lists the metric values for a resource**. This API uses the [default ARM throttling limits](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling).",
    "old": "**Lists the metric values for a resource**."
  },
  "$parameters": [
    {
      "#name": "metricnames",
      "Description": {
        "new": "The names of the metrics (comma separated) to retrieve. Limit 20 metrics. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'**",
        "old": "The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'**"
      }
    }
  ]
}

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Insights/metrics
{
resourceUri:
{
Description: The identifier of the resource. ,
Required: True ,
}
string ,
timespan:
{
Description: The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'. ,
Required: False ,
}
string ,
interval:
{
Description: The interval (i.e. timegrain) of the query in ISO 8601 duration format. Defaults to PT1M. Special case for 'FULL' value that returns single datapoint for entire time span requested. *Examples: PT15M, PT1H, P1D, FULL* ,
Required: False ,
}
string ,
metricnames:
{
Description: The names of the metrics (comma separated) to retrieve. Limit 20 metrics. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'** ,
Required: False ,
}
string ,
aggregation:
{
Description: The list of aggregation types (comma separated) to retrieve. ,
Required: False ,
}
string ,
top:
{
Description: The maximum number of records to retrieve. Valid only if $filter is specified. Defaults to 10. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: The aggregation to use for sorting results and the direction of the sort. Only one order can be specified. Examples: sum asc. ,
Required: False ,
}
string ,
$filter:
{
Description: The **$filter** is used to reduce the set of metric data returned. Example: Metric contains metadata A, B and C. - Return all time series of C where A = a1 and B = b1 or b2 **$filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*'** - Invalid variant: **$filter=A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2'** This is invalid because the logical or operator cannot separate two different metadata names. - Return all time series where A = a1, B = b1 and C = c1: **$filter=A eq 'a1' and B eq 'b1' and C eq 'c1'** - Return all time series where A = a1 **$filter=A eq 'a1' and B eq '*' and C eq '*'**. Special case: When dimension name or dimension value uses round brackets. Eg: When dimension name is **dim (test) 1** Instead of using $filter= "dim (test) 1 eq '*' " use **$filter= "dim %2528test%2529 1 eq '*' "** When dimension name is **dim (test) 3** and dimension value is **dim3 (test) val** Instead of using $filter= "dim (test) 3 eq 'dim3 (test) val' " use **$filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' "** ,
Required: False ,
}
string ,
resultType:
{
Description: Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
metricnamespace:
{
Description: Metric namespace to query metric definitions for. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
cost:
{
Description: The integer value representing the relative cost of the query. ,
Format: int32 ,
Required: False ,
}
number ,
timespan:
{
Description: The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested. ,
Required: True ,
}
string ,
interval:
{
Description: The interval (window size) for which the metric data was returned in ISO 8601 duration format with a special case for 'FULL' value that returns single datapoint for entire time span requested (*Examples: PT15M, PT1H, P1D, FULL*). This may be adjusted and different from what was originally requested if AutoAdjustTimegrain=true is specified. This is not present if a metadata request was made. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the metrics being queried ,
Required: False ,
}
string ,
resourceregion:
{
Description: The region of the resource being queried for metrics. ,
Required: False ,
}
string ,
value:
{
Description: the value of the collection. ,
Required: True ,
}
[
{
id:
{
Description: The metric Id. ,
Required: True ,
}
string ,
type:
{
Description: The resource type of the metric resource. ,
Required: True ,
}
string ,
name:
{
Description: The name and the display name of the metric, i.e. it is localizable string. ,
Required: True ,
}
{
value:
{
Description: The invariant value. ,
Required: True ,
}
string ,
localizedValue:
{
Description: The display name. ,
Required: False ,
}
string ,
}
,
displayDescription:
{
Description: Detailed description of this metric. ,
Required: False ,
}
string ,
errorCode:
{
Description: 'Success' or the error details on query failures for this metric. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message encountered querying this specific metric. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
Percent: No description available. ,
MilliSeconds: No description available. ,
ByteSeconds: No description available. ,
Unspecified: No description available. ,
Cores: No description available. ,
MilliCores: No description available. ,
NanoCores: No description available. ,
BitsPerSecond: No description available. ,
}
,
Required: True ,
}
enum ,
timeseries:
{
Description: The time series returned when a data query is performed. ,
Required: True ,
}
[
{
metadatavalues:
{
Description: The metadata values returned if $filter was specified in the call. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata. ,
Required: False ,
}
{
value:
{
Description: The invariant value. ,
Required: True ,
}
string ,
localizedValue:
{
Description: The display name. ,
Required: False ,
}
string ,
}
,
value:
{
Description: The value of the metadata. ,
Required: False ,
}
string ,
}
,
]
,
data:
{
Description: An array of data points representing the metric values. This is only returned if a result type of data is specified. ,
Required: False ,
}
[
{
timeStamp:
{
Description: The timestamp for the metric value in ISO 8601 format. ,
Format: date-time ,
Required: True ,
}
string ,
average:
{
Description: The average value in the time range. ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: The least value in the time range. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: The greatest value in the time range. ,
Format: double ,
Required: False ,
}
number ,
total:
{
Description: The sum of all of the values in the time range. ,
Format: double ,
Required: False ,
}
number ,
count:
{
Description: The number of samples in the time range. Can be used to determine the number of values that contributed to the average value. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
]
,
}