Metric Definitions - List

Lists the metric definitions for the resource.

GET https://management.azure.com/{resourceUri}/providers/microsoft.insights/metricDefinitions?api-version=2017-05-01-preview

URI Parameters

Name In Required Type Description
resourceUri
path True
  • string

The identifier of the resource.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
Other Status Codes

Error response describing why the operation failed.

200 OK

Successful request to get the list of metric definitions

Examples

Get Metric Definitions without filter

Sample Request

GET https://management.azure.com/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricDefinitions/providers/microsoft.insights/metricDefinitions?api-version=2017-05-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/CpuTime",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "CpuTime",
        "localizedValue": "CPU Time"
      },
      "isDimensionRequired": false,
      "unit": "Seconds",
      "primaryAggregationType": "Total",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    },
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/Requests",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "Requests",
        "localizedValue": "Requests"
      },
      "isDimensionRequired": false,
      "unit": "Count",
      "primaryAggregationType": "Total",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    },
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/BytesReceived",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "BytesReceived",
        "localizedValue": "Data In"
      },
      "isDimensionRequired": false,
      "unit": "Bytes",
      "primaryAggregationType": "Total",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    },
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/BytesSent",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "BytesSent",
        "localizedValue": "Data Out"
      },
      "isDimensionRequired": false,
      "unit": "Bytes",
      "primaryAggregationType": "Total",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    },
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/Http101",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "Http101",
        "localizedValue": "Http 101"
      },
      "isDimensionRequired": false,
      "unit": "Count",
      "primaryAggregationType": "Total",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    },
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/Http2xx",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "Http2xx",
        "localizedValue": "Http 2xx"
      },
      "isDimensionRequired": false,
      "unit": "Count",
      "primaryAggregationType": "Total",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    },
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/Http3xx",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "Http3xx",
        "localizedValue": "Http 3xx"
      },
      "isDimensionRequired": false,
      "unit": "Count",
      "primaryAggregationType": "Total",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    },
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/Http401",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "Http401",
        "localizedValue": "Http 401"
      },
      "isDimensionRequired": false,
      "unit": "Count",
      "primaryAggregationType": "Total",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    },
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/Http403",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "Http403",
        "localizedValue": "Http 403"
      },
      "isDimensionRequired": false,
      "unit": "Count",
      "primaryAggregationType": "Total",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    },
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/Http404",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "Http404",
        "localizedValue": "Http 404"
      },
      "isDimensionRequired": false,
      "unit": "Count",
      "primaryAggregationType": "Total",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    },
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/Http406",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "Http406",
        "localizedValue": "Http 406"
      },
      "isDimensionRequired": false,
      "unit": "Count",
      "primaryAggregationType": "Total",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    },
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/Http4xx",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "Http4xx",
        "localizedValue": "Http 4xx"
      },
      "isDimensionRequired": false,
      "unit": "Count",
      "primaryAggregationType": "Total",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    },
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/Http5xx",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "Http5xx",
        "localizedValue": "Http Server Errors"
      },
      "isDimensionRequired": false,
      "unit": "Count",
      "primaryAggregationType": "Total",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    },
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/MemoryWorkingSet",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "MemoryWorkingSet",
        "localizedValue": "Memory working set"
      },
      "isDimensionRequired": false,
      "unit": "Bytes",
      "primaryAggregationType": "Average",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    },
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/AverageMemoryWorkingSet",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "AverageMemoryWorkingSet",
        "localizedValue": "Average memory working set"
      },
      "isDimensionRequired": false,
      "unit": "Bytes",
      "primaryAggregationType": "Average",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    },
    {
      "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/AverageResponseTime",
      "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest",
      "name": {
        "value": "AverageResponseTime",
        "localizedValue": "Average Response Time"
      },
      "isDimensionRequired": false,
      "unit": "Seconds",
      "primaryAggregationType": "Average",
      "metricAvailabilities": [
        {
          "timeGrain": "PT1M",
          "retention": "P30D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P30D"
        }
      ],
      "dimensions": [
        {
          "value": "Instance",
          "localizedValue": "Instance"
        }
      ]
    }
  ]
}

Definitions

AggregationType

the primary aggregation type value defining how to use the values for display.

ErrorResponse
LocalizableString

the name and the display name of the metric, i.e. it is a localizable string.

MetricAvailability

Metric availability specifies the time grain (aggregation interval or frequency) and the retention period for that time grain.

MetricDefinition

Metric definition class specifies the metadata for a metric.

MetricDefinitionCollection
Unit

the unit of the metric.

the primary aggregation type value defining how to use the values for display.

Name Description
Average
Count
Maximum
Minimum
None
Total
Name Type Description
code
  • string

Error code

message
  • string

Error message indicating why the operation failed.

the name and the display name of the metric, i.e. it is a localizable string.

Name Type Description
localizedValue
  • string

the locale specific value.

value
  • string

the invariant value.

Metric availability specifies the time grain (aggregation interval or frequency) and the retention period for that time grain.

Name Type Description
retention
  • string
    duration

the retention period for the metric at the specified timegrain. Expressed as a duration 'PT1M', 'P1D', etc.

timeGrain
  • string
    duration

the time grain specifies the aggregation interval for the metric. Expressed as a duration 'PT1M', 'P1D', etc.

Metric definition class specifies the metadata for a metric.

Name Type Description
dimensions

the name and the display name of the dimension, i.e. it is a localizable string.

id
  • string

the resource identifier of the metric definition.

isDimensionRequired
  • boolean

Flag to indicate whether the dimension is required.

metricAvailabilities

the collection of what aggregation intervals are available to be queried.

name

the name and the display name of the metric, i.e. it is a localizable string.

primaryAggregationType

the primary aggregation type value defining how to use the values for display.

resourceId
  • string

the resource identifier of the resource that emitted the metric.

unit

the unit of the metric.

Name Type Description
value

the values for the metric definitions.

the unit of the metric.

Name Description
ByteSeconds
Bytes
BytesPerSecond
Count
CountPerSecond
MilliSeconds
Percent
Seconds
Unspecified