{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Metrics API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Metrics", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Metrics Metricname Groups Groupname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/Microsoft.ADHybridHealthService/services/:serviceName/metrics/:metricName/groups/:groupName", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "The name of the service." }, { "name": "metricName", "value": "", "type": "path", "description": "The metric name" }, { "name": "groupName", "value": "", "type": "path", "description": "The group name" }, { "name": "groupKey", "value": "", "type": "query", "description": "The group key" }, { "name": "fromDate", "value": "", "type": "query", "description": "The start date." }, { "name": "toDate", "value": "", "type": "query", "description": "The end date." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API to be used with the client request." } ] }, "docs": "Gets the server related metrics for a given metric and group combination." }, { "info": { "name": "Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Metrics Metricname Groups Groupname Average", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/Microsoft.ADHybridHealthService/services/:serviceName/metrics/:metricName/groups/:groupName/average", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "The name of the service." }, { "name": "metricName", "value": "", "type": "path", "description": "The metric name" }, { "name": "groupName", "value": "", "type": "path", "description": "The group name" }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API to be used with the client request." } ] }, "docs": "Gets the average of the metric values for a given metric and group combination." }, { "info": { "name": "Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Metrics Metricname Groups Groupname Sum", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/Microsoft.ADHybridHealthService/services/:serviceName/metrics/:metricName/groups/:groupName/sum", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "The name of the service." }, { "name": "metricName", "value": "", "type": "path", "description": "The metric name" }, { "name": "groupName", "value": "", "type": "path", "description": "The group name" }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API to be used with the client request." } ] }, "docs": "Gets the sum of the metric values for a given metric and group combination." }, { "info": { "name": "Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Metricmetadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/Microsoft.ADHybridHealthService/services/:serviceName/metricmetadata", "params": [ { "name": "$filter", "value": "", "type": "query", "description": "The metric metadata property filter to apply." }, { "name": "serviceName", "value": "", "type": "path", "description": "The name of the service." }, { "name": "perfCounter", "value": "", "type": "query", "description": "Indicates if only performance counter metrics are requested." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API to be used with the client request." } ] }, "docs": "Gets the service related metrics information." }, { "info": { "name": "Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Metricmetadata Metricname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/Microsoft.ADHybridHealthService/services/:serviceName/metricmetadata/:metricName", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "The name of the service." }, { "name": "metricName", "value": "", "type": "path", "description": "The metric name" }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API to be used with the client request." } ] }, "docs": "Gets the service related metrics information." }, { "info": { "name": "Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Metricmetadata Metricname Groups Groupname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/Microsoft.ADHybridHealthService/services/:serviceName/metricmetadata/:metricName/groups/:groupName", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "The name of the service." }, { "name": "metricName", "value": "", "type": "path", "description": "The metric name" }, { "name": "groupName", "value": "", "type": "path", "description": "The group name" }, { "name": "groupKey", "value": "", "type": "query", "description": "The group key" }, { "name": "fromDate", "value": "", "type": "query", "description": "The start date." }, { "name": "toDate", "value": "", "type": "query", "description": "The end date." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API to be used with the client request." } ] }, "docs": "Gets the service related metrics for a given metric and group combination." }, { "info": { "name": "Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Servicemembers Servicememberid Metrics Metricname Groups Groupname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/Microsoft.ADHybridHealthService/services/:serviceName/servicemembers/:serviceMemberId/metrics/:metricName/groups/:groupName", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "The name of the service." }, { "name": "metricName", "value": "", "type": "path", "description": "The metric name" }, { "name": "groupName", "value": "", "type": "path", "description": "The group name" }, { "name": "serviceMemberId", "value": "", "type": "path", "description": "The server id." }, { "name": "groupKey", "value": "", "type": "query", "description": "The group key" }, { "name": "fromDate", "value": "", "type": "query", "description": "The start date." }, { "name": "toDate", "value": "", "type": "query", "description": "The end date." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API to be used with the client request." } ] }, "docs": "Gets the server related metrics for a given metric and group combination." }, { "info": { "name": "Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Servicemembers Servicememberid Metrics Metricname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/Microsoft.ADHybridHealthService/services/:serviceName/servicemembers/:serviceMemberId/metrics/:metricName", "params": [ { "name": "serviceName", "value": "", "type": "path", "description": "The name of the service." }, { "name": "serviceMemberId", "value": "", "type": "path", "description": "The service member id." }, { "name": "metricName", "value": "", "type": "path", "description": "The name of the metric." }, { "name": "api-version", "value": "", "type": "query", "description": "The version of the API to be used with the client request." } ] }, "docs": "Gets the list of connectors and run profile names." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Resourceprovider Resourcetypename Resourcename Metrics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/:resourceProvider/:resourceTypeName/:resourceName/metrics", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The azure subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The ARM resource group name" }, { "name": "resourceProvider", "value": "", "type": "path", "description": "The ARM resource provider name" }, { "name": "resourceTypeName", "value": "", "type": "path", "description": "The ARM resource type name" }, { "name": "resourceName", "value": "", "type": "path", "description": "The ARM resource name" } ] }, "docs": "**Post the metric values for a resource**." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Metrics:getbatch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/metrics:getBatch", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription identifier for the resources in this batch." }, { "name": "starttime", "value": "", "type": "query", "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.\nIf only starttime is specified, then endtime defaults to the current time.\nIf no time interval is specified, the default is 1 hour." }, { "name": "endtime", "value": "", "type": "query", "description": "The end time of the query. It is a string in the format 'yyyy-MM-ddTHH:mm:ss.fffZ'." }, { "name": "interval", "value": "", "type": "query", "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.\n*Examples: PT15M, PT1H, P1D, FULL*" }, { "name": "metricnamespace", "value": "", "type": "query", "description": "Metric namespace that contains the requested metric names." }, { "name": "metricnames", "value": "", "type": "query", "description": "The names of the metrics (comma separated) to retrieve." }, { "name": "filter", "value": "", "type": "query", "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 ‘*’**." }, { "name": "api-version", "value": "", "type": "query", "description": "Client Api Version." } ] }, "docs": "Lists the metric values for multiple resources." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Insights Metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.Insights/metrics", "params": [ { "name": "timespan", "value": "", "type": "query", "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'." }, { "name": "interval", "value": "", "type": "query", "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.\n*Examples: PT15M, PT1H, P1D, FULL*" }, { "name": "metricnames", "value": "", "type": "query", "description": "The names of the metrics (comma separated) to retrieve." }, { "name": "$filter", "value": "", "type": "query", "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 ‘*’**." }, { "name": "resultType", "value": "", "type": "query", "description": "Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details." }, { "name": "AutoAdjustTimegrain", "value": "", "type": "query", "description": "When set to true, if the timespan passed in is not supported by this metric, the API will return the result using the closest supported timespan. When set to false, an error is returned for invalid timespan parameters. Defaults to false." }, { "name": "ValidateDimensions", "value": "", "type": "query", "description": "When set to false, invalid filter parameter values will be ignored. When set to true, an error is returned for invalid filter parameters. Defaults to true." } ] }, "docs": "**Lists the metric data for a subscription**." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Insights Metrics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.Insights/metrics", "params": [ { "name": "timespan", "value": "", "type": "query", "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'." }, { "name": "interval", "value": "", "type": "query", "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.\n*Examples: PT15M, PT1H, P1D, FULL*" }, { "name": "metricnames", "value": "", "type": "query", "description": "The names of the metrics (comma separated) to retrieve." }, { "name": "$filter", "value": "", "type": "query", "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 ‘*’**." }, { "name": "resultType", "value": "", "type": "query", "description": "Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details." }, { "name": "AutoAdjustTimegrain", "value": "", "type": "query", "description": "When set to true, if the timespan passed in is not supported by this metric, the API will return the result using the closest supported timespan. When set to false, an error is returned for invalid timespan parameters. Defaults to false." }, { "name": "ValidateDimensions", "value": "", "type": "query", "description": "When set to false, invalid filter parameter values will be ignored. When set to true, an error is returned for invalid filter parameters. Defaults to true." } ] }, "docs": "**Lists the metric data for a subscription**. Parameters can be specified on either query params or the body." }, { "info": { "name": "Microsoft Azure Get Resourceuri Providers Microsoft Insights Metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:resourceUri/providers/Microsoft.Insights/metrics", "params": [ { "name": "timespan", "value": "", "type": "query", "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'." }, { "name": "interval", "value": "", "type": "query", "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.\n*Examples: PT15M, PT1H, P1D, FULL*" }, { "name": "metricnames", "value": "", "type": "query", "description": "The names of the metrics (comma separated) to retrieve." }, { "name": "$filter", "value": "", "type": "query", "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 ‘*’**." }, { "name": "resultType", "value": "", "type": "query", "description": "Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details." }, { "name": "AutoAdjustTimegrain", "value": "", "type": "query", "description": "When set to true, if the timespan passed in is not supported by this metric, the API will return the result using the closest supported timespan. When set to false, an error is returned for invalid timespan parameters. Defaults to false." }, { "name": "ValidateDimensions", "value": "", "type": "query", "description": "When set to false, invalid filter parameter values will be ignored. When set to true, an error is returned for invalid filter parameters. Defaults to true." } ] }, "docs": "**Lists the metric values for a resource**." }, { "info": { "name": "Microsoft Azure Get Resourceuri Providers Microsoft Insights Metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:resourceUri/providers/microsoft.insights/metrics", "params": [ { "name": "$filter", "value": "", "type": "query", "description": "Reduces the set of data collected.
The filter is optional. If present it must contain a list of metric names to retrieve of the form: *(name.value eq 'metricName' [or name.value eq 'metricName' or ...])*. Optionally, the filter can contain conditions for the following attributes *aggregationType*, *startTime*, *endTime*, and *timeGrain* of the form *attributeName operator value*. Where operator is one of *ne*, *eq*, *gt*, *lt*.
Several conditions can be combined with parentheses and logical operators, e.g: *and*, *or*.
Some example filter expressions are:
- $filter=(name.value eq 'RunsSucceeded') and aggregationType eq 'Total' and startTime eq 2016-02-20 and endTime eq 2016-02-21 and timeGrain eq duration'PT1M',
- $filter=(name.value eq 'RunsSucceeded') and (aggregationType eq 'Total' or aggregationType eq 'Average') and startTime eq 2016-02-20 and endTime eq 2016-02-21 and timeGrain eq duration'PT1H',
- $filter=(name.value eq 'ActionsCompleted' or name.value eq 'RunsSucceeded') and (aggregationType eq 'Total' or aggregationType eq 'Average') and startTime eq 2016-02-20 and endTime eq 2016-02-21 and timeGrain eq duration'PT1M'.

**NOTE**: When a metrics query comes in with multiple metrics, but with no aggregation types defined, the service will pick the Primary aggregation type of the first metrics to be used as the default aggregation type for all the metrics." } ] }, "docs": "Lists the metric values for a resource." } ] } ], "bundled": true }