|
| 1 | +{ |
| 2 | + "swagger": "2.0", |
| 3 | + "info": { |
| 4 | + "version": "2023-11-01", |
| 5 | + "title": "Common Monitoring types" |
| 6 | + }, |
| 7 | + "paths": {}, |
| 8 | + "definitions": { |
| 9 | + "LocalizableString": { |
| 10 | + "type": "object", |
| 11 | + "required": [ |
| 12 | + "value" |
| 13 | + ], |
| 14 | + "properties": { |
| 15 | + "value": { |
| 16 | + "type": "string", |
| 17 | + "description": "The invariant value." |
| 18 | + }, |
| 19 | + "localizedValue": { |
| 20 | + "type": "string", |
| 21 | + "description": "The display name." |
| 22 | + } |
| 23 | + }, |
| 24 | + "description": "The localizable string class." |
| 25 | + }, |
| 26 | + "MetricValue": { |
| 27 | + "type": "object", |
| 28 | + "required": [ |
| 29 | + "timeStamp" |
| 30 | + ], |
| 31 | + "properties": { |
| 32 | + "timeStamp": { |
| 33 | + "type": "string", |
| 34 | + "format": "date-time", |
| 35 | + "description": "The timestamp for the metric value in ISO 8601 format." |
| 36 | + }, |
| 37 | + "average": { |
| 38 | + "type": "number", |
| 39 | + "format": "double", |
| 40 | + "description": "The average value in the time range." |
| 41 | + }, |
| 42 | + "minimum": { |
| 43 | + "type": "number", |
| 44 | + "format": "double", |
| 45 | + "description": "The least value in the time range." |
| 46 | + }, |
| 47 | + "maximum": { |
| 48 | + "type": "number", |
| 49 | + "format": "double", |
| 50 | + "description": "The greatest value in the time range." |
| 51 | + }, |
| 52 | + "total": { |
| 53 | + "type": "number", |
| 54 | + "format": "double", |
| 55 | + "description": "The sum of all of the values in the time range." |
| 56 | + }, |
| 57 | + "count": { |
| 58 | + "type": "number", |
| 59 | + "format": "double", |
| 60 | + "description": "The number of samples in the time range. Can be used to determine the number of values that contributed to the average value." |
| 61 | + } |
| 62 | + }, |
| 63 | + "description": "Represents a metric value." |
| 64 | + }, |
| 65 | + "MetadataValue": { |
| 66 | + "type": "object", |
| 67 | + "properties": { |
| 68 | + "name": { |
| 69 | + "$ref": "#/definitions/LocalizableString", |
| 70 | + "description": "The name of the metadata." |
| 71 | + }, |
| 72 | + "value": { |
| 73 | + "type": "string", |
| 74 | + "description": "The value of the metadata." |
| 75 | + } |
| 76 | + }, |
| 77 | + "description": "Represents a metric metadata value." |
| 78 | + }, |
| 79 | + "Unit": { |
| 80 | + "type": "string", |
| 81 | + "description": "The unit of the metric.", |
| 82 | + "enum": [ |
| 83 | + "Count", |
| 84 | + "Bytes", |
| 85 | + "Seconds", |
| 86 | + "CountPerSecond", |
| 87 | + "BytesPerSecond", |
| 88 | + "Percent", |
| 89 | + "MilliSeconds", |
| 90 | + "ByteSeconds", |
| 91 | + "Unspecified", |
| 92 | + "Cores", |
| 93 | + "MilliCores", |
| 94 | + "NanoCores", |
| 95 | + "BitsPerSecond" |
| 96 | + ], |
| 97 | + "x-ms-enum": { |
| 98 | + "name": "MetricUnit", |
| 99 | + "modelAsString": true |
| 100 | + } |
| 101 | + }, |
| 102 | + "TimeSeriesElement": { |
| 103 | + "type": "object", |
| 104 | + "properties": { |
| 105 | + "metadatavalues": { |
| 106 | + "type": "array", |
| 107 | + "items": { |
| 108 | + "$ref": "#/definitions/MetadataValue" |
| 109 | + }, |
| 110 | + "x-ms-identifiers": [ |
| 111 | + "name" |
| 112 | + ], |
| 113 | + "description": "the metadata values returned if $filter was specified in the call." |
| 114 | + }, |
| 115 | + "data": { |
| 116 | + "type": "array", |
| 117 | + "items": { |
| 118 | + "$ref": "#/definitions/MetricValue" |
| 119 | + }, |
| 120 | + "x-ms-identifiers": [ |
| 121 | + "timeStamp" |
| 122 | + ], |
| 123 | + "description": "An array of data points representing the metric values. This is only returned if a result type of data is specified." |
| 124 | + } |
| 125 | + }, |
| 126 | + "description": "A time series result type. The discriminator value is always TimeSeries in this case." |
| 127 | + }, |
| 128 | + "Metric": { |
| 129 | + "type": "object", |
| 130 | + "properties": { |
| 131 | + "id": { |
| 132 | + "type": "string", |
| 133 | + "description": "the metric Id." |
| 134 | + }, |
| 135 | + "type": { |
| 136 | + "type": "string", |
| 137 | + "description": "the resource type of the metric resource." |
| 138 | + }, |
| 139 | + "name": { |
| 140 | + "$ref": "#/definitions/LocalizableString", |
| 141 | + "description": "the name and the display name of the metric, i.e. it is localizable string." |
| 142 | + }, |
| 143 | + "displayDescription": { |
| 144 | + "type": "string", |
| 145 | + "description": "Detailed description of this metric." |
| 146 | + }, |
| 147 | + "errorCode": { |
| 148 | + "type": "string", |
| 149 | + "description": "'Success' or the error details on query failures for this metric." |
| 150 | + }, |
| 151 | + "errorMessage": { |
| 152 | + "type": "string", |
| 153 | + "description": "Error message encountered querying this specific metric." |
| 154 | + }, |
| 155 | + "unit": { |
| 156 | + "$ref": "#/definitions/Unit", |
| 157 | + "description": "The unit of the metric." |
| 158 | + }, |
| 159 | + "timeseries": { |
| 160 | + "type": "array", |
| 161 | + "items": { |
| 162 | + "$ref": "#/definitions/TimeSeriesElement" |
| 163 | + }, |
| 164 | + "x-ms-identifiers": [], |
| 165 | + "description": "the time series returned when a data query is performed." |
| 166 | + } |
| 167 | + }, |
| 168 | + "required": [ |
| 169 | + "id", |
| 170 | + "type", |
| 171 | + "name", |
| 172 | + "unit", |
| 173 | + "timeseries" |
| 174 | + ], |
| 175 | + "description": "The result data of a query." |
| 176 | + } |
| 177 | + } |
| 178 | +} |
0 commit comments