Microsoft.Insights (stable:2024-02-01)

2025/07/16 • 1 new methods

Batch (new)
Description :  Lists the metric values for multiple resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/metrics:getBatch
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier for the resources in this batch. ,
Format: uuid ,
Required: True ,
}
string ,
starttime:
{
Description: The start time of the query. It is a string in the format 'yyyy-MM-ddTHH:mm:ss.fffZ'. If you have specified the endtime parameter, then this parameter is required. If only starttime is specified, then endtime defaults to the current time. If no time interval is specified, the default is 1 hour. ,
Required: False ,
}
string ,
endtime:
{
Description: The end time of the query. It is a string in the format 'yyyy-MM-ddTHH:mm:ss.fffZ'. ,
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 ,
metricnamespace:
{
Description: Metric namespace that contains the requested metric names. ,
Required: True ,
}
string ,
metricnames:
{
Description: The names of the metrics (comma separated) to retrieve. ,
Required: True ,
}
array ,
aggregation:
{
Description: The list of aggregation types (comma separated) to retrieve. *Examples: average, minimum, maximum* ,
Required: False ,
}
string ,
top:
{
Description: The maximum number of records to retrieve per resource ID in the request. 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 ‘*’**. ,
Required: False ,
}
string ,
rollupby:
{
Description: Dimension name(s) to rollup results by. For example if you only want to see metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't want to see separate values for each city, you can specify 'RollUpBy=City' to see the results for Seattle and Tacoma rolled up into one timeseries. ,
Required: False ,
}
string ,
batchRequest:
{
Description: Metrics batch body including the list of resource ids ,
Required: True ,
}
{
resourceids:
{
Description: The list of resource IDs to query metrics for. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
values:
{
Description: The collection of metric data responses per resource, per metric. ,
Required: False ,
}
[
{
starttime:
{
Description: The start time, in datetime format, for which the data was retrieved. ,
Required: True ,
}
string ,
endtime:
{
Description: The end time, in datetime format, for which the data was retrieved. ,
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. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the metrics been queried ,
Required: False ,
}
string ,
resourceregion:
{
Description: The region of the resource been queried for metrics. ,
Required: False ,
}
string ,
resourceid:
{
Description: The resource that has been 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: Unit of raw quantity. ,
Bytes: Unit of memory in bytes. ,
Seconds: Unit of time in seconds. ,
CountPerSecond: Rate unit of raw quantity per second. ,
BytesPerSecond: Rate unit of memory in bytes per second. ,
Percent: Percentage unit. ,
MilliSeconds: Unit of time in 1/1000th of a second. ,
ByteSeconds: Unit of data transfer or storage. It is the size of the data in bytes multiplied by the time it takes to transfer or store the data in seconds. ,
Unspecified: No specified unit. ,
Cores: Unit of processing power. ,
MilliCores: Unit of processing power in 1/1000th of a CPU core. ,
NanoCores: Unit of processing power in one billionth of a CPU core. ,
BitsPerSecond: Rate unit of binary digits per second. ,
}
,
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 ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}