Microsoft.Insights (stable:2019-03-01)

2024/12/05 • 1 updated methods

Baselines_List (updated)
Description :  **Lists the metric baseline values for a resource**.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Baselines_List",
  "$parameters": [
    {
      "#name": "metricnamespace",
      "Description": {
        "new": "Metric namespace that contains the requested metric names.",
        "old": "Metric namespace to query metric definitions for."
      }
    }
  ],
  "$responses": {
    "default": {
      "$properties": {
        "@added_7014d7ce1b9346edbf5421dbd4f54196": {
          "#name": "error",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "code",
              "Description": "Unlocalized string which can be used to programmatically identify the error.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "message",
              "Description": "Describes the error in detail and provides debugging information. If Accept-Language is set in the request, it must be localized to that language.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "target",
              "Description": "The target of the particular error (for example, the name of the property in error).",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "details",
              "Description": "An array of additional nested error response info objects, as described by this contract.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "Describes details of an error response.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "Unlocalized string which can be used to programmatically identify the error.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "Describes the error in detail and provides debugging information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The target of the particular error (for example, the name of the property in error).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "additionalInfo",
                    "Description": "An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "type",
                          "Description": "The type of additional information.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "info",
                          "Description": "The additional information specific to the type.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#name": "additionalInfo",
              "Description": "An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The type of additional information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional information specific to the type.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          ]
        },
        "@removed_b5f44426990a4b8db5be54d19eeb68f2": {
          "#name": "code",
          "Description": "Error code",
          "Required": false,
          "Type": "string"
        },
        "@removed_e6ccf65be9384066a1aa047eb9fd7a11": {
          "#name": "message",
          "Description": "Error message indicating why the operation failed.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Insights/metricBaselines
{
resourceUri:
{
Description: The identifier of the resource. ,
Required: True ,
}
string ,
metricnames:
{
Description: 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'** ,
Required: False ,
}
string ,
metricnamespace:
{
Description: Metric namespace that contains the requested metric names. ,
Required: False ,
}
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. ,
Format: duration ,
Required: False ,
}
string ,
aggregation:
{
Description: The list of aggregation types (comma separated) to retrieve. ,
Required: False ,
}
string ,
sensitivities:
{
Description: The list of sensitivities (comma separated) to retrieve. ,
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: Allows retrieving only metadata of the baseline. On data request all information is retrieved. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. If Accept-Language is set in the request, it must be localized to that language. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of metric baselines. ,
Required: False ,
}
[
{
id:
{
Description: The metric baseline Id. ,
Required: True ,
}
string ,
type:
{
Description: The resource type of the metric baseline resource. ,
Required: True ,
}
string ,
name:
{
Description: The name of the metric for which the baselines were retrieved. ,
Required: True ,
}
string ,
properties:
{
Description: The metric baseline properties of the metric. ,
Required: True ,
}
{
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. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made. ,
Format: duration ,
Required: True ,
}
string ,
namespace:
{
Description: The namespace of the metrics been queried. ,
Required: False ,
}
string ,
baselines:
{
Description: The baseline for each time series that was queried. ,
Required: True ,
}
[
{
aggregation:
{
Description: The aggregation type of the metric. ,
Required: True ,
}
string ,
dimensions:
{
Description: The dimensions of this time series. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dimension. ,
Required: True ,
}
string ,
value:
{
Description: Value of the dimension. ,
Required: True ,
}
string ,
}
,
]
,
timestamps:
{
Description: The list of timestamps of the baselines. ,
Required: True ,
}
[
string ,
]
,
data:
{
Description: The baseline values for each sensitivity. ,
Required: True ,
}
[
{
sensitivity:
{
Description: the sensitivity of the baseline. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: True ,
}
enum ,
lowThresholds:
{
Description: The low thresholds of the baseline. ,
Required: True ,
}
[
number ,
]
,
highThresholds:
{
Description: The high thresholds of the baseline. ,
Required: True ,
}
[
number ,
]
,
}
,
]
,
metadataValues:
{
Description: The baseline metadata values. ,
Required: False ,
}
[
{
name:
{
Description: Name of the baseline metadata. ,
Required: True ,
}
string ,
value:
{
Description: Value of the baseline metadata. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
}