[Monitor] Add Public Preview APIs of Metric Baseline #2049
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,358 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "title": "MonitorManagementClient", | ||
| "x-ms-code-generation-settings": { | ||
| "name": "MonitorManagementClient" | ||
| }, | ||
| "version": "2017-11-01-preview" | ||
| }, | ||
| "host": "management.azure.com", | ||
| "schemes": [ | ||
| "https" | ||
| ], | ||
| "consumes": [ | ||
| "application/json" | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "security": [ | ||
| { | ||
| "azure_auth": [ | ||
| "user_impersonation" | ||
| ] | ||
| } | ||
| ], | ||
| "securityDefinitions": { | ||
| "azure_auth": { | ||
| "type": "oauth2", | ||
| "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", | ||
| "flow": "implicit", | ||
| "description": "Azure Active Directory OAuth2 Flow", | ||
| "scopes": { | ||
| "user_impersonation": "impersonate your user account" | ||
| } | ||
| } | ||
| }, | ||
| "paths": { | ||
| "/{resourceUri}/providers/microsoft.insights/baseline/{metricName}": { | ||
| "get": { | ||
| "tags": [ | ||
| "Baseline" | ||
| ], | ||
| "operationId": "MetricBaseline_Get", | ||
| "description": "**Gets the baseline values for a specific metric**.", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/ExtendedResourceUriParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/MetricNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/TimespanParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/IntervalParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/AggregationParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/SensitivitiesParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/BaselineResultTypeParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "default": { | ||
| "description": "Error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "#/definitions/ErrorResponse" | ||
| } | ||
| }, | ||
| "200": { | ||
| "description": "Successful request to get the list of metric values.", | ||
| "schema": { | ||
| "$ref": "#/definitions/BaselineResponse" | ||
| }, | ||
| "examples": { | ||
| "application/json": { | ||
| "id": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Insights/baseline/PercentageCpu", | ||
| "type": "Microsoft.Insights/baseline", | ||
| "name": { | ||
| "value": "PercentageCpu" | ||
| }, | ||
| "properties": { | ||
| "timespan": "2017-04-14T02:20:00Z/2017-04-14T04:20:00Z", | ||
| "aggregation": "Average", | ||
| "interval": "PT1H", | ||
| "timestamps": [ | ||
| "2017-04-14T02:20:00Z", | ||
| "2017-04-14T03:20:00Z" | ||
| ], | ||
| "baseline": [ | ||
| { | ||
| "sensitivity": "Low", | ||
| "lowThresholds": [ | ||
| 30.0, | ||
| 31.1 | ||
| ], | ||
| "highThresholds": [ | ||
| 90.3453, | ||
| 91.3453 | ||
| ] | ||
| }, | ||
| { | ||
| "sensitivity": "Medium", | ||
| "lowThresholds": [ | ||
| 50.0, | ||
| 51.1 | ||
| ], | ||
| "highThresholds": [ | ||
| 70.3453, | ||
| 71.3453 | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "x-ms-examples": { | ||
| "Get Metric for data": { "$ref": "./examples/GetBaseline.json" }, | ||
| "Get Metric for metadata": { "$ref": "./examples/GetBaselineMetadata.json" } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "LocalizableString": { | ||
| "required": [ "value" ], | ||
| "properties": { | ||
| "value": { | ||
| "type": "string", | ||
| "description": "the invariant value." | ||
| }, | ||
| "localizedValue": { | ||
| "type": "string", | ||
| "description": "the locale specific value." | ||
| } | ||
| }, | ||
| "description": "The localizable string class." | ||
| }, | ||
| "BaselineMetadataValue": { | ||
| "properties": { | ||
| "name": { | ||
| "$ref": "#/definitions/LocalizableString", | ||
| "description": "the name of the metadata." | ||
| }, | ||
| "value": { | ||
| "type": "string", | ||
| "description": "the value of the metadata." | ||
| } | ||
| }, | ||
| "description": "Represents a baseline metadata value." | ||
| }, | ||
| "ErrorResponse": { | ||
| "description": "Describes the format of Error response.", | ||
| "type": "object", | ||
| "properties": { | ||
| "code": { | ||
| "description": "Error code", | ||
| "type": "string" | ||
| }, | ||
| "message": { | ||
| "description": "Error message indicating why the operation failed.", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "BaselineResponse": { | ||
| "type": "object", | ||
| "properties": { | ||
| "id": { | ||
|
Contributor
There was a problem hiding this comment. id, name and type properties should be marked as readonly: true |
||
| "type": "string", | ||
| "readOnly": true, | ||
| "description": "the metric baseline Id." | ||
| }, | ||
| "type": { | ||
| "type": "string", | ||
| "readOnly": true, | ||
| "description": "the resource type of the baseline resource." | ||
| }, | ||
| "name": { | ||
| "$ref": "#/definitions/LocalizableString", | ||
| "readOnly": true, | ||
| "description": "the name and the display name of the metric, i.e. it is localizable string." | ||
| }, | ||
| "properties": { | ||
| "x-ms-client-flatten": true, | ||
| "$ref": "#/definitions/BaselineProperties", | ||
| "description": "the properties of the baseline." | ||
| } | ||
| }, | ||
| "description": "The response to a baseline query." | ||
| }, | ||
| "BaselineProperties": { | ||
| "properties": { | ||
| "timespan": { | ||
| "type": "string", | ||
| "description": "The timespan for which the data was retrieved. Its value consists of two datatimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." | ||
| }, | ||
| "interval": { | ||
| "type": "string", | ||
| "format": "duration", | ||
| "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." | ||
| }, | ||
| "aggregation": { | ||
| "type": "string", | ||
| "description": "The aggregation type of the metric." | ||
| }, | ||
| "timestamps": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string", | ||
| "format": "date-time", | ||
| "description": "the timestamp for the baseline value in ISO 8601 format." | ||
| }, | ||
| "description": "the array of timestamps of the baselines." | ||
| }, | ||
| "baseline": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/Baseline" | ||
| }, | ||
| "description": "the baseline values for each sensitivity." | ||
| }, | ||
| "metadata": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/BaselineMetadataValue" | ||
| }, | ||
| "description": "the baseline metadata values." | ||
| } | ||
| }, | ||
| "description": "The baseline properties class." | ||
| }, | ||
| "Baseline": { | ||
| "type": "object", | ||
| "properties": { | ||
| "sensitivity": { | ||
|
Contributor
Author
There was a problem hiding this comment. You're right, changed to enum |
||
| "type": "string", | ||
| "enum": [ | ||
| "Low", | ||
| "Medium", | ||
| "High" | ||
| ], | ||
| "x-ms-enum": { | ||
| "name": "Sensitivity", | ||
| "modelAsString": false | ||
| }, | ||
| "description": "the sensitivity of the baseline." | ||
| }, | ||
| "lowThresholds": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "number", | ||
| "format": "double", | ||
| "description": "A single low threshold value." | ||
| }, | ||
| "description": "The low thresholds of the baseline." | ||
| }, | ||
| "highThresholds": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "number", | ||
| "format": "double", | ||
| "description": "A single high threshold value." | ||
| }, | ||
| "description": "The high thresholds of the baseline." | ||
| } | ||
| }, | ||
| "required": [ "sensitivity", "lowThresholds", "highThresholds" ], | ||
| "description": "The baseline values for a single sensitivity value." | ||
| } | ||
| }, | ||
| "parameters": { | ||
| "ExtendedResourceUriParameter": { | ||
| "name": "resourceUri", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The identifier of the resource. It has the following structure: subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceName}. For example: subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1", | ||
| "x-ms-parameter-location": "method", | ||
| "x-ms-skip-url-encoding": true | ||
| }, | ||
| "MetricNameParameter": { | ||
| "name": "metricName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the metric to retrieve the baseline for.", | ||
| "x-ms-parameter-location": "method" | ||
| }, | ||
| "TimespanParameter": { | ||
| "name": "timespan", | ||
| "in": "query", | ||
| "required": false, | ||
| "type": "string", | ||
| "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.", | ||
| "x-ms-parameter-location": "method" | ||
| }, | ||
| "IntervalParameter": { | ||
| "name": "interval", | ||
| "in": "query", | ||
| "required": false, | ||
| "type": "string", | ||
| "format": "duration", | ||
| "description": "The interval (i.e. timegrain) of the query.", | ||
| "x-ms-parameter-location": "method" | ||
| }, | ||
| "AggregationParameter": { | ||
| "name": "aggregation", | ||
| "in": "query", | ||
| "required": false, | ||
| "type": "string", | ||
| "description": "The aggregation type of the metric to retrieve the baseline for.", | ||
| "x-ms-parameter-location": "method" | ||
| }, | ||
| "SensitivitiesParameter": { | ||
| "name": "sensitivities", | ||
| "in": "query", | ||
| "required": false, | ||
| "type": "string", | ||
| "description": "The list of sensitivities (comma separated) to retrieve.", | ||
| "x-ms-parameter-location": "method" | ||
| }, | ||
| "BaselineResultTypeParameter": { | ||
| "name": "resultType", | ||
| "in": "query", | ||
| "type": "string", | ||
| "enum": [ | ||
| "Data", | ||
| "Metadata" | ||
| ], | ||
| "x-ms-enum": { | ||
| "name": "ResultType", | ||
| "modelAsString": false | ||
| }, | ||
| "description": "Allows retrieving only metadata of the baseline. On data request all information is retrieved.", | ||
| "x-ms-parameter-location": "method", | ||
| "required": false | ||
| }, | ||
| "ApiVersionParameter": { | ||
| "name": "api-version", | ||
| "in": "query", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "Client Api Version." | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Description should state/show examples of resourceUri
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added the description to the ResourceUriParameter parameter part.