Puppet Task: metrics_api_azure_metrics_list

Defined in:: tasks/metrics_api_azure_metrics_list.json,
tasks/metrics_api_azure_metrics_list.rb

Overview

**Lists the metric values for a resource**.

Supports noop? false

Parameters

result_type (Optional[String[1]]) — Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details.
api_version (Optional[String[1]]) — Client Api Version.
code (Optional[String[1]]) — Error code
resource_uri (Optional[String[1]]) — The identifier of the resource.
timespan (Optional[String[1]]) — The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.
interval (Optional[String[1]]) — The interval (i.e. timegrain) of the query.
metricnames (Optional[String[1]]) — The names of the metrics (comma separated) to retrieve.
aggregation (Optional[String[1]]) — The list of aggregation types (comma separated) to retrieve.
top (Optional[String[1]]) — The maximum number of records to retrieve.Valid only if $filter is specified.Defaults to 10.
orderby (Optional[String[1]]) — The aggregation to use for sorting results and the direction of the sort.Only one order can be specified.Examples: sum asc.
filter (Optional[String[1]]) — 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 ‘*’**.
metricnamespace (Optional[String[1]]) — Metric namespace to query metric definitions for.
message (Optional[String[1]]) — Error message indicating why the operation failed.