From 3cbc984fcf0fab278b9c28175319f65db1b9162a Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Mon, 21 Sep 2020 18:11:04 +0800 Subject: [PATCH 01/35] init MetricsAdvisor --- .../preview/v1.0/MetricsAdvisor.json | 6312 +++++++++++++++++ 1 file changed, 6312 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json new file mode 100644 index 000000000000..5741e901087c --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -0,0 +1,6312 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Cognitive Service Metrics Advisor REST API (OpenAPI v2)", + "description": "Azure Cognitive Service Metrics Advisor REST API (OpenAPI v2)", + "version": "1.0" + }, + "paths": { + "/stats/latest": { + "get": { + "tags": [ + "Admin" + ], + "summary": "Get latest usage stats", + "operationId": "getActiveSeriesCount", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UsageStats" + }, + "examples": { + "application/json": { + "timestamp": "2020-03-01T00:00:00Z", + "activeSeriesCount": 100, + "allSeriesCount": 1000, + "metricsCount": 10, + "datafeedCount": 5 +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/alert/anomaly/configurations/{configurationId}": { + "get": { + "tags": [ + "AnomalyAlerting" + ], + "summary": "Query a single anomaly alerting configuration", + "operationId": "getAnomalyAlertingConfiguration", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly alerting configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AnomalyAlertingConfiguration" + }, + "examples": { + "application/json": { + "anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001", + "name": "alerting configuration name", + "description": "this is an anomaly alerting configuration", + "crossMetricsOperator": "AND", + "hookIds": [ + "00000000-0000-0000-0000-000000000001" + ], + "metricAlertingConfigurations": [ + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "anomalyScopeType": "All", + "negationOperation": false, + "severityFilter": { + "minAlertSeverity": "Medium", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + } + }, + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002", + "anomalyScopeType": "Dimension", + "negationOperation": false, + "dimensionAnomalyScope": { + "dimension": { + "city": "Beijing" + } + }, + "severityFilter": { + "minAlertSeverity": "Low", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + }, + "valueFilter": { + "lower": 0.0, + "upper": 1000.0, + "direction": "Both" + } + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + }, + "patch": { + "tags": [ + "AnomalyAlerting" + ], + "summary": "Update anomaly alerting configuration", + "operationId": "updateAnomalyAlertingConfiguration", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly alerting configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "body", + "description": "anomaly alerting configuration", + "required": true, + "schema": { + "$ref": "#/definitions/AnomalyAlertingConfigurationPatch" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + }, + "delete": { + "tags": [ + "AnomalyAlerting" + ], + "summary": "Delete anomaly alerting configuration", + "operationId": "deleteAnomalyAlertingConfiguration", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly alerting configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The resource is deleted successfully or does not exist." + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/alert/anomaly/configurations": { + "post": { + "tags": [ + "AnomalyAlerting" + ], + "summary": "Create anomaly alerting configuration", + "operationId": "createAnomalyAlertingConfiguration", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "anomaly alerting configuration", + "required": true, + "schema": { + "$ref": "#/definitions/AnomalyAlertingConfiguration" + } + } + ], + "responses": { + "201": { + "description": "Success", + "headers": { + "Location": { + "description": "Location of the newly created resource.", + "type": "string" + } + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/alert/anomaly/configurations/{configurationId}/alerts/query": { + "post": { + "tags": [ + "AnomalyAlerting" + ], + "summary": "Query alerts under anomaly alerting configuration", + "operationId": "getAlertsByAnomalyAlertingConfiguration", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly alerting configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "$skip", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "$top", + "type": "integer", + "format": "int32" + }, + { + "in": "body", + "name": "body", + "description": "query alerting result request", + "required": true, + "schema": { + "$ref": "#/definitions/AlertingResultQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AlertResultList" + }, + "examples": { + "application/json": { + "value": [ + { + "alertId": "aaaaaaaaaaaa", + "timestamp": "2020-01-01T00:00:00Z", + "createdTime": "2020-03-01T00:00:00Z", + "modifiedTime": "2020-03-01T00:00:00Z" + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + } + }, + "/alert/anomaly/configurations/{configurationId}/alerts/{alertId}/anomalies": { + "get": { + "tags": [ + "AnomalyAlerting" + ], + "summary": "Query anomalies under a specific alert", + "operationId": "getAnomaliesFromAlertByAnomalyAlertingConfiguration", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly alerting configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "alertId", + "description": "alert id", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "$skip", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "$top", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AnomalyResultList" + }, + "examples": { + "application/json": { + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "timestamp": "2020-01-01T00:00:00Z", + "createdTime": "2020-03-01T00:00:00Z", + "modifiedTime": "2020-03-01T00:00:00Z", + "dimension": { + "category": "__SUM__", + "city": "Beijing" + }, + "property": { + "anomalySeverity": "High", + "anomalyStatus": "Active" + } + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + } + }, + "/alert/anomaly/configurations/{configurationId}/alerts/{alertId}/incidents": { + "get": { + "tags": [ + "AnomalyAlerting" + ], + "summary": "Query incidents under a specific alert", + "operationId": "getIncidentsFromAlertByAnomalyAlertingConfiguration", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly alerting configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "alertId", + "description": "alert id", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "$skip", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "$top", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IncidentResultList" + }, + "examples": { + "application/json": { + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "incidentId": "iiiiiiiiiiii", + "startTime": "2020-01-01T00:00:00Z", + "lastTime": "2020-02-01T00:00:00Z", + "rootNode": { + "dimension": { + "category": "__SUM__", + "city": "Beijing" + } + }, + "property": { + "maxSeverity": "High", + "incidentStatus": "Active" + } + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + } + }, + "/enrichment/anomalyDetection/configurations/{configurationId}": { + "get": { + "tags": [ + "AnomalyDetection" + ], + "summary": "Query a single anomaly detection configuration", + "operationId": "getAnomalyDetectionConfiguration", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly detection configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AnomalyDetectionConfiguration" + }, + "examples": { + "application/json": { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "metricId": "22222222-2222-2222-2222-000000000001", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + }, + "patch": { + "tags": [ + "AnomalyDetection" + ], + "summary": "Update anomaly detection configuration", + "operationId": "updateAnomalyDetectionConfiguration", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly detection configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "body", + "description": "anomaly detection configuration", + "required": true, + "schema": { + "$ref": "#/definitions/AnomalyDetectionConfigurationPatch" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + }, + "delete": { + "tags": [ + "AnomalyDetection" + ], + "summary": "Delete anomaly detection configuration", + "operationId": "deleteAnomalyDetectionConfiguration", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly detection configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The resource is deleted successfully or does not exist." + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/enrichment/anomalyDetection/configurations": { + "post": { + "tags": [ + "AnomalyDetection" + ], + "summary": "Create anomaly detection configuration", + "operationId": "createAnomalyDetectionConfiguration", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "anomaly detection configuration", + "required": true, + "schema": { + "$ref": "#/definitions/AnomalyDetectionConfiguration" + } + } + ], + "responses": { + "201": { + "description": "Success", + "headers": { + "Location": { + "description": "Location of the newly created resource.", + "type": "string" + } + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/enrichment/anomalyDetection/configurations/{configurationId}/alert/anomaly/configurations": { + "get": { + "tags": [ + "AnomalyDetection" + ], + "summary": "Query all anomaly alerting configurations for specific anomaly detection configuration", + "operationId": "getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly detection configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AnomalyAlertingConfigurationList" + }, + "examples": { + "application/json": { + "value": [ + { + "anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001", + "name": "alerting configuration name", + "description": "this is an anomaly alerting configuration", + "crossMetricsOperator": "AND", + "hookIds": [ + "00000000-0000-0000-0000-000000000001" + ], + "metricAlertingConfigurations": [ + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "anomalyScopeType": "All", + "negationOperation": false, + "severityFilter": { + "minAlertSeverity": "Medium", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + } + }, + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002", + "anomalyScopeType": "Dimension", + "negationOperation": false, + "dimensionAnomalyScope": { + "dimension": { + "city": "Beijing" + } + }, + "severityFilter": { + "minAlertSeverity": "Low", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + }, + "valueFilter": { + "lower": 0.0, + "upper": 1000.0, + "direction": "Both" + } + } + ] + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/enrichment/anomalyDetection/configurations/{configurationId}/series/query": { + "post": { + "tags": [ + "AnomalyDetection" + ], + "summary": "Query series enriched by anomaly detection", + "operationId": "getSeriesByAnomalyDetectionConfiguration", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly detection configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "body", + "description": "query series detection result request", + "required": true, + "schema": { + "$ref": "#/definitions/DetectionSeriesQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeriesResultList" + }, + "examples": { + "application/json": { + "value": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "timestampList": [ + "2020-01-01T00:00:00Z" + ], + "valueList": [ + 108.3 + ], + "isAnomalyList": [ + false + ], + "periodList": [ + 0 + ], + "expectedValueList": [ + 108.0 + ], + "lowerBoundaryList": [ + 100.1 + ], + "upperBoundaryList": [ + 112.8 + ] + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/enrichment/anomalyDetection/configurations/{configurationId}/anomalies/query": { + "post": { + "tags": [ + "AnomalyDetection" + ], + "summary": "Query anomalies under anomaly detection configuration", + "operationId": "getAnomaliesByAnomalyDetectionConfiguration", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly detection configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "$skip", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "$top", + "type": "integer", + "format": "int32" + }, + { + "in": "body", + "name": "body", + "description": "query detection anomaly result request", + "required": true, + "schema": { + "$ref": "#/definitions/DetectionAnomalyResultQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AnomalyResultList" + }, + "examples": { + "application/json": { + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "timestamp": "2020-01-01T00:00:00Z", + "createdTime": "2020-03-01T00:00:00Z", + "modifiedTime": "2020-03-01T00:00:00Z", + "dimension": { + "category": "__SUM__", + "city": "Beijing" + }, + "property": { + "anomalySeverity": "High", + "anomalyStatus": "Active" + } + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + } + }, + "/enrichment/anomalyDetection/configurations/{configurationId}/anomalies/dimension/query": { + "post": { + "tags": [ + "AnomalyDetection" + ], + "summary": "Query dimension values of anomalies", + "operationId": "getDimensionOfAnomaliesByAnomalyDetectionConfiguration", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly detection configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "$skip", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "$top", + "type": "integer", + "format": "int32" + }, + { + "in": "body", + "name": "body", + "description": "query dimension values request", + "required": true, + "schema": { + "$ref": "#/definitions/AnomalyDimensionQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AnomalyDimensionList" + }, + "examples": { + "application/json": { + "value": [ + "Jewelry" + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + } + }, + "/enrichment/anomalyDetection/configurations/{configurationId}/incidents/query": { + "post": { + "tags": [ + "AnomalyDetection" + ], + "summary": "Query incidents under anomaly detection configuration", + "operationId": "getIncidentsByAnomalyDetectionConfiguration", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly detection configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "$top", + "type": "integer", + "format": "int32" + }, + { + "in": "body", + "name": "body", + "description": "query detection incident result request", + "required": true, + "schema": { + "$ref": "#/definitions/DetectionIncidentResultQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IncidentResultList" + }, + "examples": { + "application/json": { + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "incidentId": "iiiiiiiiiiii", + "startTime": "2020-01-01T00:00:00Z", + "lastTime": "2020-02-01T00:00:00Z", + "rootNode": { + "dimension": { + "category": "__SUM__", + "city": "Beijing" + } + }, + "property": { + "maxSeverity": "High", + "incidentStatus": "Active" + } + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + }, + "get": { + "tags": [ + "AnomalyDetection" + ], + "summary": "Query incidents under anomaly detection configuration", + "operationId": "getIncidentsByAnomalyDetectionConfigurationNextPages", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly detection configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "$top", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "$token", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IncidentResultList" + }, + "examples": { + "application/json": { + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "incidentId": "iiiiiiiiiiii", + "startTime": "2020-01-01T00:00:00Z", + "lastTime": "2020-02-01T00:00:00Z", + "rootNode": { + "dimension": { + "category": "__SUM__", + "city": "Beijing" + } + }, + "property": { + "maxSeverity": "High", + "incidentStatus": "Active" + } + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + } + }, + "/enrichment/anomalyDetection/configurations/{configurationId}/incidents/{incidentId}/rootCause": { + "get": { + "tags": [ + "AnomalyDetection" + ], + "summary": "Query root cause for incident", + "operationId": "getRootCauseOfIncidentByAnomalyDetectionConfiguration", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "configurationId", + "description": "anomaly detection configuration unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "incidentId", + "description": "incident id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RootCauseList" + }, + "examples": { + "application/json": { + "value": [ + { + "rootCause": { + "dimension": { + "city": "Beijing" + } + }, + "path": [ + "city" + ], + "score": 0.67, + "description": "city = Beijing contributes the most to this anomaly." + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/dataFeeds": { + "get": { + "tags": [ + "DataFeed" + ], + "summary": "List all data feeds", + "operationId": "listDataFeeds", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "dataFeedName", + "description": "filter data feed by its name", + "type": "string" + }, + { + "in": "query", + "name": "dataSourceType", + "description": "filter data feed by its source type", + "type": "string", + "enum": [ + "AzureApplicationInsights", + "AzureBlob", + "AzureCosmosDB", + "AzureDataExplorer", + "AzureDataLakeStorageGen2", + "AzureTable", + "Elasticsearch", + "HttpRequest", + "InfluxDB", + "MongoDB", + "MySql", + "PostgreSql", + "SqlServer" + ], + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + }, + { + "in": "query", + "name": "granularityName", + "description": "filter data feed by its granularity", + "type": "string", + "enum": [ + "Yearly", + "Monthly", + "Weekly", + "Daily", + "Hourly", + "Minutely", + "Secondly", + "Custom" + ], + "x-ms-enum": { + "name": "Granularity", + "modelAsString": true + } + }, + { + "in": "query", + "name": "status", + "description": "filter data feed by its status", + "type": "string", + "enum": [ + "Active", + "Paused" + ], + "x-ms-enum": { + "name": "EntityStatus", + "modelAsString": true + } + }, + { + "in": "query", + "name": "creator", + "description": "filter data feed by its creator", + "type": "string" + }, + { + "in": "query", + "name": "$skip", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "$top", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataFeedList" + }, + "examples": { + "application/json": { + "@nextLink": "https://localhost/dataFeeds?$skip=1&$top=1", + "value": [ + { + "dataSourceParameter": { + "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", + "query": "select * from your_table where timestamp = @StartTime" + }, + "dataFeedId": "11111111-1111-1111-1111-000000000001", + "dataFeedName": "Sample - cost/revenue - city/category", + "dataFeedDescription": "This is a sample data feed.", + "granularityName": "Daily", + "metrics": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "metricName": "cost", + "metricDisplayName": "cost" + }, + { + "metricId": "22222222-2222-2222-2222-000000000002", + "metricName": "revenue", + "metricDisplayName": "revenue" + } + ], + "dimension": [ + { + "dimensionName": "category", + "dimensionDisplayName": "category" + }, + { + "dimensionName": "city", + "dimensionDisplayName": "city" + } + ], + "timestampColumn": "timestamp", + "dataStartFrom": "2020-01-01T00:00:00Z", + "dataSourceType": "SqlServer", + "startOffsetInSeconds": 86400, + "maxConcurrency": 5, + "minRetryIntervalInSeconds": 3600, + "stopRetryAfterInSeconds": 604800, + "needRollup": "NeedRollup", + "rollUpMethod": "Sum", + "allUpIdentification": "__SUM__", + "fillMissingPointType": "SmartFilling", + "viewMode": "Private", + "admins": [ + "admin@company.example" + ], + "viewers": [], + "isAdmin": true, + "creator": "admin@company.example", + "status": "Active", + "createdTime": "2020-03-01T00:00:00Z" + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + }, + "post": { + "tags": [ + "DataFeed" + ], + "summary": "Create a new data feed", + "operationId": "createDataFeed", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "parameters to create a data feed", + "required": true, + "schema": { + "$ref": "#/definitions/DataFeedDetail" + } + } + ], + "responses": { + "201": { + "description": "Success", + "headers": { + "Location": { + "description": "Location of the newly created resource.", + "type": "string" + } + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/dataFeeds/{dataFeedId}": { + "get": { + "tags": [ + "DataFeed" + ], + "summary": "Get a data feed by its id", + "operationId": "getDataFeedById", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataFeedId", + "description": "The data feed unique id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataFeedDetail" + }, + "examples": { + "application/json": { + "dataSourceParameter": { + "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", + "query": "select * from your_table where timestamp = @StartTime" + }, + "dataFeedId": "11111111-1111-1111-1111-000000000001", + "dataFeedName": "Sample - cost/revenue - city/category", + "dataFeedDescription": "This is a sample data feed.", + "granularityName": "Daily", + "metrics": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "metricName": "cost", + "metricDisplayName": "cost" + }, + { + "metricId": "22222222-2222-2222-2222-000000000002", + "metricName": "revenue", + "metricDisplayName": "revenue" + } + ], + "dimension": [ + { + "dimensionName": "category", + "dimensionDisplayName": "category" + }, + { + "dimensionName": "city", + "dimensionDisplayName": "city" + } + ], + "timestampColumn": "timestamp", + "dataStartFrom": "2020-01-01T00:00:00Z", + "dataSourceType": "SqlServer", + "startOffsetInSeconds": 86400, + "maxConcurrency": 5, + "minRetryIntervalInSeconds": 3600, + "stopRetryAfterInSeconds": 604800, + "needRollup": "NeedRollup", + "rollUpMethod": "Sum", + "allUpIdentification": "__SUM__", + "fillMissingPointType": "SmartFilling", + "viewMode": "Private", + "admins": [ + "admin@company.example" + ], + "viewers": [], + "isAdmin": true, + "creator": "admin@company.example", + "status": "Active", + "createdTime": "2020-03-01T00:00:00Z" +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + }, + "patch": { + "tags": [ + "DataFeed" + ], + "summary": "Update a data feed", + "operationId": "updateDataFeed", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataFeedId", + "description": "The data feed unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "body", + "description": "parameters to update a data feed", + "required": true, + "schema": { + "$ref": "#/definitions/DataFeedDetailPatch" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + }, + "delete": { + "tags": [ + "DataFeed" + ], + "summary": "Delete a data feed", + "operationId": "deleteDataFeed", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataFeedId", + "description": "The data feed unique id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The resource is deleted successfully or does not exist." + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/feedback/metric/{feedbackId}": { + "get": { + "tags": [ + "Feedback" + ], + "summary": "Get a metric feedback by its id", + "operationId": "getMetricFeedback", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "feedbackId", + "description": "", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MetricFeedback" + }, + "examples": { + "application/json": { + "startTime": "2020-01-01T00:00:00Z", + "endTime": "2020-01-01T00:00:00Z", + "value": { + "anomalyValue": "NotAnomaly" + }, + "anomalyDetectionConfigurationId": "00000000-0000-0000-0000-000000000000", + "anomalyDetectionConfigurationSnapshot": { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "metricId": "22222222-2222-2222-2222-000000000001", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] + }, + "feedbackId": "99999999-9999-9999-9999-000000000001", + "createdTime": "2020-03-01T00:00:00Z", + "userPrincipal": "viewer@company.example", + "metricId": "22222222-2222-2222-2222-000000000001", + "dimensionFilter": { + "dimension": { + "city": "Beijing" + } + }, + "feedbackType": "Anomaly" +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/feedback/metric/query": { + "post": { + "tags": [ + "Feedback" + ], + "summary": "List feedback on the given metric", + "operationId": "listMetricFeedbacks", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "$skip", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "$top", + "type": "integer", + "format": "int32" + }, + { + "in": "body", + "name": "body", + "description": "metric feedback filter", + "required": true, + "schema": { + "$ref": "#/definitions/MetricFeedbackFilter" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MetricFeedbackList" + }, + "examples": { + "application/json": { + "@nextLink": "https://localhost/feedback?$skip=1&$top=1", + "value": [ + { + "startTime": "2020-01-01T00:00:00Z", + "endTime": "2020-01-01T00:00:00Z", + "value": { + "anomalyValue": "NotAnomaly" + }, + "anomalyDetectionConfigurationId": "00000000-0000-0000-0000-000000000000", + "anomalyDetectionConfigurationSnapshot": { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "metricId": "22222222-2222-2222-2222-000000000001", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] + }, + "feedbackId": "99999999-9999-9999-9999-000000000001", + "createdTime": "2020-03-01T00:00:00Z", + "userPrincipal": "viewer@company.example", + "metricId": "22222222-2222-2222-2222-000000000001", + "dimensionFilter": { + "dimension": { + "city": "Beijing" + } + }, + "feedbackType": "Anomaly" + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + } + }, + "/feedback/metric": { + "post": { + "tags": [ + "Feedback" + ], + "summary": "Create a new metric feedback", + "operationId": "createMetricFeedback", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "metric feedback", + "required": true, + "schema": { + "$ref": "#/definitions/MetricFeedback" + } + } + ], + "responses": { + "201": { + "description": "Success", + "headers": { + "Location": { + "description": "Location of the newly created resource.", + "type": "string" + } + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/hooks": { + "get": { + "tags": [ + "Hook" + ], + "summary": "List all hooks", + "operationId": "listHooks", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "hookName", + "description": "filter hook by its name", + "type": "string" + }, + { + "in": "query", + "name": "$skip", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "$top", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HookList" + }, + "examples": { + "application/json": { + "@nextLink": "https://localhost/hooks?$skip=1&$top=1", + "value": [ + { + "hookParameter": { + "endpoint": "https://localhost/demo/post" + }, + "hookId": "00000000-0000-0000-0000-000000000001", + "hookName": "A webhook", + "hookType": "Webhook", + "description": "This is a webhook.", + "externalLink": "", + "admins": [ + "admin@company.example" + ] + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + }, + "post": { + "tags": [ + "Hook" + ], + "summary": "Create a new hook", + "operationId": "createHook", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Create hook request", + "required": true, + "schema": { + "$ref": "#/definitions/HookInfo" + } + } + ], + "responses": { + "201": { + "description": "Success", + "headers": { + "Location": { + "description": "Location of the newly created resource.", + "type": "string" + } + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/hooks/{hookId}": { + "get": { + "tags": [ + "Hook" + ], + "summary": "Get a hook by its id", + "operationId": "getHook", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hookId", + "description": "Hook unique ID", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HookInfo" + }, + "examples": { + "application/json": { + "hookParameter": { + "endpoint": "https://localhost/demo/post" + }, + "hookId": "00000000-0000-0000-0000-000000000001", + "hookName": "A webhook", + "hookType": "Webhook", + "description": "This is a webhook.", + "externalLink": "", + "admins": [ + "admin@company.example" + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + }, + "patch": { + "tags": [ + "Hook" + ], + "summary": "Update a hook", + "operationId": "updateHook", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hookId", + "description": "Hook unique ID", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "body", + "description": "Update hook request", + "required": true, + "schema": { + "$ref": "#/definitions/HookInfoPatch" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + }, + "delete": { + "tags": [ + "Hook" + ], + "summary": "Delete a hook", + "operationId": "deleteHook", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hookId", + "description": "Hook unique ID", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The resource is deleted successfully or does not exist." + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/dataFeeds/{dataFeedId}/ingestionStatus/query": { + "post": { + "tags": [ + "IngestionStatus" + ], + "summary": "Get data ingestion status by data feed", + "operationId": "getDataFeedIngestionStatus", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataFeedId", + "description": "The data feed unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "$skip", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "$top", + "type": "integer", + "format": "int32" + }, + { + "in": "body", + "name": "body", + "description": "The query time range", + "required": true, + "schema": { + "$ref": "#/definitions/IngestionStatusQueryOptions" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionStatusList" + }, + "examples": { + "application/json": { + "@nextLink": "https://localhost/dataFeeds/01234567-8901-2345-6789-012345678901/ingestionStatus/query?$skip=2&$top=2", + "value": [ + { + "timestamp": "2020-01-01T00:00:00Z", + "status": "Succeeded", + "message": "" + }, + { + "timestamp": "2020-01-02T00:00:00Z", + "status": "Succeeded", + "message": "" + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + } + }, + "/dataFeeds/{dataFeedId}/ingestionProgress/reset": { + "post": { + "tags": [ + "IngestionStatus" + ], + "summary": "Reset data ingestion status by data feed to backfill data", + "operationId": "resetDataFeedIngestionStatus", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataFeedId", + "description": "The data feed unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "body", + "description": "The backfill time range", + "required": true, + "schema": { + "$ref": "#/definitions/IngestionProgressResetOptions" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/dataFeeds/{dataFeedId}/ingestionProgress": { + "get": { + "tags": [ + "IngestionStatus" + ], + "summary": "Get data last success ingestion job timestamp by data feed", + "operationId": "getIngestionProgress", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataFeedId", + "description": "The data feed unique id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataFeedIngestionProgress" + }, + "examples": { + "application/json": { + "latestSuccessTimestamp": "2020-01-30T00:00:00Z", + "latestActiveTimestamp": "2020-01-31T00:00:00Z" +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/metrics/{metricId}/data/query": { + "post": { + "tags": [ + "Metric" + ], + "summary": "Get time series data from metric", + "operationId": "getMetricData", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "metricId", + "description": "metric unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "body", + "description": "query time series data condition", + "required": true, + "schema": { + "$ref": "#/definitions/MetricDataQueryOptions" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MetricDataList" + }, + "examples": { + "application/json": { + "value": [ + { + "id": { + "metricId": "22222222-2222-2222-2222-000000000001", + "dimension": { + "category": "__SUM__", + "city": "Beijing" + } + }, + "timestampList": [ + "2020-01-01T00:00:00Z", + "2020-01-02T00:00:00Z" + ], + "valueList": [ + 2.718281828459045, + 3.141592653589793 + ] + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/metrics/{metricId}/series/query": { + "post": { + "tags": [ + "Metric" + ], + "summary": "List series (dimension combinations) from metric", + "operationId": "getMetricSeries", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "metricId", + "description": "metric unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "$skip", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "$top", + "type": "integer", + "format": "int32" + }, + { + "in": "body", + "name": "body", + "description": "filter to query series", + "required": true, + "schema": { + "$ref": "#/definitions/MetricSeriesQueryOptions" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MetricSeriesList" + }, + "examples": { + "application/json": { + "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/series/query?$skip=2&$top=2", + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "dimension": { + "category": "__SUM__", + "city": "Beijing" + } + }, + { + "metricId": "22222222-2222-2222-2222-000000000001", + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + } + }, + "/metrics/{metricId}/dimension/query": { + "post": { + "tags": [ + "Metric" + ], + "summary": "List dimension from certain metric", + "operationId": "getMetricDimension", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "metricId", + "description": "metric unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "$skip", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "$top", + "type": "integer", + "format": "int32" + }, + { + "in": "body", + "name": "body", + "description": "query dimension option", + "required": true, + "schema": { + "$ref": "#/definitions/MetricDimensionQueryOptions" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MetricDimensionList" + }, + "examples": { + "application/json": { + "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/dimension/query?$skip=2&$top=2", + "value": [ + "__SUM__", + "Beijing" + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + } + }, + "/metrics/{metricId}/enrichment/anomalyDetection/configurations": { + "get": { + "tags": [ + "Metric" + ], + "summary": "Query all anomaly detection configurations for specific metric", + "operationId": "getAnomalyDetectionConfigurationsByMetric", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "metricId", + "description": "metric unique id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AnomalyDetectionConfigurationList" + }, + "examples": { + "application/json": { + "value": [ + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "metricId": "22222222-2222-2222-2222-000000000001", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + } + } + }, + "/metrics/{metricId}/status/enrichment/anomalyDetection/query": { + "post": { + "tags": [ + "Metric" + ], + "summary": "Query anomaly detection status", + "operationId": "getEnrichmentStatusByMetric", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "metricId", + "description": "metric unique id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "$skip", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "$top", + "type": "integer", + "format": "int32" + }, + { + "in": "body", + "name": "body", + "description": "query options", + "required": true, + "schema": { + "$ref": "#/definitions/EnrichmentStatusQueryOption" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnrichmentStatusList" + }, + "examples": { + "application/json": { + "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/status/enrichment/anomalyDetection/query?$skip=2&$top=2", + "value": [ + { + "timestamp": "2020-01-01T00:00:00Z", + "status": "Succeeded", + "message": "" + }, + { + "timestamp": "2020-01-02T00:00:00Z", + "status": "Succeeded", + "message": "" + } + ] +} + } + }, + "default": { + "description": "Client error or server error (4xx or 5xx)", + "schema": { + "$ref": "#/definitions/ErrorCode" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + } + } + }, + "definitions": { + "UsageStats": { + "type": "object", + "properties": { + "timestamp": { + "format": "date-time", + "description": "The timestamp of the stats", + "type": "string", + "readOnly": true + }, + "activeSeriesCount": { + "format": "int32", + "description": "The active series count", + "type": "integer", + "readOnly": true + }, + "allSeriesCount": { + "format": "int32", + "description": "All series count under non deleted data feed", + "type": "integer", + "readOnly": true + }, + "metricsCount": { + "format": "int32", + "description": "The metrics count under non deleted data feed", + "type": "integer", + "readOnly": true + }, + "datafeedCount": { + "format": "int32", + "description": "The count of non deleted data feed", + "type": "integer", + "readOnly": true + } + } + }, + "ErrorCode": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "code": { + "type": "string" + } + } + }, + "DimensionGroupIdentity": { + "required": [ + "dimension" + ], + "type": "object", + "properties": { + "dimension": { + "description": "dimension specified for series group", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TopNGroupScope": { + "required": [ + "minTopCount", + "period", + "top" + ], + "type": "object", + "properties": { + "top": { + "format": "int32", + "description": "top N, value range : [1, +∞)", + "type": "integer" + }, + "period": { + "format": "int32", + "description": "point count used to look back, value range : [1, +∞)", + "type": "integer" + }, + "minTopCount": { + "format": "int32", + "description": "min count should be in top N, value range : [1, +∞)\r\n\r\nshould be less than or equal to period", + "type": "integer" + } + } + }, + "SeverityCondition": { + "required": [ + "maxAlertSeverity", + "minAlertSeverity" + ], + "type": "object", + "properties": { + "minAlertSeverity": { + "description": "min alert severity", + "enum": [ + "Low", + "Medium", + "High" + ], + "type": "string", + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "maxAlertSeverity": { + "description": "max alert severity", + "enum": [ + "Low", + "Medium", + "High" + ], + "type": "string", + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + } + } + }, + "AlertSnoozeCondition": { + "required": [ + "autoSnooze", + "onlyForSuccessive", + "snoozeScope" + ], + "type": "object", + "properties": { + "autoSnooze": { + "format": "int32", + "description": "snooze point count, value range : [0, +∞)", + "type": "integer" + }, + "snoozeScope": { + "description": "snooze scope", + "enum": [ + "Metric", + "Series" + ], + "type": "string", + "x-ms-enum": { + "name": "SnoozeScope", + "modelAsString": true + } + }, + "onlyForSuccessive": { + "description": "only snooze for successive anomalies", + "type": "boolean" + } + } + }, + "ValueCondition": { + "required": [ + "direction" + ], + "type": "object", + "properties": { + "lower": { + "format": "double", + "description": "lower bound\r\n\r\nshould be specified when direction is Both or Down", + "type": "number" + }, + "upper": { + "format": "double", + "description": "upper bound\r\n\r\nshould be specified when direction is Both or Up", + "type": "number" + }, + "direction": { + "description": "value filter direction", + "enum": [ + "Both", + "Down", + "Up" + ], + "type": "string", + "x-ms-enum": { + "name": "Direction", + "modelAsString": true + } + }, + "metricId": { + "format": "uuid", + "description": "the other metric unique id used for value filter", + "type": "string" + }, + "triggerForMissing": { + "description": "trigger alert when the corresponding point is missing in the other metric\r\n\r\nshould be specified only when using other metric to filter", + "type": "boolean" + } + } + }, + "MetricAlertingConfiguration": { + "required": [ + "anomalyDetectionConfigurationId", + "anomalyScopeType" + ], + "type": "object", + "properties": { + "anomalyDetectionConfigurationId": { + "format": "uuid", + "description": "Anomaly detection configuration unique id", + "type": "string" + }, + "anomalyScopeType": { + "description": "Anomaly scope", + "enum": [ + "All", + "Dimension", + "TopN" + ], + "type": "string", + "example": "All", + "x-ms-enum": { + "name": "AnomalyScope", + "modelAsString": true + } + }, + "negationOperation": { + "description": "Negation operation", + "type": "boolean" + }, + "dimensionAnomalyScope": { + "$ref": "#/definitions/DimensionGroupIdentity" + }, + "topNAnomalyScope": { + "$ref": "#/definitions/TopNGroupScope" + }, + "severityFilter": { + "$ref": "#/definitions/SeverityCondition" + }, + "snoozeFilter": { + "$ref": "#/definitions/AlertSnoozeCondition" + }, + "valueFilter": { + "$ref": "#/definitions/ValueCondition" + } + } + }, + "AnomalyAlertingConfiguration": { + "required": [ + "hookIds", + "metricAlertingConfigurations", + "name" + ], + "type": "object", + "properties": { + "anomalyAlertingConfigurationId": { + "format": "uuid", + "description": "anomaly alerting configuration unique id", + "type": "string", + "readOnly": true + }, + "name": { + "description": "anomaly alerting configuration name", + "type": "string" + }, + "description": { + "description": "anomaly alerting configuration description", + "type": "string" + }, + "crossMetricsOperator": { + "description": "cross metrics operator\r\n\r\nshould be specified when setting up multiple metric alerting configurations", + "enum": [ + "AND", + "OR", + "XOR" + ], + "type": "string" + }, + "hookIds": { + "description": "hook unique ids", + "uniqueItems": true, + "type": "array", + "items": { + "format": "uuid", + "type": "string" + } + }, + "metricAlertingConfigurations": { + "description": "Anomaly alerting configurations", + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/definitions/MetricAlertingConfiguration" + } + } + } + }, + "AnomalyAlertingConfigurationPatch": { + "type": "object", + "properties": { + "name": { + "description": "Anomaly alerting configuration name", + "type": "string" + }, + "description": { + "description": "anomaly alerting configuration description", + "type": "string" + }, + "crossMetricsOperator": { + "description": "cross metrics operator", + "enum": [ + "AND", + "OR", + "XOR" + ], + "type": "string" + }, + "hookIds": { + "description": "hook unique ids", + "uniqueItems": true, + "type": "array", + "items": { + "format": "uuid", + "type": "string" + } + }, + "metricAlertingConfigurations": { + "description": "Anomaly alerting configurations", + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/definitions/MetricAlertingConfiguration" + } + } + } + }, + "AlertingResultQuery": { + "required": [ + "endTime", + "startTime", + "timeMode" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "start time", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "end time", + "type": "string" + }, + "timeMode": { + "description": "time mode", + "enum": [ + "AnomalyTime", + "CreatedTime", + "ModifiedTime" + ], + "type": "string", + "x-ms-enum": { + "name": "TimeMode", + "modelAsString": true + } + } + } + }, + "AlertResult": { + "type": "object", + "properties": { + "alertId": { + "description": "alert id", + "type": "string", + "readOnly": true + }, + "timestamp": { + "format": "date-time", + "description": "anomaly time", + "type": "string", + "readOnly": true + }, + "createdTime": { + "format": "date-time", + "description": "created time", + "type": "string", + "readOnly": true + }, + "modifiedTime": { + "format": "date-time", + "description": "modified time", + "type": "string", + "readOnly": true + } + } + }, + "AlertResultList": { + "required": [ + "@nextLink", + "value" + ], + "type": "object", + "properties": { + "@nextLink": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AlertResult" + } + } + } + }, + "AnomalyProperty": { + "required": [ + "anomalySeverity" + ], + "type": "object", + "properties": { + "anomalySeverity": { + "description": "anomaly severity", + "enum": [ + "Low", + "Medium", + "High" + ], + "type": "string", + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "anomalyStatus": { + "description": "anomaly status\r\n\r\nonly return for alerting anomaly result", + "enum": [ + "Active", + "Resolved" + ], + "type": "string", + "readOnly": true + } + } + }, + "AnomalyResult": { + "required": [ + "dimension", + "property", + "timestamp" + ], + "type": "object", + "properties": { + "metricId": { + "format": "uuid", + "description": "metric unique id\r\n\r\nonly return for alerting anomaly result", + "type": "string", + "readOnly": true + }, + "anomalyDetectionConfigurationId": { + "format": "uuid", + "description": "anomaly detection configuration unique id\r\n\r\nonly return for alerting anomaly result", + "type": "string", + "readOnly": true + }, + "timestamp": { + "format": "date-time", + "description": "anomaly time", + "type": "string" + }, + "createdTime": { + "format": "date-time", + "description": "created time\r\n\r\nonly return for alerting result", + "type": "string", + "readOnly": true + }, + "modifiedTime": { + "format": "date-time", + "description": "modified time\r\n\r\nonly return for alerting result", + "type": "string", + "readOnly": true + }, + "dimension": { + "description": "dimension specified for series", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "property": { + "$ref": "#/definitions/AnomalyProperty" + } + } + }, + "AnomalyResultList": { + "required": [ + "@nextLink", + "value" + ], + "type": "object", + "properties": { + "@nextLink": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AnomalyResult" + } + } + } + }, + "SeriesIdentity": { + "required": [ + "dimension" + ], + "type": "object", + "properties": { + "dimension": { + "description": "dimension specified for series", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "IncidentProperty": { + "required": [ + "maxSeverity" + ], + "type": "object", + "properties": { + "maxSeverity": { + "description": "max severity of latest anomalies in the incident", + "enum": [ + "Low", + "Medium", + "High" + ], + "type": "string", + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "incidentStatus": { + "description": "incident status\r\n\r\nonly return for alerting incident result", + "enum": [ + "Active", + "Resolved" + ], + "type": "string", + "readOnly": true + } + } + }, + "IncidentResult": { + "required": [ + "incidentId", + "lastTime", + "property", + "rootNode", + "startTime" + ], + "type": "object", + "properties": { + "metricId": { + "format": "uuid", + "description": "metric unique id\r\n\r\nonly return for alerting incident result", + "type": "string", + "readOnly": true + }, + "anomalyDetectionConfigurationId": { + "format": "uuid", + "description": "anomaly detection configuration unique id\r\n\r\nonly return for alerting incident result", + "type": "string", + "readOnly": true + }, + "incidentId": { + "description": "incident id", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "incident start time", + "type": "string" + }, + "lastTime": { + "format": "date-time", + "description": "incident last time", + "type": "string" + }, + "rootNode": { + "$ref": "#/definitions/SeriesIdentity" + }, + "property": { + "$ref": "#/definitions/IncidentProperty" + } + } + }, + "IncidentResultList": { + "required": [ + "@nextLink", + "value" + ], + "type": "object", + "properties": { + "@nextLink": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IncidentResult" + } + } + } + }, + "SuppressCondition": { + "required": [ + "minNumber", + "minRatio" + ], + "type": "object", + "properties": { + "minNumber": { + "format": "int32", + "description": "min point number, value range : [1, +∞)", + "type": "integer" + }, + "minRatio": { + "format": "double", + "description": "min point ratio, value range : (0, 100]", + "type": "number" + } + } + }, + "SmartDetectionCondition": { + "required": [ + "anomalyDetectorDirection", + "sensitivity", + "suppressCondition" + ], + "type": "object", + "properties": { + "sensitivity": { + "format": "double", + "description": "sensitivity, value range : (0, 100]", + "type": "number" + }, + "anomalyDetectorDirection": { + "description": "detection direction", + "enum": [ + "Both", + "Down", + "Up" + ], + "type": "string", + "x-ms-enum": { + "name": "AnomalyDetectorDirection", + "modelAsString": true + } + }, + "suppressCondition": { + "$ref": "#/definitions/SuppressCondition" + } + } + }, + "HardThresholdCondition": { + "required": [ + "anomalyDetectorDirection", + "suppressCondition" + ], + "type": "object", + "properties": { + "lowerBound": { + "format": "double", + "description": "lower bound\r\n\r\nshould be specified when anomalyDetectorDirection is Both or Down", + "type": "number" + }, + "upperBound": { + "format": "double", + "description": "upper bound\r\n\r\nshould be specified when anomalyDetectorDirection is Both or Up", + "type": "number" + }, + "anomalyDetectorDirection": { + "description": "detection direction", + "enum": [ + "Both", + "Down", + "Up" + ], + "type": "string", + "x-ms-enum": { + "name": "AnomalyDetectorDirection", + "modelAsString": true + } + }, + "suppressCondition": { + "$ref": "#/definitions/SuppressCondition" + } + } + }, + "ChangeThresholdCondition": { + "required": [ + "anomalyDetectorDirection", + "changePercentage", + "shiftPoint", + "suppressCondition", + "withinRange" + ], + "type": "object", + "properties": { + "changePercentage": { + "format": "double", + "description": "change percentage, value range : [0, +∞)", + "type": "number" + }, + "shiftPoint": { + "format": "int32", + "description": "shift point, value range : [1, +∞)", + "type": "integer" + }, + "withinRange": { + "description": "if the withinRange = true, detected data is abnormal when the value falls in the range, in this case anomalyDetectorDirection must be Both\r\nif the withinRange = false, detected data is abnormal when the value falls out of the range", + "type": "boolean" + }, + "anomalyDetectorDirection": { + "description": "detection direction", + "enum": [ + "Both", + "Down", + "Up" + ], + "type": "string", + "x-ms-enum": { + "name": "AnomalyDetectorDirection", + "modelAsString": true + } + }, + "suppressCondition": { + "$ref": "#/definitions/SuppressCondition" + } + } + }, + "WholeMetricConfiguration": { + "type": "object", + "properties": { + "conditionOperator": { + "description": "condition operator\r\n\r\nshould be specified when combining multiple detection conditions", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "smartDetectionCondition": { + "$ref": "#/definitions/SmartDetectionCondition" + }, + "hardThresholdCondition": { + "$ref": "#/definitions/HardThresholdCondition" + }, + "changeThresholdCondition": { + "$ref": "#/definitions/ChangeThresholdCondition" + } + } + }, + "DimensionGroupConfiguration": { + "required": [ + "group" + ], + "type": "object", + "properties": { + "group": { + "$ref": "#/definitions/DimensionGroupIdentity" + }, + "conditionOperator": { + "description": "condition operator\r\n\r\nshould be specified when combining multiple detection conditions", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "smartDetectionCondition": { + "$ref": "#/definitions/SmartDetectionCondition" + }, + "hardThresholdCondition": { + "$ref": "#/definitions/HardThresholdCondition" + }, + "changeThresholdCondition": { + "$ref": "#/definitions/ChangeThresholdCondition" + } + } + }, + "SeriesConfiguration": { + "required": [ + "series" + ], + "type": "object", + "properties": { + "series": { + "$ref": "#/definitions/SeriesIdentity" + }, + "conditionOperator": { + "description": "condition operator\r\n\r\nshould be specified when combining multiple detection conditions", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "smartDetectionCondition": { + "$ref": "#/definitions/SmartDetectionCondition" + }, + "hardThresholdCondition": { + "$ref": "#/definitions/HardThresholdCondition" + }, + "changeThresholdCondition": { + "$ref": "#/definitions/ChangeThresholdCondition" + } + } + }, + "AnomalyDetectionConfiguration": { + "required": [ + "metricId", + "name", + "wholeMetricConfiguration" + ], + "type": "object", + "properties": { + "anomalyDetectionConfigurationId": { + "format": "uuid", + "description": "anomaly detection configuration unique id", + "type": "string", + "readOnly": true + }, + "name": { + "description": "anomaly detection configuration name", + "type": "string" + }, + "description": { + "description": "anomaly detection configuration description", + "type": "string" + }, + "metricId": { + "format": "uuid", + "description": "metric unique id", + "type": "string" + }, + "wholeMetricConfiguration": { + "$ref": "#/definitions/WholeMetricConfiguration" + }, + "dimensionGroupOverrideConfigurations": { + "description": "detection configuration for series group", + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/definitions/DimensionGroupConfiguration" + } + }, + "seriesOverrideConfigurations": { + "description": "detection configuration for specific series", + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/definitions/SeriesConfiguration" + } + } + } + }, + "AnomalyDetectionConfigurationPatch": { + "type": "object", + "properties": { + "name": { + "description": "anomaly detection configuration name", + "type": "string" + }, + "description": { + "description": "anomaly detection configuration description", + "type": "string" + }, + "wholeMetricConfiguration": { + "$ref": "#/definitions/WholeMetricConfiguration" + }, + "dimensionGroupOverrideConfigurations": { + "description": "detection configuration for series group", + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/definitions/DimensionGroupConfiguration" + } + }, + "seriesOverrideConfigurations": { + "description": "detection configuration for specific series", + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/definitions/SeriesConfiguration" + } + } + } + }, + "AnomalyAlertingConfigurationList": { + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AnomalyAlertingConfiguration" + } + } + } + }, + "DetectionSeriesQuery": { + "required": [ + "endTime", + "series", + "startTime" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "start time", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "end time", + "type": "string" + }, + "series": { + "description": "series", + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/definitions/SeriesIdentity" + } + } + } + }, + "SeriesResult": { + "required": [ + "expectedValueList", + "isAnomalyList", + "lowerBoundaryList", + "periodList", + "series", + "timestampList", + "upperBoundaryList", + "valueList" + ], + "type": "object", + "properties": { + "series": { + "$ref": "#/definitions/SeriesIdentity" + }, + "timestampList": { + "description": "timestamps of the series", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + } + }, + "valueList": { + "description": "values of the series", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + }, + "isAnomalyList": { + "description": "whether points of the series are anomalies", + "type": "array", + "items": { + "type": "boolean" + } + }, + "periodList": { + "description": "period calculated on each point of the series", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "expectedValueList": { + "description": "expected values of the series given by smart detector", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + }, + "lowerBoundaryList": { + "description": "lower boundary list of the series given by smart detector", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + }, + "upperBoundaryList": { + "description": "upper boundary list of the series given by smart detector", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + }, + "SeriesResultList": { + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SeriesResult" + } + } + } + }, + "SeverityFilterCondition": { + "required": [ + "max", + "min" + ], + "type": "object", + "properties": { + "min": { + "description": "min severity", + "enum": [ + "Low", + "Medium", + "High" + ], + "type": "string", + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "max": { + "description": "max severity", + "enum": [ + "Low", + "Medium", + "High" + ], + "type": "string", + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + } + } + }, + "DetectionAnomalyFilterCondition": { + "type": "object", + "properties": { + "dimensionFilter": { + "description": "dimension filter", + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/definitions/DimensionGroupIdentity" + } + }, + "severityFilter": { + "$ref": "#/definitions/SeverityFilterCondition" + } + } + }, + "DetectionAnomalyResultQuery": { + "required": [ + "endTime", + "startTime" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "start time", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "end time", + "type": "string" + }, + "filter": { + "$ref": "#/definitions/DetectionAnomalyFilterCondition" + } + } + }, + "AnomalyDimensionQuery": { + "required": [ + "dimensionName", + "endTime", + "startTime" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "start time", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "end time", + "type": "string" + }, + "dimensionName": { + "description": "dimension to query", + "type": "string" + }, + "dimensionFilter": { + "$ref": "#/definitions/DimensionGroupIdentity" + } + } + }, + "AnomalyDimensionList": { + "required": [ + "@nextLink", + "value" + ], + "type": "object", + "properties": { + "@nextLink": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DetectionIncidentFilterCondition": { + "type": "object", + "properties": { + "dimensionFilter": { + "description": "dimension filter", + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/definitions/DimensionGroupIdentity" + } + } + } + }, + "DetectionIncidentResultQuery": { + "required": [ + "endTime", + "startTime" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "start time", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "end time", + "type": "string" + }, + "filter": { + "$ref": "#/definitions/DetectionIncidentFilterCondition" + } + } + }, + "RootCause": { + "required": [ + "description", + "path", + "rootCause", + "score" + ], + "type": "object", + "properties": { + "rootCause": { + "$ref": "#/definitions/DimensionGroupIdentity" + }, + "path": { + "description": "drilling down path from query anomaly to root cause", + "type": "array", + "items": { + "type": "string" + } + }, + "score": { + "format": "double", + "description": "score", + "type": "number" + }, + "description": { + "description": "description", + "type": "string" + } + } + }, + "RootCauseList": { + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RootCause" + } + } + } + }, + "AzureApplicationInsightsParameter": { + "required": [ + "apiKey", + "applicationId", + "azureCloud", + "query" + ], + "type": "object", + "properties": { + "azureCloud": { + "description": "Azure cloud environment", + "type": "string" + }, + "applicationId": { + "description": "Azure Application Insights ID", + "type": "string" + }, + "apiKey": { + "description": "API Key", + "type": "string" + }, + "query": { + "description": "Query", + "type": "string" + } + } + }, + "Metric": { + "required": [ + "metricName" + ], + "type": "object", + "properties": { + "metricId": { + "format": "uuid", + "description": "metric id", + "type": "string", + "readOnly": true + }, + "metricName": { + "description": "metric name", + "type": "string" + }, + "metricDisplayName": { + "description": "metric display name", + "pattern": "[.a-zA-Z0-9_-]+", + "type": "string" + }, + "metricDescription": { + "description": "metric description", + "type": "string" + } + } + }, + "Dimension": { + "required": [ + "dimensionName" + ], + "type": "object", + "properties": { + "dimensionName": { + "description": "dimension name", + "type": "string" + }, + "dimensionDisplayName": { + "description": "dimension display name", + "pattern": "[.a-zA-Z0-9_-]+", + "type": "string" + } + } + }, + "DataFeedDetail": { + "required": [ + "dataFeedName", + "dataSourceType", + "dataStartFrom", + "granularityName", + "metrics" + ], + "type": "object", + "properties": { + "dataSourceType": { + "description": "data source type", + "enum": [ + "AzureApplicationInsights", + "AzureBlob", + "AzureCosmosDB", + "AzureDataExplorer", + "AzureDataLakeStorageGen2", + "AzureTable", + "Elasticsearch", + "HttpRequest", + "InfluxDB", + "MongoDB", + "MySql", + "PostgreSql", + "SqlServer" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + }, + "dataFeedId": { + "format": "uuid", + "description": "data feed unique id", + "type": "string", + "readOnly": true + }, + "dataFeedName": { + "description": "data feed name", + "type": "string", + "example": "dummy data feed name" + }, + "dataFeedDescription": { + "description": "data feed description", + "type": "string" + }, + "granularityName": { + "description": "granularity of the time series", + "enum": [ + "Yearly", + "Monthly", + "Weekly", + "Daily", + "Hourly", + "Minutely", + "Secondly", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "Granularity", + "modelAsString": true + } + }, + "granularityAmount": { + "format": "int32", + "description": "if granularity is custom,it is required.", + "type": "integer" + }, + "metrics": { + "description": "measure list", + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/definitions/Metric" + } + }, + "dimension": { + "description": "dimension list", + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + }, + "timestampColumn": { + "description": "user-defined timestamp column. if timestampColumn is null, start time of every time slice will be used as default value.", + "type": "string" + }, + "dataStartFrom": { + "format": "date-time", + "description": "ingestion start time", + "type": "string" + }, + "startOffsetInSeconds": { + "format": "int64", + "description": "the time that the beginning of data ingestion task will delay for every data slice according to this offset.", + "default": 0, + "type": "integer" + }, + "maxConcurrency": { + "format": "int32", + "description": "the max concurrency of data ingestion queries against user data source. 0 means no limitation.", + "default": -1, + "type": "integer" + }, + "minRetryIntervalInSeconds": { + "format": "int64", + "description": "the min retry interval for failed data ingestion tasks.", + "default": -1, + "type": "integer" + }, + "stopRetryAfterInSeconds": { + "format": "int64", + "description": "stop retry data ingestion after the data slice first schedule time in seconds.", + "default": -1, + "type": "integer" + }, + "needRollup": { + "description": "mark if the data feed need rollup", + "default": "NeedRollup", + "enum": [ + "NoRollup", + "NeedRollup", + "AlreadyRollup" + ], + "type": "string", + "x-ms-enum": { + "name": "NeedRollupEnum", + "modelAsString": true + } + }, + "rollUpMethod": { + "description": "roll up method", + "enum": [ + "None", + "Sum", + "Max", + "Min", + "Avg", + "Count" + ], + "type": "string" + }, + "rollUpColumns": { + "description": "roll up columns", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "allUpIdentification": { + "description": "the identification value for the row of calculated all-up value.", + "type": "string" + }, + "fillMissingPointType": { + "description": "the type of fill missing point for anomaly detection", + "default": "SmartFilling", + "enum": [ + "SmartFilling", + "PreviousValue", + "CustomValue", + "NoFilling" + ], + "type": "string", + "x-ms-enum": { + "name": "FillMissingPointType", + "modelAsString": true + } + }, + "fillMissingPointValue": { + "format": "double", + "description": "the value of fill missing point for anomaly detection", + "type": "number" + }, + "viewMode": { + "description": "data feed access mode, default is Private", + "default": "Private", + "enum": [ + "Private", + "Public" + ], + "type": "string", + "x-ms-enum": { + "name": "ViewMode", + "modelAsString": true + } + }, + "admins": { + "description": "data feed administrator", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "viewers": { + "description": "data feed viewer", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "isAdmin": { + "description": "the query user is one of data feed administrator or not", + "type": "boolean", + "readOnly": true + }, + "creator": { + "description": "data feed creator", + "type": "string", + "readOnly": true + }, + "status": { + "description": "data feed status", + "default": "Active", + "enum": [ + "Active", + "Paused" + ], + "type": "string", + "readOnly": true + }, + "createdTime": { + "format": "date-time", + "description": "data feed created time", + "type": "string", + "readOnly": true + }, + "actionLinkTemplate": { + "description": "action link for alert", + "type": "string" + } + }, + "discriminator": "dataSourceType" + }, + "AzureApplicationInsightsDataFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetail" + }, + { + "required": [ + "dataFeedName", + "dataSourceParameter", + "dataSourceType", + "dataStartFrom", + "granularityName", + "metrics" + ], + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/AzureApplicationInsightsParameter" + } + }, + "x-ms-discriminator-value": "AzureApplicationInsights" + } + ] + }, + "AzureBlobParameter": { + "required": [ + "blobTemplate", + "connectionString", + "container" + ], + "type": "object", + "properties": { + "connectionString": { + "description": "Azure Blob connection string", + "type": "string" + }, + "container": { + "description": "Container", + "type": "string" + }, + "blobTemplate": { + "description": "Blob Template", + "type": "string" + } + } + }, + "AzureBlobDataFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetail" + }, + { + "required": [ + "dataFeedName", + "dataSourceParameter", + "dataSourceType", + "dataStartFrom", + "granularityName", + "metrics" + ], + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/AzureBlobParameter" + } + }, + "x-ms-discriminator-value": "AzureBlob" + } + ] + }, + "AzureCosmosDBParameter": { + "required": [ + "collectionId", + "connectionString", + "database", + "sqlQuery" + ], + "type": "object", + "properties": { + "connectionString": { + "description": "Azure CosmosDB connection string", + "type": "string" + }, + "sqlQuery": { + "description": "Query script", + "type": "string" + }, + "database": { + "description": "Database name", + "type": "string" + }, + "collectionId": { + "description": "Collection id", + "type": "string" + } + } + }, + "AzureCosmosDBDataFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetail" + }, + { + "required": [ + "dataFeedName", + "dataSourceParameter", + "dataSourceType", + "dataStartFrom", + "granularityName", + "metrics" + ], + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/AzureCosmosDBParameter" + } + }, + "x-ms-discriminator-value": "AzureCosmosDB" + } + ] + }, + "SqlSourceParameter": { + "required": [ + "connectionString", + "query" + ], + "type": "object", + "properties": { + "connectionString": { + "description": "Database connection string", + "type": "string" + }, + "query": { + "description": "Query script", + "type": "string" + } + } + }, + "AzureDataExplorerDataFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetail" + }, + { + "required": [ + "dataFeedName", + "dataSourceParameter", + "dataSourceType", + "dataStartFrom", + "granularityName", + "metrics" + ], + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/SqlSourceParameter" + } + }, + "x-ms-discriminator-value": "AzureDataExplorer" + } + ] + }, + "AzureDataLakeStorageGen2Parameter": { + "required": [ + "accountKey", + "accountName", + "directoryTemplate", + "fileSystemName", + "fileTemplate" + ], + "type": "object", + "properties": { + "accountName": { + "description": "Account name", + "type": "string" + }, + "accountKey": { + "description": "Account key", + "type": "string" + }, + "fileSystemName": { + "description": "File system name (Container)", + "type": "string" + }, + "directoryTemplate": { + "description": "Directory template", + "type": "string" + }, + "fileTemplate": { + "description": "File template", + "type": "string" + } + } + }, + "AzureDataLakeStorageGen2DataFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetail" + }, + { + "required": [ + "dataFeedName", + "dataSourceParameter", + "dataSourceType", + "dataStartFrom", + "granularityName", + "metrics" + ], + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/AzureDataLakeStorageGen2Parameter" + } + }, + "x-ms-discriminator-value": "AzureDataLakeStorageGen2" + } + ] + }, + "AzureTableParameter": { + "required": [ + "connectionString", + "query", + "table" + ], + "type": "object", + "properties": { + "connectionString": { + "description": "Azure Table connection string", + "type": "string" + }, + "table": { + "description": "Table name", + "type": "string" + }, + "query": { + "description": "Query script", + "type": "string" + } + } + }, + "AzureTableDataFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetail" + }, + { + "required": [ + "dataFeedName", + "dataSourceParameter", + "dataSourceType", + "dataStartFrom", + "granularityName", + "metrics" + ], + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/AzureTableParameter" + } + }, + "x-ms-discriminator-value": "AzureTable" + } + ] + }, + "ElasticsearchParameter": { + "required": [ + "authHeader", + "host", + "port", + "query" + ], + "type": "object", + "properties": { + "host": { + "description": "Host", + "type": "string" + }, + "port": { + "description": "Port", + "type": "string" + }, + "authHeader": { + "description": "Authorization header", + "type": "string" + }, + "query": { + "description": "Query", + "type": "string" + } + } + }, + "ElasticsearchDataFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetail" + }, + { + "required": [ + "dataFeedName", + "dataSourceParameter", + "dataSourceType", + "dataStartFrom", + "granularityName", + "metrics" + ], + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/ElasticsearchParameter" + } + }, + "x-ms-discriminator-value": "Elasticsearch" + } + ] + }, + "HttpRequestParameter": { + "required": [ + "httpHeader", + "httpMethod", + "payload", + "url" + ], + "type": "object", + "properties": { + "url": { + "description": "HTTP URL", + "type": "string" + }, + "httpHeader": { + "description": "HTTP header", + "type": "string" + }, + "httpMethod": { + "description": "HTTP method", + "type": "string" + }, + "payload": { + "description": "HTTP reuqest body", + "type": "string" + } + } + }, + "HttpRequestDataFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetail" + }, + { + "required": [ + "dataFeedName", + "dataSourceParameter", + "dataSourceType", + "dataStartFrom", + "granularityName", + "metrics" + ], + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/HttpRequestParameter" + } + }, + "x-ms-discriminator-value": "HttpRequest" + } + ] + }, + "InfluxDBParameter": { + "required": [ + "connectionString", + "database", + "password", + "query", + "userName" + ], + "type": "object", + "properties": { + "connectionString": { + "description": "InfluxDB connection string", + "type": "string" + }, + "database": { + "description": "Database name", + "type": "string" + }, + "userName": { + "description": "Database access user", + "type": "string" + }, + "password": { + "description": "Database access password", + "type": "string" + }, + "query": { + "description": "Query script", + "type": "string" + } + } + }, + "InfluxDBDataFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetail" + }, + { + "required": [ + "dataFeedName", + "dataSourceParameter", + "dataSourceType", + "dataStartFrom", + "granularityName", + "metrics" + ], + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/InfluxDBParameter" + } + }, + "x-ms-discriminator-value": "InfluxDB" + } + ] + }, + "MySqlDataFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetail" + }, + { + "required": [ + "dataFeedName", + "dataSourceParameter", + "dataSourceType", + "dataStartFrom", + "granularityName", + "metrics" + ], + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/SqlSourceParameter" + } + }, + "x-ms-discriminator-value": "MySql" + } + ] + }, + "PostgreSqlDataFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetail" + }, + { + "required": [ + "dataFeedName", + "dataSourceParameter", + "dataSourceType", + "dataStartFrom", + "granularityName", + "metrics" + ], + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/SqlSourceParameter" + } + }, + "x-ms-discriminator-value": "PostgreSql" + } + ] + }, + "SQLServerDataFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetail" + }, + { + "required": [ + "dataFeedName", + "dataSourceParameter", + "dataSourceType", + "dataStartFrom", + "granularityName", + "metrics" + ], + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/SqlSourceParameter" + } + }, + "x-ms-discriminator-value": "SqlServer" + } + ] + }, + "MongoDBParameter": { + "required": [ + "command", + "connectionString", + "database" + ], + "type": "object", + "properties": { + "connectionString": { + "description": "MongoDB connection string", + "type": "string" + }, + "database": { + "description": "Database name", + "type": "string" + }, + "command": { + "description": "Query script", + "type": "string" + } + } + }, + "MongoDBDataFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetail" + }, + { + "required": [ + "dataFeedName", + "dataSourceParameter", + "dataSourceType", + "dataStartFrom", + "granularityName", + "metrics" + ], + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/MongoDBParameter" + } + }, + "x-ms-discriminator-value": "MongoDB" + } + ] + }, + "DataFeedList": { + "type": "object", + "properties": { + "@nextLink": { + "type": "string", + "readOnly": true + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataFeedDetail" + }, + "readOnly": true + } + } + }, + "DataFeedDetailPatch": { + "required": [ + "dataSourceType" + ], + "type": "object", + "properties": { + "dataSourceType": { + "description": "data source type", + "enum": [ + "AzureApplicationInsights", + "AzureBlob", + "AzureCosmosDB", + "AzureDataExplorer", + "AzureDataLakeStorageGen2", + "AzureTable", + "Elasticsearch", + "HttpRequest", + "InfluxDB", + "MongoDB", + "MySql", + "PostgreSql", + "SqlServer" + ], + "type": "string" + }, + "dataFeedName": { + "description": "data feed name", + "type": "string" + }, + "dataFeedDescription": { + "description": "data feed description", + "type": "string" + }, + "timestampColumn": { + "description": "user-defined timestamp column. if timestampColumn is null, start time of every time slice will be used as default value.", + "type": "string" + }, + "dataStartFrom": { + "format": "date-time", + "description": "ingestion start time", + "type": "string" + }, + "startOffsetInSeconds": { + "format": "int64", + "description": "the time that the beginning of data ingestion task will delay for every data slice according to this offset.", + "type": "integer" + }, + "maxConcurrency": { + "format": "int32", + "description": "the max concurrency of data ingestion queries against user data source. 0 means no limitation.", + "type": "integer" + }, + "minRetryIntervalInSeconds": { + "format": "int64", + "description": "the min retry interval for failed data ingestion tasks.", + "type": "integer" + }, + "stopRetryAfterInSeconds": { + "format": "int64", + "description": "stop retry data ingestion after the data slice first schedule time in seconds.", + "type": "integer" + }, + "needRollup": { + "description": "mark if the data feed need rollup", + "enum": [ + "NoRollup", + "NeedRollup", + "AlreadyRollup" + ], + "type": "string" + }, + "rollUpMethod": { + "description": "roll up method", + "enum": [ + "None", + "Sum", + "Max", + "Min", + "Avg", + "Count" + ], + "type": "string" + }, + "rollUpColumns": { + "description": "roll up columns", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "allUpIdentification": { + "description": "the identification value for the row of calculated all-up value.", + "type": "string" + }, + "fillMissingPointType": { + "description": "the type of fill missing point for anomaly detection", + "enum": [ + "SmartFilling", + "PreviousValue", + "CustomValue", + "NoFilling" + ], + "type": "string" + }, + "fillMissingPointValue": { + "format": "double", + "description": "the value of fill missing point for anomaly detection", + "type": "number" + }, + "viewMode": { + "description": "data feed access mode, default is Private", + "enum": [ + "Private", + "Public" + ], + "type": "string" + }, + "admins": { + "description": "data feed administrator", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "viewers": { + "description": "data feed viewer", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "status": { + "description": "data feed status", + "enum": [ + "Active", + "Paused" + ], + "type": "string" + }, + "actionLinkTemplate": { + "description": "action link for alert", + "type": "string" + } + }, + "discriminator": "dataSourceType" + }, + "AzureApplicationInsightsDataFeedPatch": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetailPatch" + }, + { + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/AzureApplicationInsightsParameter" + } + }, + "x-ms-discriminator-value": "AzureApplicationInsights" + } + ] + }, + "AzureBlobDataFeedPatch": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetailPatch" + }, + { + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/AzureBlobParameter" + } + }, + "x-ms-discriminator-value": "AzureBlob" + } + ] + }, + "AzureCosmosDBDataFeedPatch": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetailPatch" + }, + { + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/AzureCosmosDBParameter" + } + }, + "x-ms-discriminator-value": "AzureCosmosDB" + } + ] + }, + "AzureDataExplorerDataFeedPatch": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetailPatch" + }, + { + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/SqlSourceParameter" + } + }, + "x-ms-discriminator-value": "AzureDataExplorer" + } + ] + }, + "AzureDataLakeStorageGen2DataFeedPatch": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetailPatch" + }, + { + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/AzureDataLakeStorageGen2Parameter" + } + }, + "x-ms-discriminator-value": "AzureDataLakeStorageGen2" + } + ] + }, + "AzureTableDataFeedPatch": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetailPatch" + }, + { + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/AzureTableParameter" + } + }, + "x-ms-discriminator-value": "AzureTable" + } + ] + }, + "ElasticsearchDataFeedPatch": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetailPatch" + }, + { + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/ElasticsearchParameter" + } + }, + "x-ms-discriminator-value": "Elasticsearch" + } + ] + }, + "HttpRequestDataFeedPatch": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetailPatch" + }, + { + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/HttpRequestParameter" + } + }, + "x-ms-discriminator-value": "HttpRequest" + } + ] + }, + "InfluxDBDataFeedPatch": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetailPatch" + }, + { + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/InfluxDBParameter" + } + }, + "x-ms-discriminator-value": "InfluxDB" + } + ] + }, + "MySqlDataFeedPatch": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetailPatch" + }, + { + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/SqlSourceParameter" + } + }, + "x-ms-discriminator-value": "MySql" + } + ] + }, + "PostgreSqlDataFeedPatch": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetailPatch" + }, + { + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/SqlSourceParameter" + } + }, + "x-ms-discriminator-value": "PostgreSql" + } + ] + }, + "SQLServerDataFeedPatch": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetailPatch" + }, + { + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/SqlSourceParameter" + } + }, + "x-ms-discriminator-value": "SqlServer" + } + ] + }, + "MongoDBDataFeedPatch": { + "allOf": [ + { + "$ref": "#/definitions/DataFeedDetailPatch" + }, + { + "type": "object", + "properties": { + "dataSourceParameter": { + "$ref": "#/definitions/MongoDBParameter" + } + }, + "x-ms-discriminator-value": "MongoDB" + } + ] + }, + "AnomalyFeedbackValue": { + "required": [ + "anomalyValue" + ], + "type": "object", + "properties": { + "anomalyValue": { + "enum": [ + "AutoDetect", + "Anomaly", + "NotAnomaly" + ], + "type": "string", + "x-ms-enum": { + "name": "AnomalyValue", + "modelAsString": true + } + } + } + }, + "FeedbackDimensionFilter": { + "required": [ + "dimension" + ], + "type": "object", + "properties": { + "dimension": { + "description": "metric dimension filter", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MetricFeedback": { + "required": [ + "dimensionFilter", + "feedbackType", + "metricId" + ], + "type": "object", + "properties": { + "feedbackType": { + "description": "feedback type", + "enum": [ + "Anomaly", + "ChangePoint", + "Period", + "Comment" + ], + "type": "string", + "x-ms-enum": { + "name": "FeedbackType", + "modelAsString": true + } + }, + "feedbackId": { + "format": "uuid", + "description": "feedback unique id", + "type": "string", + "readOnly": true + }, + "createdTime": { + "format": "date-time", + "description": "feedback created time", + "type": "string", + "readOnly": true + }, + "userPrincipal": { + "description": "user who gives this feedback", + "type": "string", + "readOnly": true + }, + "metricId": { + "format": "uuid", + "description": "metric unique id", + "type": "string" + }, + "dimensionFilter": { + "$ref": "#/definitions/FeedbackDimensionFilter" + } + }, + "discriminator": "feedbackType" + }, + "AnomalyFeedback": { + "allOf": [ + { + "$ref": "#/definitions/MetricFeedback" + }, + { + "required": [ + "dimensionFilter", + "endTime", + "feedbackType", + "metricId", + "startTime", + "value" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "the start timestamp of feedback timerange", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "the end timestamp of feedback timerange, when equals to startTime means only one timestamp", + "type": "string" + }, + "value": { + "$ref": "#/definitions/AnomalyFeedbackValue" + }, + "anomalyDetectionConfigurationId": { + "format": "uuid", + "description": "the corresponding anomaly detection configuration of this feedback", + "type": "string" + }, + "anomalyDetectionConfigurationSnapshot": { + "$ref": "#/definitions/AnomalyDetectionConfiguration" + } + }, + "x-ms-discriminator-value": "Anomaly" + } + ] + }, + "ChangePointFeedbackValue": { + "required": [ + "changePointValue" + ], + "type": "object", + "properties": { + "changePointValue": { + "enum": [ + "AutoDetect", + "ChangePoint", + "NotChangePoint" + ], + "type": "string", + "x-ms-enum": { + "name": "ChangePointValue", + "modelAsString": true + } + } + } + }, + "ChangePointFeedback": { + "allOf": [ + { + "$ref": "#/definitions/MetricFeedback" + }, + { + "required": [ + "dimensionFilter", + "endTime", + "feedbackType", + "metricId", + "startTime", + "value" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "the start timestamp of feedback timerange", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "the end timestamp of feedback timerange, when equals to startTime means only one timestamp", + "type": "string" + }, + "value": { + "$ref": "#/definitions/ChangePointFeedbackValue" + } + }, + "x-ms-discriminator-value": "ChangePoint" + } + ] + }, + "CommentFeedbackValue": { + "required": [ + "commentValue" + ], + "type": "object", + "properties": { + "commentValue": { + "description": "the comment string", + "type": "string" + } + } + }, + "CommentFeedback": { + "allOf": [ + { + "$ref": "#/definitions/MetricFeedback" + }, + { + "required": [ + "dimensionFilter", + "feedbackType", + "metricId", + "value" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "the start timestamp of feedback timerange", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "the end timestamp of feedback timerange, when equals to startTime means only one timestamp", + "type": "string" + }, + "value": { + "$ref": "#/definitions/CommentFeedbackValue" + } + }, + "x-ms-discriminator-value": "Comment" + } + ] + }, + "PeriodFeedbackValue": { + "required": [ + "periodType", + "periodValue" + ], + "type": "object", + "properties": { + "periodType": { + "description": "the type of setting period", + "enum": [ + "AutoDetect", + "AssignValue" + ], + "type": "string", + "x-ms-enum": { + "name": "PeriodType", + "modelAsString": true + } + }, + "periodValue": { + "format": "int32", + "description": "the number of intervals a period contains, when no period set to 0", + "default": 0, + "type": "integer" + } + } + }, + "PeriodFeedback": { + "allOf": [ + { + "$ref": "#/definitions/MetricFeedback" + }, + { + "required": [ + "dimensionFilter", + "feedbackType", + "metricId", + "value" + ], + "type": "object", + "properties": { + "value": { + "$ref": "#/definitions/PeriodFeedbackValue" + } + }, + "x-ms-discriminator-value": "Period" + } + ] + }, + "MetricFeedbackFilter": { + "required": [ + "metricId" + ], + "type": "object", + "properties": { + "metricId": { + "format": "uuid", + "description": "filter feedbacks by metric id", + "type": "string" + }, + "dimensionFilter": { + "$ref": "#/definitions/FeedbackDimensionFilter" + }, + "feedbackType": { + "description": "filter feedbacks by type", + "enum": [ + "Anomaly", + "ChangePoint", + "Period", + "Comment" + ], + "type": "string", + "x-ms-enum": { + "name": "FeedbackType", + "modelAsString": true + } + }, + "startTime": { + "format": "date-time", + "description": "start time filter under chosen time mode", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "end time filter under chosen time mode", + "type": "string" + }, + "timeMode": { + "description": "time mode to filter feedback", + "enum": [ + "MetricTimestamp", + "FeedbackCreatedTime" + ], + "type": "string", + "x-ms-enum": { + "name": "FeedbackQueryTimeMode", + "modelAsString": true + } + } + } + }, + "MetricFeedbackList": { + "type": "object", + "properties": { + "@nextLink": { + "type": "string", + "readOnly": true + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricFeedback" + }, + "readOnly": true + } + } + }, + "EmailHookParameter": { + "required": [ + "toList" + ], + "type": "object", + "properties": { + "toList": { + "description": "Email TO: list.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "HookInfo": { + "required": [ + "hookName", + "hookType" + ], + "type": "object", + "properties": { + "hookType": { + "description": "hook type", + "enum": [ + "Webhook", + "Email" + ], + "type": "string", + "x-ms-enum": { + "name": "HookType", + "modelAsString": true + } + }, + "hookId": { + "format": "uuid", + "description": "Hook unique id", + "type": "string", + "readOnly": true + }, + "hookName": { + "description": "hook unique name", + "type": "string" + }, + "description": { + "description": "hook description", + "type": "string" + }, + "externalLink": { + "description": "hook external link", + "type": "string" + }, + "admins": { + "description": "hook administrators", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "discriminator": "hookType" + }, + "EmailHookInfo": { + "allOf": [ + { + "$ref": "#/definitions/HookInfo" + }, + { + "required": [ + "hookName", + "hookParameter", + "hookType" + ], + "type": "object", + "properties": { + "hookParameter": { + "$ref": "#/definitions/EmailHookParameter" + } + }, + "x-ms-discriminator-value": "Email" + } + ] + }, + "WebhookHookParameter": { + "required": [ + "endpoint" + ], + "type": "object", + "properties": { + "endpoint": { + "description": "API address, will be called when alert is triggered, only support POST method via SSL", + "type": "string" + }, + "username": { + "description": "basic authentication", + "type": "string" + }, + "password": { + "description": "basic authentication", + "type": "string" + }, + "headers": { + "description": "custom headers in api call", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "certificateKey": { + "description": "client certificate", + "type": "string" + }, + "certificatePassword": { + "description": "client certificate password", + "type": "string" + } + } + }, + "WebhookHookInfo": { + "allOf": [ + { + "$ref": "#/definitions/HookInfo" + }, + { + "required": [ + "hookName", + "hookParameter", + "hookType" + ], + "type": "object", + "properties": { + "hookParameter": { + "$ref": "#/definitions/WebhookHookParameter" + } + }, + "x-ms-discriminator-value": "Webhook" + } + ] + }, + "HookList": { + "type": "object", + "properties": { + "@nextLink": { + "type": "string", + "readOnly": true + }, + "value": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/definitions/HookInfo" + }, + "readOnly": true + } + } + }, + "HookInfoPatch": { + "required": [ + "hookType" + ], + "type": "object", + "properties": { + "hookType": { + "description": "hook type", + "enum": [ + "Webhook", + "Email" + ], + "type": "string" + }, + "hookName": { + "description": "hook unique name", + "type": "string" + }, + "description": { + "description": "hook description", + "type": "string" + }, + "externalLink": { + "description": "hook external link", + "type": "string" + }, + "admins": { + "description": "hook administrators", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "discriminator": "hookType" + }, + "EmailHookInfoPatch": { + "allOf": [ + { + "$ref": "#/definitions/HookInfoPatch" + }, + { + "type": "object", + "properties": { + "hookParameter": { + "$ref": "#/definitions/EmailHookParameter" + } + }, + "x-ms-discriminator-value": "Email" + } + ] + }, + "WebhookHookInfoPatch": { + "allOf": [ + { + "$ref": "#/definitions/HookInfoPatch" + }, + { + "type": "object", + "properties": { + "hookParameter": { + "$ref": "#/definitions/WebhookHookParameter" + } + }, + "x-ms-discriminator-value": "Webhook" + } + ] + }, + "IngestionStatusQueryOptions": { + "required": [ + "endTime", + "startTime" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "the start point of time range to query data ingestion status.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "the end point of time range to query data ingestion status.", + "type": "string" + } + } + }, + "IngestionStatus": { + "type": "object", + "properties": { + "timestamp": { + "format": "date-time", + "description": "data slice timestamp.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "latest ingestion task status for this data slice.", + "enum": [ + "NotStarted", + "Scheduled", + "Running", + "Succeeded", + "Failed", + "NoData", + "Error", + "Paused" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "IngestionStatusType", + "modelAsString": true + } + }, + "message": { + "description": "the trimmed message of last ingestion job.", + "type": "string", + "readOnly": true + } + } + }, + "IngestionStatusList": { + "type": "object", + "properties": { + "@nextLink": { + "type": "string", + "readOnly": true + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IngestionStatus" + }, + "readOnly": true + } + } + }, + "IngestionProgressResetOptions": { + "required": [ + "endTime", + "startTime" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "the start point of time range to reset data ingestion status.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "the end point of time range to reset data ingestion status.", + "type": "string" + } + } + }, + "DataFeedIngestionProgress": { + "type": "object", + "properties": { + "latestSuccessTimestamp": { + "format": "date-time", + "description": "the timestamp of lastest success ingestion job.\r\nnull indicates not available", + "type": "string", + "readOnly": true + }, + "latestActiveTimestamp": { + "format": "date-time", + "description": "the timestamp of lastest ingestion job with status update.\r\nnull indicates not available", + "type": "string", + "readOnly": true + } + } + }, + "MetricDataQueryOptions": { + "required": [ + "endTime", + "series", + "startTime" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "start time of query a time series data, and format should be yyyy-MM-ddThh:mm:ssZ", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "start time of query a time series data, and format should be yyyy-MM-ddThh:mm:ssZ", + "type": "string" + }, + "series": { + "description": "query specific series", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "MetricSeriesItem": { + "type": "object", + "properties": { + "metricId": { + "format": "uuid", + "description": "metric unique id", + "type": "string", + "readOnly": true + }, + "dimension": { + "description": "dimension name and value pair", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "MetricDataItem": { + "type": "object", + "properties": { + "id": { + "$ref": "#/definitions/MetricSeriesItem" + }, + "timestampList": { + "description": "timestamps of the data related to this time series", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + }, + "readOnly": true + }, + "valueList": { + "description": "values of the data related to this time series", + "type": "array", + "items": { + "format": "double", + "type": "number" + }, + "readOnly": true + } + } + }, + "MetricDataList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricDataItem" + }, + "readOnly": true + } + } + }, + "MetricSeriesQueryOptions": { + "required": [ + "activeSince" + ], + "type": "object", + "properties": { + "activeSince": { + "format": "date-time", + "description": "query series ingested after this time, the format should be yyyy-MM-ddTHH:mm:ssZ", + "type": "string" + }, + "dimensionFilter": { + "description": "filter specfic dimension name and values", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "MetricSeriesList": { + "type": "object", + "properties": { + "@nextLink": { + "type": "string", + "readOnly": true + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricSeriesItem" + }, + "readOnly": true + } + } + }, + "MetricDimensionQueryOptions": { + "required": [ + "dimensionName" + ], + "type": "object", + "properties": { + "dimensionName": { + "description": "dimension name", + "type": "string" + }, + "dimensionValueFilter": { + "description": "dimension value to be filtered", + "type": "string" + } + } + }, + "MetricDimensionList": { + "type": "object", + "properties": { + "@nextLink": { + "type": "string", + "readOnly": true + }, + "value": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "AnomalyDetectionConfigurationList": { + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AnomalyDetectionConfiguration" + } + } + } + }, + "EnrichmentStatusQueryOption": { + "required": [ + "endTime", + "startTime" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "the start point of time range to query anomaly detection status.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "the end point of time range to query anomaly detection status.", + "type": "string" + } + } + }, + "EnrichmentStatus": { + "type": "object", + "properties": { + "timestamp": { + "format": "date-time", + "description": "data slice timestamp.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "latest enrichment status for this data slice.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "the trimmed message describes details of the enrichment status.", + "type": "string", + "readOnly": true + } + } + }, + "EnrichmentStatusList": { + "type": "object", + "properties": { + "@nextLink": { + "type": "string", + "readOnly": true + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EnrichmentStatus" + }, + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "apiKeyHeader": { + "type": "apiKey", + "name": "x-api-key", + "in": "header" + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://.cognitiveservices.azure.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/metricsadvisor/v1.0/", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} \ No newline at end of file From 66db98bd092c543b4785a6344e0addd9e821a6f2 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Thu, 10 Dec 2020 17:31:33 +0800 Subject: [PATCH 02/35] fix errors and add readme.md --- .../preview/v1.0/MetricsAdvisor.json | 17 ++++++++--------- .../MetricsAdvisor/preview/v1.0/readme.md | 3 +++ 2 files changed, 11 insertions(+), 9 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/readme.md diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index 5741e901087c..ff433d647b87 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -3320,13 +3320,13 @@ }, "AlertResultList": { "required": [ - "@nextLink", "value" ], "type": "object", "properties": { "@nextLink": { - "type": "string" + "type": "string", + "readOnly": true }, "value": { "type": "array", @@ -3417,13 +3417,13 @@ }, "AnomalyResultList": { "required": [ - "@nextLink", "value" ], "type": "object", "properties": { "@nextLink": { - "type": "string" + "type": "string", + "readOnly": true }, "value": { "type": "array", @@ -3524,13 +3524,13 @@ }, "IncidentResultList": { "required": [ - "@nextLink", "value" ], "type": "object", "properties": { "@nextLink": { - "type": "string" + "type": "string", + "readOnly": true }, "value": { "type": "array", @@ -4056,13 +4056,13 @@ }, "AnomalyDimensionList": { "required": [ - "@nextLink", "value" ], "type": "object", "properties": { "@nextLink": { - "type": "string" + "type": "string", + "readOnly": true }, "value": { "type": "array", @@ -4441,7 +4441,6 @@ }, "status": { "description": "data feed status", - "default": "Active", "enum": [ "Active", "Paused" diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/readme.md b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/readme.md new file mode 100644 index 000000000000..5e2e187f3d4e --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/readme.md @@ -0,0 +1,3 @@ +# Cognitive Services Metrics Advisor (preview) + +> see https://aka.ms/autorest From 2342b18a936e73834b6dfb7dc358ec4f9231ff1b Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Thu, 10 Dec 2020 18:08:30 +0800 Subject: [PATCH 03/35] fix errors --- .../preview/v1.0/MetricsAdvisor.json | 1938 ++++++++--------- .../MetricsAdvisor/preview/v1.0/readme.md | 3 - .../data-plane/MetricsAdvisor/readme.md | 21 + 3 files changed, 990 insertions(+), 972 deletions(-) delete mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/readme.md create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/readme.md diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index ff433d647b87..dfe21128e874 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -24,12 +24,12 @@ }, "examples": { "application/json": { - "timestamp": "2020-03-01T00:00:00Z", - "activeSeriesCount": 100, - "allSeriesCount": 1000, - "metricsCount": 10, - "datafeedCount": 5 -} + "timestamp": "2020-03-01T00:00:00Z", + "activeSeriesCount": 100, + "allSeriesCount": 1000, + "metricsCount": 10, + "dataFeedCount": 5 + } } }, "default": { @@ -69,54 +69,54 @@ }, "examples": { "application/json": { - "anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001", - "name": "alerting configuration name", - "description": "this is an anomaly alerting configuration", - "crossMetricsOperator": "AND", - "hookIds": [ - "00000000-0000-0000-0000-000000000001" - ], - "metricAlertingConfigurations": [ - { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "anomalyScopeType": "All", - "negationOperation": false, - "severityFilter": { - "minAlertSeverity": "Medium", - "maxAlertSeverity": "High" - }, - "snoozeFilter": { - "autoSnooze": 0, - "snoozeScope": "Series", - "onlyForSuccessive": true - } - }, - { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002", - "anomalyScopeType": "Dimension", - "negationOperation": false, - "dimensionAnomalyScope": { - "dimension": { - "city": "Beijing" - } - }, - "severityFilter": { - "minAlertSeverity": "Low", - "maxAlertSeverity": "High" - }, - "snoozeFilter": { - "autoSnooze": 0, - "snoozeScope": "Series", - "onlyForSuccessive": true - }, - "valueFilter": { - "lower": 0.0, - "upper": 1000.0, - "direction": "Both" - } - } - ] -} + "anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001", + "name": "alerting configuration name", + "description": "this is an anomaly alerting configuration", + "crossMetricsOperator": "AND", + "hookIds": [ + "00000000-0000-0000-0000-000000000001" + ], + "metricAlertingConfigurations": [ + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "anomalyScopeType": "All", + "negationOperation": false, + "severityFilter": { + "minAlertSeverity": "Medium", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + } + }, + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002", + "anomalyScopeType": "Dimension", + "negationOperation": false, + "dimensionAnomalyScope": { + "dimension": { + "city": "Beijing" + } + }, + "severityFilter": { + "minAlertSeverity": "Low", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + }, + "valueFilter": { + "lower": 0.0, + "upper": 1000.0, + "direction": "Both" + } + } + ] + } } }, "default": { @@ -297,15 +297,15 @@ }, "examples": { "application/json": { - "value": [ - { - "alertId": "aaaaaaaaaaaa", - "timestamp": "2020-01-01T00:00:00Z", - "createdTime": "2020-03-01T00:00:00Z", - "modifiedTime": "2020-03-01T00:00:00Z" - } - ] -} + "value": [ + { + "alertId": "aaaaaaaaaaaa", + "timestamp": "2020-01-01T00:00:00Z", + "createdTime": "2020-03-01T00:00:00Z", + "modifiedTime": "2020-03-01T00:00:00Z" + } + ] + } } }, "default": { @@ -367,24 +367,24 @@ }, "examples": { "application/json": { - "value": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "timestamp": "2020-01-01T00:00:00Z", - "createdTime": "2020-03-01T00:00:00Z", - "modifiedTime": "2020-03-01T00:00:00Z", - "dimension": { - "category": "__SUM__", - "city": "Beijing" - }, - "property": { - "anomalySeverity": "High", - "anomalyStatus": "Active" - } - } - ] -} + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "timestamp": "2020-01-01T00:00:00Z", + "createdTime": "2020-03-01T00:00:00Z", + "modifiedTime": "2020-03-01T00:00:00Z", + "dimension": { + "category": "__SUM__", + "city": "Beijing" + }, + "property": { + "anomalySeverity": "High", + "anomalyStatus": "Active" + } + } + ] + } } }, "default": { @@ -446,26 +446,26 @@ }, "examples": { "application/json": { - "value": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "incidentId": "iiiiiiiiiiii", - "startTime": "2020-01-01T00:00:00Z", - "lastTime": "2020-02-01T00:00:00Z", - "rootNode": { - "dimension": { - "category": "__SUM__", - "city": "Beijing" - } - }, - "property": { - "maxSeverity": "High", - "incidentStatus": "Active" - } - } - ] -} + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "incidentId": "iiiiiiiiiiii", + "startTime": "2020-01-01T00:00:00Z", + "lastTime": "2020-02-01T00:00:00Z", + "rootNode": { + "dimension": { + "category": "__SUM__", + "city": "Beijing" + } + }, + "property": { + "maxSeverity": "High", + "incidentStatus": "Active" + } + } + ] + } } }, "default": { @@ -508,116 +508,116 @@ }, "examples": { "application/json": { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "name": "Anomaly detection configuration name", - "description": "Anomaly detection configuration description", - "metricId": "22222222-2222-2222-2222-000000000001", - "wholeMetricConfiguration": { - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - }, - "dimensionGroupOverrideConfigurations": [ - { - "group": { - "dimension": { - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - } - ], - "seriesOverrideConfigurations": [ - { - "series": { - "dimension": { - "category": "Jewelry", - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - } - ] -} + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "metricId": "22222222-2222-2222-2222-000000000001", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] + } } }, "default": { @@ -774,58 +774,58 @@ }, "examples": { "application/json": { - "value": [ - { - "anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001", - "name": "alerting configuration name", - "description": "this is an anomaly alerting configuration", - "crossMetricsOperator": "AND", - "hookIds": [ - "00000000-0000-0000-0000-000000000001" - ], - "metricAlertingConfigurations": [ - { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "anomalyScopeType": "All", - "negationOperation": false, - "severityFilter": { - "minAlertSeverity": "Medium", - "maxAlertSeverity": "High" - }, - "snoozeFilter": { - "autoSnooze": 0, - "snoozeScope": "Series", - "onlyForSuccessive": true - } - }, - { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002", - "anomalyScopeType": "Dimension", - "negationOperation": false, - "dimensionAnomalyScope": { - "dimension": { - "city": "Beijing" - } - }, - "severityFilter": { - "minAlertSeverity": "Low", - "maxAlertSeverity": "High" - }, - "snoozeFilter": { - "autoSnooze": 0, - "snoozeScope": "Series", - "onlyForSuccessive": true - }, - "valueFilter": { - "lower": 0.0, - "upper": 1000.0, - "direction": "Both" - } - } - ] - } - ] -} + "value": [ + { + "anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001", + "name": "alerting configuration name", + "description": "this is an anomaly alerting configuration", + "crossMetricsOperator": "AND", + "hookIds": [ + "00000000-0000-0000-0000-000000000001" + ], + "metricAlertingConfigurations": [ + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "anomalyScopeType": "All", + "negationOperation": false, + "severityFilter": { + "minAlertSeverity": "Medium", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + } + }, + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002", + "anomalyScopeType": "Dimension", + "negationOperation": false, + "dimensionAnomalyScope": { + "dimension": { + "city": "Beijing" + } + }, + "severityFilter": { + "minAlertSeverity": "Low", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + }, + "valueFilter": { + "lower": 0.0, + "upper": 1000.0, + "direction": "Both" + } + } + ] + } + ] + } } }, "default": { @@ -877,38 +877,38 @@ }, "examples": { "application/json": { - "value": [ - { - "series": { - "dimension": { - "category": "Jewelry", - "city": "Beijing" - } - }, - "timestampList": [ - "2020-01-01T00:00:00Z" - ], - "valueList": [ - 108.3 - ], - "isAnomalyList": [ - false - ], - "periodList": [ - 0 - ], - "expectedValueList": [ - 108.0 - ], - "lowerBoundaryList": [ - 100.1 - ], - "upperBoundaryList": [ - 112.8 - ] - } - ] -} + "value": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "timestampList": [ + "2020-01-01T00:00:00Z" + ], + "valueList": [ + 108.3 + ], + "isAnomalyList": [ + false + ], + "periodList": [ + 0 + ], + "expectedValueList": [ + 108.0 + ], + "lowerBoundaryList": [ + 100.1 + ], + "upperBoundaryList": [ + 112.8 + ] + } + ] + } } }, "default": { @@ -972,24 +972,24 @@ }, "examples": { "application/json": { - "value": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "timestamp": "2020-01-01T00:00:00Z", - "createdTime": "2020-03-01T00:00:00Z", - "modifiedTime": "2020-03-01T00:00:00Z", - "dimension": { - "category": "__SUM__", - "city": "Beijing" - }, - "property": { - "anomalySeverity": "High", - "anomalyStatus": "Active" - } - } - ] -} + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "timestamp": "2020-01-01T00:00:00Z", + "createdTime": "2020-03-01T00:00:00Z", + "modifiedTime": "2020-03-01T00:00:00Z", + "dimension": { + "category": "__SUM__", + "city": "Beijing" + }, + "property": { + "anomalySeverity": "High", + "anomalyStatus": "Active" + } + } + ] + } } }, "default": { @@ -1056,10 +1056,10 @@ }, "examples": { "application/json": { - "value": [ - "Jewelry" - ] -} + "value": [ + "Jewelry" + ] + } } }, "default": { @@ -1120,26 +1120,26 @@ }, "examples": { "application/json": { - "value": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "incidentId": "iiiiiiiiiiii", - "startTime": "2020-01-01T00:00:00Z", - "lastTime": "2020-02-01T00:00:00Z", - "rootNode": { - "dimension": { - "category": "__SUM__", - "city": "Beijing" - } - }, - "property": { - "maxSeverity": "High", - "incidentStatus": "Active" - } - } - ] -} + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "incidentId": "iiiiiiiiiiii", + "startTime": "2020-01-01T00:00:00Z", + "lastTime": "2020-02-01T00:00:00Z", + "rootNode": { + "dimension": { + "category": "__SUM__", + "city": "Beijing" + } + }, + "property": { + "maxSeverity": "High", + "incidentStatus": "Active" + } + } + ] + } } }, "default": { @@ -1191,26 +1191,26 @@ }, "examples": { "application/json": { - "value": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "incidentId": "iiiiiiiiiiii", - "startTime": "2020-01-01T00:00:00Z", - "lastTime": "2020-02-01T00:00:00Z", - "rootNode": { - "dimension": { - "category": "__SUM__", - "city": "Beijing" - } - }, - "property": { - "maxSeverity": "High", - "incidentStatus": "Active" - } - } - ] -} + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "incidentId": "iiiiiiiiiiii", + "startTime": "2020-01-01T00:00:00Z", + "lastTime": "2020-02-01T00:00:00Z", + "rootNode": { + "dimension": { + "category": "__SUM__", + "city": "Beijing" + } + }, + "property": { + "maxSeverity": "High", + "incidentStatus": "Active" + } + } + ] + } } }, "default": { @@ -1260,21 +1260,21 @@ }, "examples": { "application/json": { - "value": [ - { - "rootCause": { - "dimension": { - "city": "Beijing" - } - }, - "path": [ - "city" - ], - "score": 0.67, - "description": "city = Beijing contributes the most to this anomaly." - } - ] -} + "value": [ + { + "rootCause": { + "dimension": { + "city": "Beijing" + } + }, + "path": [ + "city" + ], + "score": 0.67, + "description": "city = Beijing contributes the most to this anomaly." + } + ] + } } }, "default": { @@ -1389,62 +1389,62 @@ }, "examples": { "application/json": { - "@nextLink": "https://localhost/dataFeeds?$skip=1&$top=1", - "value": [ - { - "dataSourceParameter": { - "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", - "query": "select * from your_table where timestamp = @StartTime" - }, - "dataFeedId": "11111111-1111-1111-1111-000000000001", - "dataFeedName": "Sample - cost/revenue - city/category", - "dataFeedDescription": "This is a sample data feed.", - "granularityName": "Daily", - "metrics": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "metricName": "cost", - "metricDisplayName": "cost" - }, - { - "metricId": "22222222-2222-2222-2222-000000000002", - "metricName": "revenue", - "metricDisplayName": "revenue" - } - ], - "dimension": [ - { - "dimensionName": "category", - "dimensionDisplayName": "category" - }, - { - "dimensionName": "city", - "dimensionDisplayName": "city" - } - ], - "timestampColumn": "timestamp", - "dataStartFrom": "2020-01-01T00:00:00Z", - "dataSourceType": "SqlServer", - "startOffsetInSeconds": 86400, - "maxConcurrency": 5, - "minRetryIntervalInSeconds": 3600, - "stopRetryAfterInSeconds": 604800, - "needRollup": "NeedRollup", - "rollUpMethod": "Sum", - "allUpIdentification": "__SUM__", - "fillMissingPointType": "SmartFilling", - "viewMode": "Private", - "admins": [ - "admin@company.example" - ], - "viewers": [], - "isAdmin": true, - "creator": "admin@company.example", - "status": "Active", - "createdTime": "2020-03-01T00:00:00Z" - } - ] -} + "@nextLink": "https://localhost/dataFeeds?$skip=1&$top=1", + "value": [ + { + "dataSourceParameter": { + "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", + "query": "select * from your_table where timestamp = @StartTime" + }, + "dataFeedId": "11111111-1111-1111-1111-000000000001", + "dataFeedName": "Sample - cost/revenue - city/category", + "dataFeedDescription": "This is a sample data feed.", + "granularityName": "Daily", + "metrics": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "metricName": "cost", + "metricDisplayName": "cost" + }, + { + "metricId": "22222222-2222-2222-2222-000000000002", + "metricName": "revenue", + "metricDisplayName": "revenue" + } + ], + "dimension": [ + { + "dimensionName": "category", + "dimensionDisplayName": "category" + }, + { + "dimensionName": "city", + "dimensionDisplayName": "city" + } + ], + "timestampColumn": "timestamp", + "dataStartFrom": "2020-01-01T00:00:00Z", + "dataSourceType": "SqlServer", + "startOffsetInSeconds": 86400, + "maxConcurrency": 5, + "minRetryIntervalInSeconds": 3600, + "stopRetryAfterInSeconds": 604800, + "needRollup": "NeedRollup", + "rollUpMethod": "Sum", + "allUpIdentification": "__SUM__", + "fillMissingPointType": "SmartFilling", + "viewMode": "Private", + "admins": [ + "admin@company.example" + ], + "viewers": [], + "isAdmin": true, + "creator": "admin@company.example", + "status": "Active", + "createdTime": "2020-03-01T00:00:00Z" + } + ] + } } }, "default": { @@ -1528,57 +1528,57 @@ }, "examples": { "application/json": { - "dataSourceParameter": { - "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", - "query": "select * from your_table where timestamp = @StartTime" - }, - "dataFeedId": "11111111-1111-1111-1111-000000000001", - "dataFeedName": "Sample - cost/revenue - city/category", - "dataFeedDescription": "This is a sample data feed.", - "granularityName": "Daily", - "metrics": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "metricName": "cost", - "metricDisplayName": "cost" - }, - { - "metricId": "22222222-2222-2222-2222-000000000002", - "metricName": "revenue", - "metricDisplayName": "revenue" - } - ], - "dimension": [ - { - "dimensionName": "category", - "dimensionDisplayName": "category" - }, - { - "dimensionName": "city", - "dimensionDisplayName": "city" - } - ], - "timestampColumn": "timestamp", - "dataStartFrom": "2020-01-01T00:00:00Z", - "dataSourceType": "SqlServer", - "startOffsetInSeconds": 86400, - "maxConcurrency": 5, - "minRetryIntervalInSeconds": 3600, - "stopRetryAfterInSeconds": 604800, - "needRollup": "NeedRollup", - "rollUpMethod": "Sum", - "allUpIdentification": "__SUM__", - "fillMissingPointType": "SmartFilling", - "viewMode": "Private", - "admins": [ - "admin@company.example" - ], - "viewers": [], - "isAdmin": true, - "creator": "admin@company.example", - "status": "Active", - "createdTime": "2020-03-01T00:00:00Z" -} + "dataSourceParameter": { + "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", + "query": "select * from your_table where timestamp = @StartTime" + }, + "dataFeedId": "11111111-1111-1111-1111-000000000001", + "dataFeedName": "Sample - cost/revenue - city/category", + "dataFeedDescription": "This is a sample data feed.", + "granularityName": "Daily", + "metrics": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "metricName": "cost", + "metricDisplayName": "cost" + }, + { + "metricId": "22222222-2222-2222-2222-000000000002", + "metricName": "revenue", + "metricDisplayName": "revenue" + } + ], + "dimension": [ + { + "dimensionName": "category", + "dimensionDisplayName": "category" + }, + { + "dimensionName": "city", + "dimensionDisplayName": "city" + } + ], + "timestampColumn": "timestamp", + "dataStartFrom": "2020-01-01T00:00:00Z", + "dataSourceType": "SqlServer", + "startOffsetInSeconds": 86400, + "maxConcurrency": 5, + "minRetryIntervalInSeconds": 3600, + "stopRetryAfterInSeconds": 604800, + "needRollup": "NeedRollup", + "rollUpMethod": "Sum", + "allUpIdentification": "__SUM__", + "fillMissingPointType": "SmartFilling", + "viewMode": "Private", + "admins": [ + "admin@company.example" + ], + "viewers": [], + "isAdmin": true, + "creator": "admin@company.example", + "status": "Active", + "createdTime": "2020-03-01T00:00:00Z" + } } }, "default": { @@ -1692,134 +1692,134 @@ }, "examples": { "application/json": { - "startTime": "2020-01-01T00:00:00Z", - "endTime": "2020-01-01T00:00:00Z", - "value": { - "anomalyValue": "NotAnomaly" - }, - "anomalyDetectionConfigurationId": "00000000-0000-0000-0000-000000000000", - "anomalyDetectionConfigurationSnapshot": { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "name": "Anomaly detection configuration name", - "description": "Anomaly detection configuration description", - "metricId": "22222222-2222-2222-2222-000000000001", - "wholeMetricConfiguration": { - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - }, - "dimensionGroupOverrideConfigurations": [ - { - "group": { - "dimension": { - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - } - ], - "seriesOverrideConfigurations": [ - { - "series": { - "dimension": { - "category": "Jewelry", - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - } - ] - }, - "feedbackId": "99999999-9999-9999-9999-000000000001", - "createdTime": "2020-03-01T00:00:00Z", - "userPrincipal": "viewer@company.example", - "metricId": "22222222-2222-2222-2222-000000000001", - "dimensionFilter": { - "dimension": { - "city": "Beijing" - } - }, - "feedbackType": "Anomaly" -} + "startTime": "2020-01-01T00:00:00Z", + "endTime": "2020-01-01T00:00:00Z", + "value": { + "anomalyValue": "NotAnomaly" + }, + "anomalyDetectionConfigurationId": "00000000-0000-0000-0000-000000000000", + "anomalyDetectionConfigurationSnapshot": { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "metricId": "22222222-2222-2222-2222-000000000001", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] + }, + "feedbackId": "99999999-9999-9999-9999-000000000001", + "createdTime": "2020-03-01T00:00:00Z", + "userPrincipal": "viewer@company.example", + "metricId": "22222222-2222-2222-2222-000000000001", + "dimensionFilter": { + "dimension": { + "city": "Beijing" + } + }, + "feedbackType": "Anomaly" + } } }, "default": { @@ -1875,140 +1875,140 @@ }, "examples": { "application/json": { - "@nextLink": "https://localhost/feedback?$skip=1&$top=1", - "value": [ - { - "startTime": "2020-01-01T00:00:00Z", - "endTime": "2020-01-01T00:00:00Z", - "value": { - "anomalyValue": "NotAnomaly" - }, - "anomalyDetectionConfigurationId": "00000000-0000-0000-0000-000000000000", - "anomalyDetectionConfigurationSnapshot": { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "name": "Anomaly detection configuration name", - "description": "Anomaly detection configuration description", - "metricId": "22222222-2222-2222-2222-000000000001", - "wholeMetricConfiguration": { - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - }, - "dimensionGroupOverrideConfigurations": [ - { - "group": { - "dimension": { - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - } - ], - "seriesOverrideConfigurations": [ - { - "series": { - "dimension": { - "category": "Jewelry", - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 + "@nextLink": "https://localhost/feedback?$skip=1&$top=1", + "value": [ + { + "startTime": "2020-01-01T00:00:00Z", + "endTime": "2020-01-01T00:00:00Z", + "value": { + "anomalyValue": "NotAnomaly" + }, + "anomalyDetectionConfigurationId": "00000000-0000-0000-0000-000000000000", + "anomalyDetectionConfigurationSnapshot": { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "metricId": "22222222-2222-2222-2222-000000000001", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] + }, + "feedbackId": "99999999-9999-9999-9999-000000000001", + "createdTime": "2020-03-01T00:00:00Z", + "userPrincipal": "viewer@company.example", + "metricId": "22222222-2222-2222-2222-000000000001", + "dimensionFilter": { + "dimension": { + "city": "Beijing" + } + }, + "feedbackType": "Anomaly" + } + ] } } - } - ] - }, - "feedbackId": "99999999-9999-9999-9999-000000000001", - "createdTime": "2020-03-01T00:00:00Z", - "userPrincipal": "viewer@company.example", - "metricId": "22222222-2222-2222-2222-000000000001", - "dimensionFilter": { - "dimension": { - "city": "Beijing" - } - }, - "feedbackType": "Anomaly" - } - ] -} - } }, "default": { "description": "Client error or server error (4xx or 5xx)", @@ -2103,23 +2103,23 @@ }, "examples": { "application/json": { - "@nextLink": "https://localhost/hooks?$skip=1&$top=1", - "value": [ - { - "hookParameter": { - "endpoint": "https://localhost/demo/post" - }, - "hookId": "00000000-0000-0000-0000-000000000001", - "hookName": "A webhook", - "hookType": "Webhook", - "description": "This is a webhook.", - "externalLink": "", - "admins": [ - "admin@company.example" - ] - } - ] -} + "@nextLink": "https://localhost/hooks?$skip=1&$top=1", + "value": [ + { + "hookParameter": { + "endpoint": "https://localhost/demo/post" + }, + "hookId": "00000000-0000-0000-0000-000000000001", + "hookName": "A webhook", + "hookType": "Webhook", + "description": "This is a webhook.", + "externalLink": "", + "admins": [ + "admin@company.example" + ] + } + ] + } } }, "default": { @@ -2203,18 +2203,18 @@ }, "examples": { "application/json": { - "hookParameter": { - "endpoint": "https://localhost/demo/post" - }, - "hookId": "00000000-0000-0000-0000-000000000001", - "hookName": "A webhook", - "hookType": "Webhook", - "description": "This is a webhook.", - "externalLink": "", - "admins": [ - "admin@company.example" - ] -} + "hookParameter": { + "endpoint": "https://localhost/demo/post" + }, + "hookId": "00000000-0000-0000-0000-000000000001", + "hookName": "A webhook", + "hookType": "Webhook", + "description": "This is a webhook.", + "externalLink": "", + "admins": [ + "admin@company.example" + ] + } } }, "default": { @@ -2352,20 +2352,20 @@ }, "examples": { "application/json": { - "@nextLink": "https://localhost/dataFeeds/01234567-8901-2345-6789-012345678901/ingestionStatus/query?$skip=2&$top=2", - "value": [ - { - "timestamp": "2020-01-01T00:00:00Z", - "status": "Succeeded", - "message": "" - }, - { - "timestamp": "2020-01-02T00:00:00Z", - "status": "Succeeded", - "message": "" - } - ] -} + "@nextLink": "https://localhost/dataFeeds/01234567-8901-2345-6789-012345678901/ingestionStatus/query?$skip=2&$top=2", + "value": [ + { + "timestamp": "2020-01-01T00:00:00Z", + "status": "Succeeded", + "message": "" + }, + { + "timestamp": "2020-01-02T00:00:00Z", + "status": "Succeeded", + "message": "" + } + ] + } } }, "default": { @@ -2453,9 +2453,9 @@ }, "examples": { "application/json": { - "latestSuccessTimestamp": "2020-01-30T00:00:00Z", - "latestActiveTimestamp": "2020-01-31T00:00:00Z" -} + "latestSuccessTimestamp": "2020-01-30T00:00:00Z", + "latestActiveTimestamp": "2020-01-31T00:00:00Z" + } } }, "default": { @@ -2507,26 +2507,26 @@ }, "examples": { "application/json": { - "value": [ - { - "id": { - "metricId": "22222222-2222-2222-2222-000000000001", - "dimension": { - "category": "__SUM__", - "city": "Beijing" - } - }, - "timestampList": [ - "2020-01-01T00:00:00Z", - "2020-01-02T00:00:00Z" - ], - "valueList": [ - 2.718281828459045, - 3.141592653589793 - ] - } - ] -} + "value": [ + { + "id": { + "metricId": "22222222-2222-2222-2222-000000000001", + "dimension": { + "category": "__SUM__", + "city": "Beijing" + } + }, + "timestampList": [ + "2020-01-01T00:00:00Z", + "2020-01-02T00:00:00Z" + ], + "valueList": [ + 2.718281828459045, + 3.141592653589793 + ] + } + ] + } } }, "default": { @@ -2590,24 +2590,24 @@ }, "examples": { "application/json": { - "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/series/query?$skip=2&$top=2", - "value": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "dimension": { - "category": "__SUM__", - "city": "Beijing" - } - }, - { - "metricId": "22222222-2222-2222-2222-000000000001", - "dimension": { - "category": "Jewelry", - "city": "Beijing" - } - } - ] -} + "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/series/query?$skip=2&$top=2", + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "dimension": { + "category": "__SUM__", + "city": "Beijing" + } + }, + { + "metricId": "22222222-2222-2222-2222-000000000001", + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + } + ] + } } }, "default": { @@ -2674,12 +2674,12 @@ }, "examples": { "application/json": { - "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/dimension/query?$skip=2&$top=2", - "value": [ - "__SUM__", - "Beijing" - ] -} + "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/dimension/query?$skip=2&$top=2", + "value": [ + "__SUM__", + "Beijing" + ] + } } }, "default": { @@ -2722,120 +2722,120 @@ }, "examples": { "application/json": { - "value": [ - { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "name": "Anomaly detection configuration name", - "description": "Anomaly detection configuration description", - "metricId": "22222222-2222-2222-2222-000000000001", - "wholeMetricConfiguration": { - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - }, - "dimensionGroupOverrideConfigurations": [ - { - "group": { - "dimension": { - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - } - ], - "seriesOverrideConfigurations": [ - { - "series": { - "dimension": { - "category": "Jewelry", - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - } - ] - } - ] -} + "value": [ + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "metricId": "22222222-2222-2222-2222-000000000001", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] + } + ] + } } }, "default": { @@ -2899,20 +2899,20 @@ }, "examples": { "application/json": { - "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/status/enrichment/anomalyDetection/query?$skip=2&$top=2", - "value": [ - { - "timestamp": "2020-01-01T00:00:00Z", - "status": "Succeeded", - "message": "" - }, - { - "timestamp": "2020-01-02T00:00:00Z", - "status": "Succeeded", - "message": "" - } - ] -} + "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/status/enrichment/anomalyDetection/query?$skip=2&$top=2", + "value": [ + { + "timestamp": "2020-01-01T00:00:00Z", + "status": "Succeeded", + "message": "" + }, + { + "timestamp": "2020-01-02T00:00:00Z", + "status": "Succeeded", + "message": "" + } + ] + } } }, "default": { @@ -2956,7 +2956,7 @@ "type": "integer", "readOnly": true }, - "datafeedCount": { + "dataFeedCount": { "format": "int32", "description": "The count of non deleted data feed", "type": "integer", @@ -4798,7 +4798,7 @@ "type": "string" }, "payload": { - "description": "HTTP reuqest body", + "description": "HTTP request body", "type": "string" } } @@ -5477,12 +5477,12 @@ "properties": { "startTime": { "format": "date-time", - "description": "the start timestamp of feedback timerange", + "description": "the start timestamp of feedback time range", "type": "string" }, "endTime": { "format": "date-time", - "description": "the end timestamp of feedback timerange, when equals to startTime means only one timestamp", + "description": "the end timestamp of feedback time range, when equals to startTime means only one timestamp", "type": "string" }, "value": { @@ -5539,12 +5539,12 @@ "properties": { "startTime": { "format": "date-time", - "description": "the start timestamp of feedback timerange", + "description": "the start timestamp of feedback time range", "type": "string" }, "endTime": { "format": "date-time", - "description": "the end timestamp of feedback timerange, when equals to startTime means only one timestamp", + "description": "the end timestamp of feedback time range, when equals to startTime means only one timestamp", "type": "string" }, "value": { @@ -5583,12 +5583,12 @@ "properties": { "startTime": { "format": "date-time", - "description": "the start timestamp of feedback timerange", + "description": "the start timestamp of feedback time range", "type": "string" }, "endTime": { "format": "date-time", - "description": "the end timestamp of feedback timerange, when equals to startTime means only one timestamp", + "description": "the end timestamp of feedback time range, when equals to startTime means only one timestamp", "type": "string" }, "value": { @@ -6039,13 +6039,13 @@ "properties": { "latestSuccessTimestamp": { "format": "date-time", - "description": "the timestamp of lastest success ingestion job.\r\nnull indicates not available", + "description": "the timestamp of latest success ingestion job.\r\nnull indicates not available", "type": "string", "readOnly": true }, "latestActiveTimestamp": { "format": "date-time", - "description": "the timestamp of lastest ingestion job with status update.\r\nnull indicates not available", + "description": "the timestamp of latest ingestion job with status update.\r\nnull indicates not available", "type": "string", "readOnly": true } @@ -6150,7 +6150,7 @@ "type": "string" }, "dimensionFilter": { - "description": "filter specfic dimension name and values", + "description": "filter specific dimension name and values", "type": "object", "additionalProperties": { "type": "array", @@ -6308,4 +6308,4 @@ } ] } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/readme.md b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/readme.md deleted file mode 100644 index 5e2e187f3d4e..000000000000 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/readme.md +++ /dev/null @@ -1,3 +0,0 @@ -# Cognitive Services Metrics Advisor (preview) - -> see https://aka.ms/autorest diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/readme.md b/specification/cognitiveservices/data-plane/MetricsAdvisor/readme.md new file mode 100644 index 000000000000..d8ce6f964416 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/readme.md @@ -0,0 +1,21 @@ +# Cognitive Services Metrics Advisor SDK + +> see https://aka.ms/autorest + +## Releases + +The current release is `release_1_0_preview`. + +``` yaml +tag: release_1_0_preview +add-credentials: true +openapi-type: data-plane +``` + +### Release 1.0-Preview +These settings apply only when `--tag=release_1_0_preview` is specified on the command line. + +``` yaml $(tag) == 'release_1_0_preview' +input-file: + - preview/v1.0/MetricsAdvisor.json +``` From b6f48d9be765718029e8c42fd326612e5b633f79 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Thu, 10 Dec 2020 19:21:41 +0800 Subject: [PATCH 04/35] fix warnings and add cSpell --- .../data-plane/MetricsAdvisor/cSpell.txt | 1 + .../preview/v1.0/MetricsAdvisor.json | 125 +++++++++++++++--- 2 files changed, 109 insertions(+), 17 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/cSpell.txt diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/cSpell.txt b/specification/cognitiveservices/data-plane/MetricsAdvisor/cSpell.txt new file mode 100644 index 000000000000..d0292e5442b0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/cSpell.txt @@ -0,0 +1 @@ +metricsadvisor \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index dfe21128e874..57df2255c334 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -270,12 +270,14 @@ { "in": "query", "name": "$skip", + "description": "for paging, skipped number", "type": "integer", "format": "int32" }, { "in": "query", "name": "$top", + "description": "for paging, item number in response", "type": "integer", "format": "int32" }, @@ -349,12 +351,14 @@ { "in": "query", "name": "$skip", + "description": "for paging, skipped number", "type": "integer", "format": "int32" }, { "in": "query", "name": "$top", + "description": "for paging, item number in response", "type": "integer", "format": "int32" } @@ -428,12 +432,14 @@ { "in": "query", "name": "$skip", + "description": "for paging, skipped number", "type": "integer", "format": "int32" }, { "in": "query", "name": "$top", + "description": "for paging, item number in response", "type": "integer", "format": "int32" } @@ -945,12 +951,14 @@ { "in": "query", "name": "$skip", + "description": "for paging, skipped number", "type": "integer", "format": "int32" }, { "in": "query", "name": "$top", + "description": "for paging, item number in response", "type": "integer", "format": "int32" }, @@ -1029,12 +1037,14 @@ { "in": "query", "name": "$skip", + "description": "for paging, skipped number", "type": "integer", "format": "int32" }, { "in": "query", "name": "$top", + "description": "for paging, item number in response", "type": "integer", "format": "int32" }, @@ -1099,6 +1109,7 @@ { "in": "query", "name": "$top", + "description": "for paging, item number in response", "type": "integer", "format": "int32" }, @@ -1174,12 +1185,14 @@ { "in": "query", "name": "$top", + "description": "for paging, item number in response", "type": "integer", "format": "int32" }, { "in": "query", "name": "$token", + "description": "the token for getting the next page", "type": "string" } ], @@ -1371,12 +1384,14 @@ { "in": "query", "name": "$skip", + "description": "for paging, skipped number", "type": "integer", "format": "int32" }, { "in": "query", "name": "$top", + "description": "for paging, item number in response", "type": "integer", "format": "int32" } @@ -1678,7 +1693,7 @@ { "in": "path", "name": "feedbackId", - "description": "", + "description": "the unique feedback ID", "required": true, "type": "string", "format": "uuid" @@ -1848,12 +1863,14 @@ { "in": "query", "name": "$skip", + "description": "for paging, skipped number", "type": "integer", "format": "int32" }, { "in": "query", "name": "$top", + "description": "for paging, item number in response", "type": "integer", "format": "int32" }, @@ -2085,12 +2102,14 @@ { "in": "query", "name": "$skip", + "description": "for paging, skipped number", "type": "integer", "format": "int32" }, { "in": "query", "name": "$top", + "description": "for paging, item number in response", "type": "integer", "format": "int32" } @@ -2325,12 +2344,14 @@ { "in": "query", "name": "$skip", + "description": "for paging, skipped number", "type": "integer", "format": "int32" }, { "in": "query", "name": "$top", + "description": "for paging, item number in response", "type": "integer", "format": "int32" }, @@ -2563,12 +2584,14 @@ { "in": "query", "name": "$skip", + "description": "for paging, skipped number", "type": "integer", "format": "int32" }, { "in": "query", "name": "$top", + "description": "for paging, item number in response", "type": "integer", "format": "int32" }, @@ -2647,12 +2670,14 @@ { "in": "query", "name": "$skip", + "description": "for paging, skipped number", "type": "integer", "format": "int32" }, { "in": "query", "name": "$top", + "description": "for paging, item number in response", "type": "integer", "format": "int32" }, @@ -2872,12 +2897,14 @@ { "in": "query", "name": "$skip", + "description": "for paging, skipped number", "type": "integer", "format": "int32" }, { "in": "query", "name": "$top", + "description": "for paging, item number in response", "type": "integer", "format": "int32" }, @@ -3197,7 +3224,11 @@ "OR", "XOR" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "AnomalyAlertingConfigurationLogicType", + "modelAsString": true + } }, "hookIds": { "description": "hook unique ids", @@ -3236,7 +3267,11 @@ "OR", "XOR" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "AnomalyAlertingConfigurationLogicType", + "modelAsString": true + } }, "hookIds": { "description": "hook unique ids", @@ -3362,7 +3397,11 @@ "Resolved" ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "AnomalyStatus", + "modelAsString": true + } } } }, @@ -3474,7 +3513,11 @@ "Resolved" ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "IncidentStatus", + "modelAsString": true + } } } }, @@ -3676,7 +3719,11 @@ "AND", "OR" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "AnomalyDetectionConfigurationLogicType", + "modelAsString": true + } }, "smartDetectionCondition": { "$ref": "#/definitions/SmartDetectionCondition" @@ -3704,7 +3751,11 @@ "AND", "OR" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "AnomalyDetectionConfigurationLogicType", + "modelAsString": true + } }, "smartDetectionCondition": { "$ref": "#/definitions/SmartDetectionCondition" @@ -3732,7 +3783,11 @@ "AND", "OR" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "AnomalyDetectionConfigurationLogicType", + "modelAsString": true + } }, "smartDetectionCondition": { "$ref": "#/definitions/SmartDetectionCondition" @@ -4366,7 +4421,11 @@ "Avg", "Count" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "RollUpMethod", + "modelAsString": true + } }, "rollUpColumns": { "description": "roll up columns", @@ -4446,7 +4505,11 @@ "Paused" ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "EntityStatus", + "modelAsString": true + } }, "createdTime": { "format": "date-time", @@ -5040,7 +5103,11 @@ "PostgreSql", "SqlServer" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } }, "dataFeedName": { "description": "data feed name", @@ -5086,7 +5153,11 @@ "NeedRollup", "AlreadyRollup" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "NeedRollupEnum", + "modelAsString": true + } }, "rollUpMethod": { "description": "roll up method", @@ -5098,7 +5169,11 @@ "Avg", "Count" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "RollUpMethod", + "modelAsString": true + } }, "rollUpColumns": { "description": "roll up columns", @@ -5120,7 +5195,11 @@ "CustomValue", "NoFilling" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "FillMissingPointType", + "modelAsString": true + } }, "fillMissingPointValue": { "format": "double", @@ -5133,7 +5212,11 @@ "Private", "Public" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "ViewMode", + "modelAsString": true + } }, "admins": { "description": "data feed administrator", @@ -5157,7 +5240,11 @@ "Active", "Paused" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "EntityStatus", + "modelAsString": true + } }, "actionLinkTemplate": { "description": "action link for alert", @@ -5887,7 +5974,11 @@ "Webhook", "Email" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "HookType", + "modelAsString": true + } }, "hookName": { "description": "hook unique name", From 22c185af5cad810137914abc0716722dcddc67b6 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Thu, 10 Dec 2020 19:28:12 +0800 Subject: [PATCH 05/35] rename to custom-words.txt and fix warnings --- .../MetricsAdvisor/{cSpell.txt => custom-words.txt} | 0 .../MetricsAdvisor/preview/v1.0/MetricsAdvisor.json | 6 +++--- 2 files changed, 3 insertions(+), 3 deletions(-) rename specification/cognitiveservices/data-plane/MetricsAdvisor/{cSpell.txt => custom-words.txt} (100%) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/cSpell.txt b/specification/cognitiveservices/data-plane/MetricsAdvisor/custom-words.txt similarity index 100% rename from specification/cognitiveservices/data-plane/MetricsAdvisor/cSpell.txt rename to specification/cognitiveservices/data-plane/MetricsAdvisor/custom-words.txt diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index 57df2255c334..48571794156f 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -3,7 +3,7 @@ "info": { "title": "Azure Cognitive Service Metrics Advisor REST API (OpenAPI v2)", "description": "Azure Cognitive Service Metrics Advisor REST API (OpenAPI v2)", - "version": "1.0" + "version": "1.20201210" }, "paths": { "/stats/latest": { @@ -4183,11 +4183,11 @@ }, "score": { "format": "double", - "description": "score", + "description": "score of the root cause", "type": "number" }, "description": { - "description": "description", + "description": "description of the root cause", "type": "string" } } From a4cb352ecc93d70e5eb9587ba2eae23379dc61d5 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Thu, 10 Dec 2020 19:34:24 +0800 Subject: [PATCH 06/35] try to mitigate spell issue --- .../MetricsAdvisor/{custom-words.txt => preview/v1.0/cSpell.txt} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename specification/cognitiveservices/data-plane/MetricsAdvisor/{custom-words.txt => preview/v1.0/cSpell.txt} (100%) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/custom-words.txt b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/cSpell.txt similarity index 100% rename from specification/cognitiveservices/data-plane/MetricsAdvisor/custom-words.txt rename to specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/cSpell.txt From 6eb86dcaa96c879b9397cacb2ab85f7507743e87 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Thu, 10 Dec 2020 19:38:41 +0800 Subject: [PATCH 07/35] try to mitigate spell issue --- .../MetricsAdvisor/preview/v1.0/{cSpell.txt => custom-words.txt} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/{cSpell.txt => custom-words.txt} (100%) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/cSpell.txt b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt similarity index 100% rename from specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/cSpell.txt rename to specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt From a658f39d50bac639a0693e478133f4ecfbbecfb3 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Fri, 11 Dec 2020 10:14:23 +0800 Subject: [PATCH 08/35] fix api version in swagger --- .../data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index 48571794156f..9ad34f1833a1 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -3,7 +3,7 @@ "info": { "title": "Azure Cognitive Service Metrics Advisor REST API (OpenAPI v2)", "description": "Azure Cognitive Service Metrics Advisor REST API (OpenAPI v2)", - "version": "1.20201210" + "version": "1.0" }, "paths": { "/stats/latest": { From 443576440c604f8241f0acebe9c2bfdebebf6891 Mon Sep 17 00:00:00 2001 From: Xiang Yan Date: Fri, 8 Jan 2021 09:24:25 -0800 Subject: [PATCH 09/35] Update MetricsAdvisor.json --- .../preview/v1.0/MetricsAdvisor.json | 52 +++++++++---------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index 9ad34f1833a1..8fa5fd9aa912 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -22,7 +22,7 @@ "schema": { "$ref": "#/definitions/UsageStats" }, - "examples": { + "x-ms-examples": { "application/json": { "timestamp": "2020-03-01T00:00:00Z", "activeSeriesCount": 100, @@ -67,7 +67,7 @@ "schema": { "$ref": "#/definitions/AnomalyAlertingConfiguration" }, - "examples": { + "x-ms-examples": { "application/json": { "anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001", "name": "alerting configuration name", @@ -297,7 +297,7 @@ "schema": { "$ref": "#/definitions/AlertResultList" }, - "examples": { + "x-ms-examples": { "application/json": { "value": [ { @@ -369,7 +369,7 @@ "schema": { "$ref": "#/definitions/AnomalyResultList" }, - "examples": { + "x-ms-examples": { "application/json": { "value": [ { @@ -450,7 +450,7 @@ "schema": { "$ref": "#/definitions/IncidentResultList" }, - "examples": { + "x-ms-examples": { "application/json": { "value": [ { @@ -512,7 +512,7 @@ "schema": { "$ref": "#/definitions/AnomalyDetectionConfiguration" }, - "examples": { + "x-ms-examples": { "application/json": { "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", "name": "Anomaly detection configuration name", @@ -778,7 +778,7 @@ "schema": { "$ref": "#/definitions/AnomalyAlertingConfigurationList" }, - "examples": { + "x-ms-examples": { "application/json": { "value": [ { @@ -881,7 +881,7 @@ "schema": { "$ref": "#/definitions/SeriesResultList" }, - "examples": { + "x-ms-examples": { "application/json": { "value": [ { @@ -978,7 +978,7 @@ "schema": { "$ref": "#/definitions/AnomalyResultList" }, - "examples": { + "x-ms-examples": { "application/json": { "value": [ { @@ -1064,7 +1064,7 @@ "schema": { "$ref": "#/definitions/AnomalyDimensionList" }, - "examples": { + "x-ms-examples": { "application/json": { "value": [ "Jewelry" @@ -1129,7 +1129,7 @@ "schema": { "$ref": "#/definitions/IncidentResultList" }, - "examples": { + "x-ms-examples": { "application/json": { "value": [ { @@ -1202,7 +1202,7 @@ "schema": { "$ref": "#/definitions/IncidentResultList" }, - "examples": { + "x-ms-examples": { "application/json": { "value": [ { @@ -1271,7 +1271,7 @@ "schema": { "$ref": "#/definitions/RootCauseList" }, - "examples": { + "x-ms-examples": { "application/json": { "value": [ { @@ -1402,7 +1402,7 @@ "schema": { "$ref": "#/definitions/DataFeedList" }, - "examples": { + "x-ms-examples": { "application/json": { "@nextLink": "https://localhost/dataFeeds?$skip=1&$top=1", "value": [ @@ -1541,7 +1541,7 @@ "schema": { "$ref": "#/definitions/DataFeedDetail" }, - "examples": { + "x-ms-examples": { "application/json": { "dataSourceParameter": { "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", @@ -1705,7 +1705,7 @@ "schema": { "$ref": "#/definitions/MetricFeedback" }, - "examples": { + "x-ms-examples": { "application/json": { "startTime": "2020-01-01T00:00:00Z", "endTime": "2020-01-01T00:00:00Z", @@ -1890,7 +1890,7 @@ "schema": { "$ref": "#/definitions/MetricFeedbackList" }, - "examples": { + "x-ms-examples": { "application/json": { "@nextLink": "https://localhost/feedback?$skip=1&$top=1", "value": [ @@ -2120,7 +2120,7 @@ "schema": { "$ref": "#/definitions/HookList" }, - "examples": { + "x-ms-examples": { "application/json": { "@nextLink": "https://localhost/hooks?$skip=1&$top=1", "value": [ @@ -2220,7 +2220,7 @@ "schema": { "$ref": "#/definitions/HookInfo" }, - "examples": { + "x-ms-examples": { "application/json": { "hookParameter": { "endpoint": "https://localhost/demo/post" @@ -2371,7 +2371,7 @@ "schema": { "$ref": "#/definitions/IngestionStatusList" }, - "examples": { + "x-ms-examples": { "application/json": { "@nextLink": "https://localhost/dataFeeds/01234567-8901-2345-6789-012345678901/ingestionStatus/query?$skip=2&$top=2", "value": [ @@ -2472,7 +2472,7 @@ "schema": { "$ref": "#/definitions/DataFeedIngestionProgress" }, - "examples": { + "x-ms-examples": { "application/json": { "latestSuccessTimestamp": "2020-01-30T00:00:00Z", "latestActiveTimestamp": "2020-01-31T00:00:00Z" @@ -2526,7 +2526,7 @@ "schema": { "$ref": "#/definitions/MetricDataList" }, - "examples": { + "x-ms-examples": { "application/json": { "value": [ { @@ -2611,7 +2611,7 @@ "schema": { "$ref": "#/definitions/MetricSeriesList" }, - "examples": { + "x-ms-examples": { "application/json": { "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/series/query?$skip=2&$top=2", "value": [ @@ -2697,7 +2697,7 @@ "schema": { "$ref": "#/definitions/MetricDimensionList" }, - "examples": { + "x-ms-examples": { "application/json": { "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/dimension/query?$skip=2&$top=2", "value": [ @@ -2745,7 +2745,7 @@ "schema": { "$ref": "#/definitions/AnomalyDetectionConfigurationList" }, - "examples": { + "x-ms-examples": { "application/json": { "value": [ { @@ -2924,7 +2924,7 @@ "schema": { "$ref": "#/definitions/EnrichmentStatusList" }, - "examples": { + "x-ms-examples": { "application/json": { "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/status/enrichment/anomalyDetection/query?$skip=2&$top=2", "value": [ From 3f6024d9f712af49b807e21847b10c0d76a26f6b Mon Sep 17 00:00:00 2001 From: Xiang Yan Date: Fri, 8 Jan 2021 11:04:15 -0800 Subject: [PATCH 10/35] Update MetricsAdvisor.json --- .../preview/v1.0/MetricsAdvisor.json | 104 ------------------ 1 file changed, 104 deletions(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index 8fa5fd9aa912..688acd86543e 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -4530,14 +4530,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4576,14 +4568,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4627,14 +4611,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4668,14 +4644,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4724,14 +4692,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4770,14 +4730,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4821,14 +4773,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4872,14 +4816,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4928,14 +4864,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4952,14 +4880,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4976,14 +4896,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -5000,14 +4912,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -5046,14 +4950,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { From 37a6608005be57cfd9e05e46bf97486f05cc654f Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Tue, 26 Jan 2021 17:08:10 +0800 Subject: [PATCH 11/35] try to fix swagger validation issue --- .../preview/v1.0/MetricsAdvisor.json | 821 ++++++++++++++---- 1 file changed, 673 insertions(+), 148 deletions(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index 9ad34f1833a1..df6a66b268b6 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -3,7 +3,7 @@ "info": { "title": "Azure Cognitive Service Metrics Advisor REST API (OpenAPI v2)", "description": "Azure Cognitive Service Metrics Advisor REST API (OpenAPI v2)", - "version": "1.0" + "version": "1.0-preview.20210126" }, "paths": { "/stats/latest": { @@ -38,6 +38,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Get latest usage stats": { + "$ref": "./examples/getActiveSeriesCount.json" + } } } }, @@ -125,6 +130,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Query a single anomaly alerting configuration": { + "$ref": "./examples/getAnomalyAlertingConfiguration.json" + } } }, "patch": { @@ -168,6 +178,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Update anomaly alerting configuration": { + "$ref": "./examples/updateAnomalyAlertingConfiguration.json" + } } }, "delete": { @@ -242,6 +257,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Create anomaly alerting configuration": { + "$ref": "./examples/createAnomalyAlertingConfiguration.json" + } } } }, @@ -319,6 +339,11 @@ }, "x-ms-pageable": { "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Query alerts under anomaly alerting configuration": { + "$ref": "./examples/getAlertsByAnomalyAlertingConfiguration.json" + } } } }, @@ -400,6 +425,11 @@ }, "x-ms-pageable": { "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Query anomalies under a specific alert": { + "$ref": "./examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json" + } } } }, @@ -483,6 +513,11 @@ }, "x-ms-pageable": { "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Query incidents under a specific alert": { + "$ref": "./examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json" + } } } }, @@ -632,6 +667,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Query a single anomaly detection configuration": { + "$ref": "./examples/getAnomalyDetectionConfiguration.json" + } } }, "patch": { @@ -675,6 +715,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Update anomaly detection configuration": { + "$ref": "./examples/updateAnomalyDetectionConfiguration.json" + } } }, "delete": { @@ -749,6 +794,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Create anomaly detection configuration": { + "$ref": "./examples/createAnomalyDetectionConfiguration.json" + } } } }, @@ -840,6 +890,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Query all anomaly alerting configurations for specific anomaly detection configuration": { + "$ref": "./examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json" + } } } }, @@ -923,6 +978,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Query series enriched by anomaly detection": { + "$ref": "./examples/getSeriesByAnomalyDetectionConfiguration.json" + } } } }, @@ -1009,6 +1069,11 @@ }, "x-ms-pageable": { "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Query anomalies under anomaly detection configuration": { + "$ref": "./examples/getAnomaliesByAnomalyDetectionConfiguration.json" + } } } }, @@ -1081,6 +1146,11 @@ }, "x-ms-pageable": { "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Query dimension values of anomalies": { + "$ref": "./examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json" + } } } }, @@ -1162,6 +1232,11 @@ }, "x-ms-pageable": { "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Query incidents under anomaly detection configuration": { + "$ref": "./examples/getIncidentsByAnomalyDetectionConfiguration.json" + } } }, "get": { @@ -1235,6 +1310,11 @@ }, "x-ms-pageable": { "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Query incidents under anomaly detection configuration": { + "$ref": "./examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json" + } } } }, @@ -1296,6 +1376,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Query root cause for incident": { + "$ref": "./examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json" + } } } }, @@ -1471,6 +1556,11 @@ }, "x-ms-pageable": { "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "List all data feeds": { + "$ref": "./examples/listDataFeeds.json" + } } }, "post": { @@ -1512,6 +1602,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Create a new data feed": { + "$ref": "./examples/createDataFeed.json" + } } } }, @@ -1602,6 +1697,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Get a data feed by its id": { + "$ref": "./examples/getDataFeedById.json" + } } }, "patch": { @@ -1645,6 +1745,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Update a data feed": { + "$ref": "./examples/updateDataFeed.json" + } } }, "delete": { @@ -1843,6 +1948,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Get a metric feedback by its id": { + "$ref": "./examples/getMetricFeedback.json" + } } } }, @@ -2036,6 +2146,11 @@ }, "x-ms-pageable": { "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "List feedback on the given metric": { + "$ref": "./examples/listMetricFeedbacks.json" + } } } }, @@ -2079,6 +2194,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Create a new metric feedback": { + "$ref": "./examples/createMetricFeedback.json" + } } } }, @@ -2150,6 +2270,11 @@ }, "x-ms-pageable": { "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "List all hooks": { + "$ref": "./examples/listHooks.json" + } } }, "post": { @@ -2191,6 +2316,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Create a new hook": { + "$ref": "./examples/createHook.json" + } } } }, @@ -2242,6 +2372,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Get a hook by its id": { + "$ref": "./examples/getHook.json" + } } }, "patch": { @@ -2285,6 +2420,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Update a hook": { + "$ref": "./examples/updateHook.json" + } } }, "delete": { @@ -2398,6 +2538,11 @@ }, "x-ms-pageable": { "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get data ingestion status by data feed": { + "$ref": "./examples/getDataFeedIngestionStatus.json" + } } } }, @@ -2443,6 +2588,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Reset data ingestion status by data feed to backfill data": { + "$ref": "./examples/resetDataFeedIngestionStatus.json" + } } } }, @@ -2485,6 +2635,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Get data last success ingestion job timestamp by data feed": { + "$ref": "./examples/getIngestionProgress.json" + } } } }, @@ -2556,6 +2711,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Get time series data from metric": { + "$ref": "./examples/getMetricData.json" + } } } }, @@ -2642,6 +2802,11 @@ }, "x-ms-pageable": { "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "List series (dimension combinations) from metric": { + "$ref": "./examples/getMetricSeries.json" + } } } }, @@ -2716,6 +2881,11 @@ }, "x-ms-pageable": { "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "List dimension from certain metric": { + "$ref": "./examples/getMetricDimension.json" + } } } }, @@ -2869,6 +3039,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-example": { + "Query all anomaly detection configurations for specific metric": { + "$ref": "./examples/getAnomalyDetectionConfigurationsByMetric.json" + } } } }, @@ -2951,6 +3126,11 @@ }, "x-ms-pageable": { "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Query anomaly detection status": { + "$ref": "./examples/getEnrichmentStatusByMetric.json" + } } } } @@ -3247,6 +3427,53 @@ "$ref": "#/definitions/MetricAlertingConfiguration" } } + }, + "example": { + "name": "alerting configuration name", + "crossMetricsOperator": "AND", + "hookIds": [ + "00000000-0000-0000-0000-000000000001" + ], + "metricAlertingConfigurations": [ + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "anomalyScopeType": "All", + "negationOperation": false, + "severityFilter": { + "minAlertSeverity": "Medium", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + } + }, + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002", + "anomalyScopeType": "Dimension", + "negationOperation": false, + "dimensionAnomalyScope": { + "dimension": { + "city": "Beijing" + } + }, + "severityFilter": { + "minAlertSeverity": "Low", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + }, + "valueFilter": { + "lower": 0.0, + "upper": 1000.0, + "direction": "Both" + } + } + ] } }, "AnomalyAlertingConfigurationPatch": { @@ -3290,6 +3517,54 @@ "$ref": "#/definitions/MetricAlertingConfiguration" } } + }, + "example": { + "name": "alerting configuration name", + "description": "this is an anomaly alerting configuration", + "crossMetricsOperator": "AND", + "hookIds": [ + "00000000-0000-0000-0000-000000000001" + ], + "metricAlertingConfigurations": [ + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "anomalyScopeType": "All", + "negationOperation": false, + "severityFilter": { + "minAlertSeverity": "Medium", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + } + }, + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002", + "anomalyScopeType": "Dimension", + "negationOperation": false, + "dimensionAnomalyScope": { + "dimension": { + "city": "Beijing" + } + }, + "severityFilter": { + "minAlertSeverity": "Low", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + }, + "valueFilter": { + "lower": 0.0, + "upper": 1000.0, + "direction": "Both" + } + } + ] } }, "AlertingResultQuery": { @@ -3323,6 +3598,11 @@ "modelAsString": true } } + }, + "example": { + "startTime": "2020-01-01T00:00:00Z", + "endTime": "2020-02-01T00:00:00Z", + "timeMode": "AnomalyTime" } }, "AlertResult": { @@ -3846,6 +4126,116 @@ "$ref": "#/definitions/SeriesConfiguration" } } + }, + "example": { + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "metricId": "22222222-2222-2222-2222-000000000001", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] } }, "AnomalyDetectionConfigurationPatch": { @@ -3878,6 +4268,115 @@ "$ref": "#/definitions/SeriesConfiguration" } } + }, + "example": { + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] } }, "AnomalyAlertingConfigurationList": { @@ -3920,6 +4419,18 @@ "$ref": "#/definitions/SeriesIdentity" } } + }, + "example": { + "startTime": "2020-01-01T00:00:00Z", + "endTime": "2020-02-01T00:00:00Z", + "series": [ + { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + } + ] } }, "SeriesResult": { @@ -4080,6 +4591,23 @@ "filter": { "$ref": "#/definitions/DetectionAnomalyFilterCondition" } + }, + "example": { + "startTime": "2020-01-01T00:00:00Z", + "endTime": "2020-02-01T00:00:00Z", + "filter": { + "dimensionFilter": [ + { + "dimension": { + "city": "Beijing" + } + } + ], + "severityFilter": { + "min": "Low", + "max": "High" + } + } } }, "AnomalyDimensionQuery": { @@ -4107,6 +4635,16 @@ "dimensionFilter": { "$ref": "#/definitions/DimensionGroupIdentity" } + }, + "example": { + "startTime": "2020-01-01T00:00:00Z", + "endTime": "2020-02-01T00:00:00Z", + "dimensionName": "category", + "dimensionFilter": { + "dimension": { + "city": "Beijing" + } + } } }, "AnomalyDimensionList": { @@ -4160,6 +4698,19 @@ "filter": { "$ref": "#/definitions/DetectionIncidentFilterCondition" } + }, + "example": { + "startTime": "2020-01-01T00:00:00Z", + "endTime": "2020-02-01T00:00:00Z", + "filter": { + "dimensionFilter": [ + { + "dimension": { + "city": "Beijing" + } + } + ] + } } }, "RootCause": { @@ -4522,7 +5073,49 @@ "type": "string" } }, - "discriminator": "dataSourceType" + "discriminator": "dataSourceType", + "example": { + "dataSourceParameter": { + "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", + "query": "select * from your_table where timestamp = @StartTime" + }, + "dataFeedName": "Sample - cost/revenue - city/category", + "dataFeedDescription": "This is a sample data feed.", + "granularityName": "Daily", + "metrics": [ + { + "metricName": "cost", + "metricDisplayName": "cost" + }, + { + "metricName": "revenue", + "metricDisplayName": "revenue" + } + ], + "dimension": [ + { + "dimensionName": "category", + "dimensionDisplayName": "category" + }, + { + "dimensionName": "city", + "dimensionDisplayName": "city" + } + ], + "timestampColumn": "timestamp", + "dataStartFrom": "2020-01-01T00:00:00Z", + "dataSourceType": "SqlServer", + "startOffsetInSeconds": 86400, + "maxConcurrency": 5, + "minRetryIntervalInSeconds": 3600, + "stopRetryAfterInSeconds": 604800, + "needRollup": "NeedRollup", + "rollUpMethod": "Sum", + "allUpIdentification": "__SUM__", + "fillMissingPointType": "SmartFilling", + "viewMode": "Private", + "isAdmin": false + } }, "AzureApplicationInsightsDataFeed": { "allOf": [ @@ -4530,14 +5123,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4576,14 +5161,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4627,14 +5204,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4668,14 +5237,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4724,14 +5285,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4770,14 +5323,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4821,14 +5366,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4872,14 +5409,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4928,14 +5457,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4952,14 +5473,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -4976,14 +5489,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -5000,14 +5505,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -5046,14 +5543,6 @@ "$ref": "#/definitions/DataFeedDetail" }, { - "required": [ - "dataFeedName", - "dataSourceParameter", - "dataSourceType", - "dataStartFrom", - "granularityName", - "metrics" - ], "type": "object", "properties": { "dataSourceParameter": { @@ -5443,7 +5932,13 @@ }, "x-ms-discriminator-value": "SqlServer" } - ] + ], + "example": { + "dataFeedName": "Sample - cost/revenue - city/category (modified)", + "viewers": [ + "viewer@company.example" + ] + } }, "MongoDBDataFeedPatch": { "allOf": [ @@ -5552,14 +6047,6 @@ "$ref": "#/definitions/MetricFeedback" }, { - "required": [ - "dimensionFilter", - "endTime", - "feedbackType", - "metricId", - "startTime", - "value" - ], "type": "object", "properties": { "startTime": { @@ -5586,7 +6073,22 @@ }, "x-ms-discriminator-value": "Anomaly" } - ] + ], + "example": { + "startTime": "2020-01-01T00:00:00Z", + "endTime": "2020-01-01T00:00:00Z", + "value": { + "anomalyValue": "NotAnomaly" + }, + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "metricId": "22222222-2222-2222-2222-000000000001", + "dimensionFilter": { + "dimension": { + "city": "Beijing" + } + }, + "feedbackType": "Anomaly" + } }, "ChangePointFeedbackValue": { "required": [ @@ -5614,14 +6116,6 @@ "$ref": "#/definitions/MetricFeedback" }, { - "required": [ - "dimensionFilter", - "endTime", - "feedbackType", - "metricId", - "startTime", - "value" - ], "type": "object", "properties": { "startTime": { @@ -5660,12 +6154,6 @@ "$ref": "#/definitions/MetricFeedback" }, { - "required": [ - "dimensionFilter", - "feedbackType", - "metricId", - "value" - ], "type": "object", "properties": { "startTime": { @@ -5719,12 +6207,6 @@ "$ref": "#/definitions/MetricFeedback" }, { - "required": [ - "dimensionFilter", - "feedbackType", - "metricId", - "value" - ], "type": "object", "properties": { "value": { @@ -5785,6 +6267,13 @@ "modelAsString": true } } + }, + "example": { + "metricId": "22222222-2222-2222-2222-000000000001", + "feedbackType": "Anomaly", + "startTime": "2020-01-01T00:00:00Z", + "endTime": "2020-01-01T00:00:00Z", + "timeMode": "MetricTimestamp" } }, "MetricFeedbackList": { @@ -5874,11 +6363,6 @@ "$ref": "#/definitions/HookInfo" }, { - "required": [ - "hookName", - "hookParameter", - "hookType" - ], "type": "object", "properties": { "hookParameter": { @@ -5930,11 +6414,6 @@ "$ref": "#/definitions/HookInfo" }, { - "required": [ - "hookName", - "hookParameter", - "hookType" - ], "type": "object", "properties": { "hookParameter": { @@ -5943,7 +6422,16 @@ }, "x-ms-discriminator-value": "Webhook" } - ] + ], + "example": { + "hookParameter": { + "endpoint": "https://localhost/demo/post" + }, + "hookName": "A webhook", + "hookType": "Webhook", + "description": "This is a webhook.", + "externalLink": "" + } }, "HookList": { "type": "object", @@ -6034,7 +6522,11 @@ }, "x-ms-discriminator-value": "Webhook" } - ] + ], + "example": { + "hookName": "A webhook (modified)", + "description": "This is a webhook. (modified)" + } }, "IngestionStatusQueryOptions": { "required": [ @@ -6053,6 +6545,10 @@ "description": "the end point of time range to query data ingestion status.", "type": "string" } + }, + "example": { + "startTime": "2020-01-01T00:00:00Z", + "endTime": "2020-02-01T00:00:00Z" } }, "IngestionStatus": { @@ -6123,6 +6619,10 @@ "description": "the end point of time range to reset data ingestion status.", "type": "string" } + }, + "example": { + "startTime": "2020-01-01T00:00:00Z", + "endTime": "2020-02-01T00:00:00Z" } }, "DataFeedIngestionProgress": { @@ -6170,6 +6670,16 @@ } } } + }, + "example": { + "startTime": "2020-01-01T00:00:00Z", + "endTime": "2020-02-01T00:00:00Z", + "series": [ + { + "category": "__SUM__", + "city": "Beijing" + } + ] } }, "MetricSeriesItem": { @@ -6250,6 +6760,14 @@ } } } + }, + "example": { + "activeSince": "2020-01-01T00:00:00Z", + "dimensionFilter": { + "city": [ + "Beijing" + ] + } } }, "MetricSeriesList": { @@ -6282,6 +6800,9 @@ "description": "dimension value to be filtered", "type": "string" } + }, + "example": { + "dimensionName": "city" } }, "MetricDimensionList": { @@ -6332,6 +6853,10 @@ "description": "the end point of time range to query anomaly detection status.", "type": "string" } + }, + "example": { + "startTime": "2020-01-01T00:00:00Z", + "endTime": "2020-02-01T00:00:00Z" } }, "EnrichmentStatus": { From 89bfae3f4d8ad6fbdef38d1df44a960dc5aef747 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Tue, 26 Jan 2021 17:10:57 +0800 Subject: [PATCH 12/35] try to fix validation issue --- .../preview/v1.0/MetricsAdvisor.json | 52 +++++++++---------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index ef8382d6acc5..df6a66b268b6 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -22,7 +22,7 @@ "schema": { "$ref": "#/definitions/UsageStats" }, - "x-ms-examples": { + "examples": { "application/json": { "timestamp": "2020-03-01T00:00:00Z", "activeSeriesCount": 100, @@ -72,7 +72,7 @@ "schema": { "$ref": "#/definitions/AnomalyAlertingConfiguration" }, - "x-ms-examples": { + "examples": { "application/json": { "anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001", "name": "alerting configuration name", @@ -317,7 +317,7 @@ "schema": { "$ref": "#/definitions/AlertResultList" }, - "x-ms-examples": { + "examples": { "application/json": { "value": [ { @@ -394,7 +394,7 @@ "schema": { "$ref": "#/definitions/AnomalyResultList" }, - "x-ms-examples": { + "examples": { "application/json": { "value": [ { @@ -480,7 +480,7 @@ "schema": { "$ref": "#/definitions/IncidentResultList" }, - "x-ms-examples": { + "examples": { "application/json": { "value": [ { @@ -547,7 +547,7 @@ "schema": { "$ref": "#/definitions/AnomalyDetectionConfiguration" }, - "x-ms-examples": { + "examples": { "application/json": { "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", "name": "Anomaly detection configuration name", @@ -828,7 +828,7 @@ "schema": { "$ref": "#/definitions/AnomalyAlertingConfigurationList" }, - "x-ms-examples": { + "examples": { "application/json": { "value": [ { @@ -936,7 +936,7 @@ "schema": { "$ref": "#/definitions/SeriesResultList" }, - "x-ms-examples": { + "examples": { "application/json": { "value": [ { @@ -1038,7 +1038,7 @@ "schema": { "$ref": "#/definitions/AnomalyResultList" }, - "x-ms-examples": { + "examples": { "application/json": { "value": [ { @@ -1129,7 +1129,7 @@ "schema": { "$ref": "#/definitions/AnomalyDimensionList" }, - "x-ms-examples": { + "examples": { "application/json": { "value": [ "Jewelry" @@ -1199,7 +1199,7 @@ "schema": { "$ref": "#/definitions/IncidentResultList" }, - "x-ms-examples": { + "examples": { "application/json": { "value": [ { @@ -1277,7 +1277,7 @@ "schema": { "$ref": "#/definitions/IncidentResultList" }, - "x-ms-examples": { + "examples": { "application/json": { "value": [ { @@ -1351,7 +1351,7 @@ "schema": { "$ref": "#/definitions/RootCauseList" }, - "x-ms-examples": { + "examples": { "application/json": { "value": [ { @@ -1487,7 +1487,7 @@ "schema": { "$ref": "#/definitions/DataFeedList" }, - "x-ms-examples": { + "examples": { "application/json": { "@nextLink": "https://localhost/dataFeeds?$skip=1&$top=1", "value": [ @@ -1636,7 +1636,7 @@ "schema": { "$ref": "#/definitions/DataFeedDetail" }, - "x-ms-examples": { + "examples": { "application/json": { "dataSourceParameter": { "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", @@ -1810,7 +1810,7 @@ "schema": { "$ref": "#/definitions/MetricFeedback" }, - "x-ms-examples": { + "examples": { "application/json": { "startTime": "2020-01-01T00:00:00Z", "endTime": "2020-01-01T00:00:00Z", @@ -2000,7 +2000,7 @@ "schema": { "$ref": "#/definitions/MetricFeedbackList" }, - "x-ms-examples": { + "examples": { "application/json": { "@nextLink": "https://localhost/feedback?$skip=1&$top=1", "value": [ @@ -2240,7 +2240,7 @@ "schema": { "$ref": "#/definitions/HookList" }, - "x-ms-examples": { + "examples": { "application/json": { "@nextLink": "https://localhost/hooks?$skip=1&$top=1", "value": [ @@ -2350,7 +2350,7 @@ "schema": { "$ref": "#/definitions/HookInfo" }, - "x-ms-examples": { + "examples": { "application/json": { "hookParameter": { "endpoint": "https://localhost/demo/post" @@ -2511,7 +2511,7 @@ "schema": { "$ref": "#/definitions/IngestionStatusList" }, - "x-ms-examples": { + "examples": { "application/json": { "@nextLink": "https://localhost/dataFeeds/01234567-8901-2345-6789-012345678901/ingestionStatus/query?$skip=2&$top=2", "value": [ @@ -2622,7 +2622,7 @@ "schema": { "$ref": "#/definitions/DataFeedIngestionProgress" }, - "x-ms-examples": { + "examples": { "application/json": { "latestSuccessTimestamp": "2020-01-30T00:00:00Z", "latestActiveTimestamp": "2020-01-31T00:00:00Z" @@ -2681,7 +2681,7 @@ "schema": { "$ref": "#/definitions/MetricDataList" }, - "x-ms-examples": { + "examples": { "application/json": { "value": [ { @@ -2771,7 +2771,7 @@ "schema": { "$ref": "#/definitions/MetricSeriesList" }, - "x-ms-examples": { + "examples": { "application/json": { "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/series/query?$skip=2&$top=2", "value": [ @@ -2862,7 +2862,7 @@ "schema": { "$ref": "#/definitions/MetricDimensionList" }, - "x-ms-examples": { + "examples": { "application/json": { "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/dimension/query?$skip=2&$top=2", "value": [ @@ -2915,7 +2915,7 @@ "schema": { "$ref": "#/definitions/AnomalyDetectionConfigurationList" }, - "x-ms-examples": { + "examples": { "application/json": { "value": [ { @@ -3099,7 +3099,7 @@ "schema": { "$ref": "#/definitions/EnrichmentStatusList" }, - "x-ms-examples": { + "examples": { "application/json": { "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/status/enrichment/anomalyDetection/query?$skip=2&$top=2", "value": [ From 7295764d55b49d3b2981f98cab50f8a189ec4536 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Tue, 26 Jan 2021 17:29:53 +0800 Subject: [PATCH 13/35] add examples --- .../createAnomalyAlertingConfiguration.json | 52 ++++++ .../createAnomalyDetectionConfiguration.json | 115 ++++++++++++++ .../preview/v1.0/examples/createDataFeed.json | 47 ++++++ .../preview/v1.0/examples/createHook.json | 14 ++ .../v1.0/examples/createMetricFeedback.json | 20 +++ .../v1.0/examples/getActiveSeriesCount.json | 15 ++ ...tAlertsByAnomalyAlertingConfiguration.json | 24 +++ ...maliesByAnomalyDetectionConfiguration.json | 45 ++++++ ...omAlertByAnomalyAlertingConfiguration.json | 27 ++++ .../getAnomalyAlertingConfiguration.json | 57 +++++++ ...ationsByAnomalyDetectionConfiguration.json | 61 +++++++ .../getAnomalyDetectionConfiguration.json | 119 ++++++++++++++ ...nomalyDetectionConfigurationsByMetric.json | 123 ++++++++++++++ .../v1.0/examples/getDataFeedById.json | 60 +++++++ .../examples/getDataFeedIngestionStatus.json | 28 ++++ ...maliesByAnomalyDetectionConfiguration.json | 24 +++ .../examples/getEnrichmentStatusByMetric.json | 28 ++++ .../preview/v1.0/examples/getHook.json | 21 +++ ...identsByAnomalyDetectionConfiguration.json | 43 +++++ ...nomalyDetectionConfigurationNextPages.json | 29 ++++ ...omAlertByAnomalyAlertingConfiguration.json | 29 ++++ .../v1.0/examples/getIngestionProgress.json | 12 ++ .../preview/v1.0/examples/getMetricData.json | 40 +++++ .../v1.0/examples/getMetricDimension.json | 19 +++ .../v1.0/examples/getMetricFeedback.json | 137 ++++++++++++++++ .../v1.0/examples/getMetricSeries.json | 36 +++++ ...cidentByAnomalyDetectionConfiguration.json | 24 +++ ...SeriesByAnomalyDetectionConfiguration.json | 54 +++++++ .../preview/v1.0/examples/listDataFeeds.json | 65 ++++++++ .../preview/v1.0/examples/listHooks.json | 26 +++ .../v1.0/examples/listMetricFeedbacks.json | 150 ++++++++++++++++++ .../resetDataFeedIngestionStatus.json | 9 ++ .../updateAnomalyAlertingConfiguration.json | 53 +++++++ .../updateAnomalyDetectionConfiguration.json | 114 +++++++++++++ .../preview/v1.0/examples/updateDataFeed.json | 11 ++ .../preview/v1.0/examples/updateHook.json | 9 ++ 36 files changed, 1740 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json new file mode 100644 index 000000000000..92c2d4345cec --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "body": { + "name": "alerting configuration name", + "crossMetricsOperator": "AND", + "hookIds": [ + "00000000-0000-0000-0000-000000000001" + ], + "metricAlertingConfigurations": [ + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "anomalyScopeType": "All", + "negationOperation": false, + "severityFilter": { + "minAlertSeverity": "Medium", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + } + }, + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002", + "anomalyScopeType": "Dimension", + "negationOperation": false, + "dimensionAnomalyScope": { + "dimension": { + "city": "Beijing" + } + }, + "severityFilter": { + "minAlertSeverity": "Low", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + }, + "valueFilter": { + "lower": 0.0, + "upper": 1000.0, + "direction": "Both" + } + } + ] + } + }, + "responses": {} +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json new file mode 100644 index 000000000000..d7b2e9907230 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "body": { + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "metricId": "22222222-2222-2222-2222-000000000001", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] + } + }, + "responses": {} +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json new file mode 100644 index 000000000000..fb98b894e196 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "body": { + "dataSourceParameter": { + "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", + "query": "select * from your_table where timestamp = @StartTime" + }, + "dataFeedName": "Sample - cost/revenue - city/category", + "dataFeedDescription": "This is a sample data feed.", + "granularityName": "Daily", + "metrics": [ + { + "metricName": "cost", + "metricDisplayName": "cost" + }, + { + "metricName": "revenue", + "metricDisplayName": "revenue" + } + ], + "dimension": [ + { + "dimensionName": "category", + "dimensionDisplayName": "category" + }, + { + "dimensionName": "city", + "dimensionDisplayName": "city" + } + ], + "timestampColumn": "timestamp", + "dataStartFrom": "2020-01-01T00:00:00.000Z", + "dataSourceType": "SqlServer", + "startOffsetInSeconds": 86400, + "maxConcurrency": 5, + "minRetryIntervalInSeconds": 3600, + "stopRetryAfterInSeconds": 604800, + "needRollup": "NeedRollup", + "rollUpMethod": "Sum", + "allUpIdentification": "__SUM__", + "fillMissingPointType": "SmartFilling", + "viewMode": "Private", + "isAdmin": false + } + }, + "responses": {} +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json new file mode 100644 index 000000000000..6d642642fc79 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "body": { + "hookParameter": { + "endpoint": "https://localhost/demo/post" + }, + "hookName": "A webhook", + "hookType": "Webhook", + "description": "This is a webhook.", + "externalLink": "" + } + }, + "responses": {} +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json new file mode 100644 index 000000000000..ba4741d64e24 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "body": { + "startTime": "2020-01-01T00:00:00.000Z", + "endTime": "2020-01-01T00:00:00.000Z", + "value": { + "anomalyValue": "NotAnomaly" + }, + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "metricId": "22222222-2222-2222-2222-000000000001", + "dimensionFilter": { + "dimension": { + "city": "Beijing" + } + }, + "feedbackType": "Anomaly" + } + }, + "responses": {} +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json new file mode 100644 index 000000000000..9361beacc14a --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json @@ -0,0 +1,15 @@ +{ + "parameters": {}, + "responses": { + "200": { + "headers": {}, + "body": { + "timestamp": "2020-03-01T00:00:00.000Z", + "activeSeriesCount": 100, + "allSeriesCount": 1000, + "metricsCount": 10, + "dataFeedCount": 5 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json new file mode 100644 index 000000000000..9105a017bcf4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "body": { + "startTime": "2020-01-01T00:00:00.000Z", + "endTime": "2020-02-01T00:00:00.000Z", + "timeMode": "AnomalyTime" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "alertId": "aaaaaaaaaaaa", + "timestamp": "2020-01-01T00:00:00.000Z", + "createdTime": "2020-03-01T00:00:00.000Z", + "modifiedTime": "2020-03-01T00:00:00.000Z" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json new file mode 100644 index 000000000000..01355c2476c4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "body": { + "startTime": "2020-01-01T00:00:00.000Z", + "endTime": "2020-02-01T00:00:00.000Z", + "filter": { + "dimensionFilter": [ + { + "dimension": { + "city": "Beijing" + } + } + ], + "severityFilter": { + "min": "Low", + "max": "High" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "timestamp": "2020-01-01T00:00:00.000Z", + "createdTime": "2020-03-01T00:00:00.000Z", + "modifiedTime": "2020-03-01T00:00:00.000Z", + "dimension": { + "category": "__SUM__", + "city": "Beijing" + }, + "property": { + "anomalySeverity": "High", + "anomalyStatus": "Active" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json new file mode 100644 index 000000000000..148a042d45ac --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json @@ -0,0 +1,27 @@ +{ + "parameters": {}, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "timestamp": "2020-01-01T00:00:00.000Z", + "createdTime": "2020-03-01T00:00:00.000Z", + "modifiedTime": "2020-03-01T00:00:00.000Z", + "dimension": { + "category": "__SUM__", + "city": "Beijing" + }, + "property": { + "anomalySeverity": "High", + "anomalyStatus": "Active" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json new file mode 100644 index 000000000000..c629e8fcfb43 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json @@ -0,0 +1,57 @@ +{ + "parameters": {}, + "responses": { + "200": { + "headers": {}, + "body": { + "anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001", + "name": "alerting configuration name", + "description": "this is an anomaly alerting configuration", + "crossMetricsOperator": "AND", + "hookIds": [ + "00000000-0000-0000-0000-000000000001" + ], + "metricAlertingConfigurations": [ + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "anomalyScopeType": "All", + "negationOperation": false, + "severityFilter": { + "minAlertSeverity": "Medium", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + } + }, + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002", + "anomalyScopeType": "Dimension", + "negationOperation": false, + "dimensionAnomalyScope": { + "dimension": { + "city": "Beijing" + } + }, + "severityFilter": { + "minAlertSeverity": "Low", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + }, + "valueFilter": { + "lower": 0.0, + "upper": 1000.0, + "direction": "Both" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json new file mode 100644 index 000000000000..1f25302d1f5d --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json @@ -0,0 +1,61 @@ +{ + "parameters": {}, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001", + "name": "alerting configuration name", + "description": "this is an anomaly alerting configuration", + "crossMetricsOperator": "AND", + "hookIds": [ + "00000000-0000-0000-0000-000000000001" + ], + "metricAlertingConfigurations": [ + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "anomalyScopeType": "All", + "negationOperation": false, + "severityFilter": { + "minAlertSeverity": "Medium", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + } + }, + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002", + "anomalyScopeType": "Dimension", + "negationOperation": false, + "dimensionAnomalyScope": { + "dimension": { + "city": "Beijing" + } + }, + "severityFilter": { + "minAlertSeverity": "Low", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + }, + "valueFilter": { + "lower": 0.0, + "upper": 1000.0, + "direction": "Both" + } + } + ] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json new file mode 100644 index 000000000000..ddacfa7bc578 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json @@ -0,0 +1,119 @@ +{ + "parameters": {}, + "responses": { + "200": { + "headers": {}, + "body": { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "metricId": "22222222-2222-2222-2222-000000000001", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json new file mode 100644 index 000000000000..e4e6f134ae7b --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json @@ -0,0 +1,123 @@ +{ + "parameters": {}, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "metricId": "22222222-2222-2222-2222-000000000001", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json new file mode 100644 index 000000000000..bb20a9b1ef09 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json @@ -0,0 +1,60 @@ +{ + "parameters": {}, + "responses": { + "200": { + "headers": {}, + "body": { + "dataSourceParameter": { + "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", + "query": "select * from your_table where timestamp = @StartTime" + }, + "dataFeedId": "11111111-1111-1111-1111-000000000001", + "dataFeedName": "Sample - cost/revenue - city/category", + "dataFeedDescription": "This is a sample data feed.", + "granularityName": "Daily", + "metrics": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "metricName": "cost", + "metricDisplayName": "cost" + }, + { + "metricId": "22222222-2222-2222-2222-000000000002", + "metricName": "revenue", + "metricDisplayName": "revenue" + } + ], + "dimension": [ + { + "dimensionName": "category", + "dimensionDisplayName": "category" + }, + { + "dimensionName": "city", + "dimensionDisplayName": "city" + } + ], + "timestampColumn": "timestamp", + "dataStartFrom": "2020-01-01T00:00:00.000Z", + "dataSourceType": "SqlServer", + "startOffsetInSeconds": 86400, + "maxConcurrency": 5, + "minRetryIntervalInSeconds": 3600, + "stopRetryAfterInSeconds": 604800, + "needRollup": "NeedRollup", + "rollUpMethod": "Sum", + "allUpIdentification": "__SUM__", + "fillMissingPointType": "SmartFilling", + "viewMode": "Private", + "admins": [ + "admin@company.example" + ], + "viewers": [], + "isAdmin": true, + "creator": "admin@company.example", + "status": "Active", + "createdTime": "2020-03-01T00:00:00.000Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json new file mode 100644 index 000000000000..8ad863050fa0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "body": { + "startTime": "2020-01-01T00:00:00.000Z", + "endTime": "2020-02-01T00:00:00.000Z" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "@nextLink": "https://localhost/dataFeeds/01234567-8901-2345-6789-012345678901/ingestionStatus/query?$skip=2&$top=2", + "value": [ + { + "timestamp": "2020-01-01T00:00:00.000Z", + "status": "Succeeded", + "message": "" + }, + { + "timestamp": "2020-01-02T00:00:00.000Z", + "status": "Succeeded", + "message": "" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json new file mode 100644 index 000000000000..441bfcbe5cb0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "body": { + "startTime": "2020-01-01T00:00:00.000Z", + "endTime": "2020-02-01T00:00:00.000Z", + "dimensionName": "category", + "dimensionFilter": { + "dimension": { + "city": "Beijing" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + "Jewelry" + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json new file mode 100644 index 000000000000..6cbb0c6a04e7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "body": { + "startTime": "2020-01-01T00:00:00.000Z", + "endTime": "2020-02-01T00:00:00.000Z" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/status/enrichment/anomalyDetection/query?$skip=2&$top=2", + "value": [ + { + "timestamp": "2020-01-01T00:00:00.000Z", + "status": "Succeeded", + "message": "" + }, + { + "timestamp": "2020-01-02T00:00:00.000Z", + "status": "Succeeded", + "message": "" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json new file mode 100644 index 000000000000..3f1ed3f91504 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json @@ -0,0 +1,21 @@ +{ + "parameters": {}, + "responses": { + "200": { + "headers": {}, + "body": { + "hookParameter": { + "endpoint": "https://localhost/demo/post" + }, + "hookId": "00000000-0000-0000-0000-000000000001", + "hookName": "A webhook", + "hookType": "Webhook", + "description": "This is a webhook.", + "externalLink": "", + "admins": [ + "admin@company.example" + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json new file mode 100644 index 000000000000..db04d1b3feba --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "body": { + "startTime": "2020-01-01T00:00:00.000Z", + "endTime": "2020-02-01T00:00:00.000Z", + "filter": { + "dimensionFilter": [ + { + "dimension": { + "city": "Beijing" + } + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "incidentId": "iiiiiiiiiiii", + "startTime": "2020-01-01T00:00:00.000Z", + "lastTime": "2020-02-01T00:00:00.000Z", + "rootNode": { + "dimension": { + "category": "__SUM__", + "city": "Beijing" + } + }, + "property": { + "maxSeverity": "High", + "incidentStatus": "Active" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json new file mode 100644 index 000000000000..a9e1bd859f1d --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json @@ -0,0 +1,29 @@ +{ + "parameters": {}, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "incidentId": "iiiiiiiiiiii", + "startTime": "2020-01-01T00:00:00.000Z", + "lastTime": "2020-02-01T00:00:00.000Z", + "rootNode": { + "dimension": { + "category": "__SUM__", + "city": "Beijing" + } + }, + "property": { + "maxSeverity": "High", + "incidentStatus": "Active" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json new file mode 100644 index 000000000000..a9e1bd859f1d --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json @@ -0,0 +1,29 @@ +{ + "parameters": {}, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "incidentId": "iiiiiiiiiiii", + "startTime": "2020-01-01T00:00:00.000Z", + "lastTime": "2020-02-01T00:00:00.000Z", + "rootNode": { + "dimension": { + "category": "__SUM__", + "city": "Beijing" + } + }, + "property": { + "maxSeverity": "High", + "incidentStatus": "Active" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json new file mode 100644 index 000000000000..da26f6b4a66d --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json @@ -0,0 +1,12 @@ +{ + "parameters": {}, + "responses": { + "200": { + "headers": {}, + "body": { + "latestSuccessTimestamp": "2020-01-30T00:00:00.000Z", + "latestActiveTimestamp": "2020-01-31T00:00:00.000Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json new file mode 100644 index 000000000000..1a0fa40bf963 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "body": { + "startTime": "2020-01-01T00:00:00.000Z", + "endTime": "2020-02-01T00:00:00.000Z", + "series": [ + { + "category": "__SUM__", + "city": "Beijing" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": { + "metricId": "22222222-2222-2222-2222-000000000001", + "dimension": { + "category": "__SUM__", + "city": "Beijing" + } + }, + "timestampList": [ + "2020-01-01T00:00:00.000Z", + "2020-01-02T00:00:00.000Z" + ], + "valueList": [ + 2.718281828459045, + 3.141592653589793 + ] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json new file mode 100644 index 000000000000..b9ae944905cc --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "body": { + "dimensionName": "city" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/dimension/query?$skip=2&$top=2", + "value": [ + "__SUM__", + "Beijing" + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json new file mode 100644 index 000000000000..91524fea205c --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json @@ -0,0 +1,137 @@ +{ + "parameters": {}, + "responses": { + "200": { + "headers": {}, + "body": { + "startTime": "2020-01-01T00:00:00.000Z", + "endTime": "2020-01-01T00:00:00.000Z", + "value": { + "anomalyValue": "NotAnomaly" + }, + "anomalyDetectionConfigurationId": "00000000-0000-0000-0000-000000000000", + "anomalyDetectionConfigurationSnapshot": { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "metricId": "22222222-2222-2222-2222-000000000001", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] + }, + "feedbackId": "99999999-9999-9999-9999-000000000001", + "createdTime": "2020-03-01T00:00:00.000Z", + "userPrincipal": "viewer@company.example", + "metricId": "22222222-2222-2222-2222-000000000001", + "dimensionFilter": { + "dimension": { + "city": "Beijing" + } + }, + "feedbackType": "Anomaly" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json new file mode 100644 index 000000000000..92f34f2dfcd0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "body": { + "activeSince": "2020-01-01T00:00:00.000Z", + "dimensionFilter": { + "city": [ + "Beijing" + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/series/query?$skip=2&$top=2", + "value": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "dimension": { + "category": "__SUM__", + "city": "Beijing" + } + }, + { + "metricId": "22222222-2222-2222-2222-000000000001", + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json new file mode 100644 index 000000000000..038e7b5a8a49 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json @@ -0,0 +1,24 @@ +{ + "parameters": {}, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "rootCause": { + "dimension": { + "city": "Beijing" + } + }, + "path": [ + "city" + ], + "score": 0.67, + "description": "city = Beijing contributes the most to this anomaly." + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json new file mode 100644 index 000000000000..c139c87b8a93 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "body": { + "startTime": "2020-01-01T00:00:00.000Z", + "endTime": "2020-02-01T00:00:00.000Z", + "series": [ + { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "timestampList": [ + "2020-01-01T00:00:00.000Z" + ], + "valueList": [ + 108.3 + ], + "isAnomalyList": [ + false + ], + "periodList": [ + 0 + ], + "expectedValueList": [ + 108.0 + ], + "lowerBoundaryList": [ + 100.1 + ], + "upperBoundaryList": [ + 112.8 + ] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json new file mode 100644 index 000000000000..73897234198f --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json @@ -0,0 +1,65 @@ +{ + "parameters": {}, + "responses": { + "200": { + "headers": {}, + "body": { + "@nextLink": "https://localhost/dataFeeds?$skip=1&$top=1", + "value": [ + { + "dataSourceParameter": { + "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", + "query": "select * from your_table where timestamp = @StartTime" + }, + "dataFeedId": "11111111-1111-1111-1111-000000000001", + "dataFeedName": "Sample - cost/revenue - city/category", + "dataFeedDescription": "This is a sample data feed.", + "granularityName": "Daily", + "metrics": [ + { + "metricId": "22222222-2222-2222-2222-000000000001", + "metricName": "cost", + "metricDisplayName": "cost" + }, + { + "metricId": "22222222-2222-2222-2222-000000000002", + "metricName": "revenue", + "metricDisplayName": "revenue" + } + ], + "dimension": [ + { + "dimensionName": "category", + "dimensionDisplayName": "category" + }, + { + "dimensionName": "city", + "dimensionDisplayName": "city" + } + ], + "timestampColumn": "timestamp", + "dataStartFrom": "2020-01-01T00:00:00.000Z", + "dataSourceType": "SqlServer", + "startOffsetInSeconds": 86400, + "maxConcurrency": 5, + "minRetryIntervalInSeconds": 3600, + "stopRetryAfterInSeconds": 604800, + "needRollup": "NeedRollup", + "rollUpMethod": "Sum", + "allUpIdentification": "__SUM__", + "fillMissingPointType": "SmartFilling", + "viewMode": "Private", + "admins": [ + "admin@company.example" + ], + "viewers": [], + "isAdmin": true, + "creator": "admin@company.example", + "status": "Active", + "createdTime": "2020-03-01T00:00:00.000Z" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json new file mode 100644 index 000000000000..b0a6a19a8857 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json @@ -0,0 +1,26 @@ +{ + "parameters": {}, + "responses": { + "200": { + "headers": {}, + "body": { + "@nextLink": "https://localhost/hooks?$skip=1&$top=1", + "value": [ + { + "hookParameter": { + "endpoint": "https://localhost/demo/post" + }, + "hookId": "00000000-0000-0000-0000-000000000001", + "hookName": "A webhook", + "hookType": "Webhook", + "description": "This is a webhook.", + "externalLink": "", + "admins": [ + "admin@company.example" + ] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json new file mode 100644 index 000000000000..cbf79001e000 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "body": { + "metricId": "22222222-2222-2222-2222-000000000001", + "feedbackType": "Anomaly", + "startTime": "2020-01-01T00:00:00.000Z", + "endTime": "2020-01-01T00:00:00.000Z", + "timeMode": "MetricTimestamp" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "@nextLink": "https://localhost/feedback?$skip=1&$top=1", + "value": [ + { + "startTime": "2020-01-01T00:00:00.000Z", + "endTime": "2020-01-01T00:00:00.000Z", + "value": { + "anomalyValue": "NotAnomaly" + }, + "anomalyDetectionConfigurationId": "00000000-0000-0000-0000-000000000000", + "anomalyDetectionConfigurationSnapshot": { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "metricId": "22222222-2222-2222-2222-000000000001", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] + }, + "feedbackId": "99999999-9999-9999-9999-000000000001", + "createdTime": "2020-03-01T00:00:00.000Z", + "userPrincipal": "viewer@company.example", + "metricId": "22222222-2222-2222-2222-000000000001", + "dimensionFilter": { + "dimension": { + "city": "Beijing" + } + }, + "feedbackType": "Anomaly" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json new file mode 100644 index 000000000000..0c70bbbe4ca1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "body": { + "startTime": "2020-01-01T00:00:00.000Z", + "endTime": "2020-02-01T00:00:00.000Z" + } + }, + "responses": {} +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json new file mode 100644 index 000000000000..3511f02a9639 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "body": { + "name": "alerting configuration name", + "description": "this is an anomaly alerting configuration", + "crossMetricsOperator": "AND", + "hookIds": [ + "00000000-0000-0000-0000-000000000001" + ], + "metricAlertingConfigurations": [ + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", + "anomalyScopeType": "All", + "negationOperation": false, + "severityFilter": { + "minAlertSeverity": "Medium", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + } + }, + { + "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002", + "anomalyScopeType": "Dimension", + "negationOperation": false, + "dimensionAnomalyScope": { + "dimension": { + "city": "Beijing" + } + }, + "severityFilter": { + "minAlertSeverity": "Low", + "maxAlertSeverity": "High" + }, + "snoozeFilter": { + "autoSnooze": 0, + "snoozeScope": "Series", + "onlyForSuccessive": true + }, + "valueFilter": { + "lower": 0.0, + "upper": 1000.0, + "direction": "Both" + } + } + ] + } + }, + "responses": {} +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json new file mode 100644 index 000000000000..cb4d5a696554 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "body": { + "name": "Anomaly detection configuration name", + "description": "Anomaly detection configuration description", + "wholeMetricConfiguration": { + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + }, + "dimensionGroupOverrideConfigurations": [ + { + "group": { + "dimension": { + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ], + "seriesOverrideConfigurations": [ + { + "series": { + "dimension": { + "category": "Jewelry", + "city": "Beijing" + } + }, + "conditionOperator": "AND", + "smartDetectionCondition": { + "sensitivity": 91.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "hardThresholdCondition": { + "lowerBound": 1.0, + "upperBound": 100.0, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + }, + "changeThresholdCondition": { + "changePercentage": 5.0, + "shiftPoint": 1, + "withinRange": false, + "anomalyDetectorDirection": "Both", + "suppressCondition": { + "minNumber": 1, + "minRatio": 100.0 + } + } + } + ] + } + }, + "responses": {} +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json new file mode 100644 index 000000000000..8c21e74391a9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "body": { + "dataFeedName": "Sample - cost/revenue - city/category (modified)", + "viewers": [ + "viewer@company.example" + ] + } + }, + "responses": {} +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json new file mode 100644 index 000000000000..057379cd73c1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "body": { + "hookName": "A webhook (modified)", + "description": "This is a webhook. (modified)" + } + }, + "responses": {} +} From f8497957a27ef33283c3c5d5e50acdca34b51c2e Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Tue, 26 Jan 2021 17:31:35 +0800 Subject: [PATCH 14/35] fix version --- .../data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index df6a66b268b6..14844de92825 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -3,7 +3,7 @@ "info": { "title": "Azure Cognitive Service Metrics Advisor REST API (OpenAPI v2)", "description": "Azure Cognitive Service Metrics Advisor REST API (OpenAPI v2)", - "version": "1.0-preview.20210126" + "version": "1.0" }, "paths": { "/stats/latest": { From 46fd3722f82f972700ac3355972bdb0c6af29fdb Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Tue, 26 Jan 2021 21:45:33 +0800 Subject: [PATCH 15/35] validate' --- .../data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt index d0292e5442b0..76ea4d3aaf3f 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt @@ -1 +1 @@ -metricsadvisor \ No newline at end of file +metricsadvisor From f374b964065ff50b7c3c75913570f8d5840d50f1 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Tue, 26 Jan 2021 22:25:05 +0800 Subject: [PATCH 16/35] remove examples in main spec --- .../preview/v1.0/MetricsAdvisor.json | 1036 ----------------- 1 file changed, 1036 deletions(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index 14844de92825..ddd02b974f3f 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -21,15 +21,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/UsageStats" - }, - "examples": { - "application/json": { - "timestamp": "2020-03-01T00:00:00Z", - "activeSeriesCount": 100, - "allSeriesCount": 1000, - "metricsCount": 10, - "dataFeedCount": 5 - } } }, "default": { @@ -71,57 +62,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/AnomalyAlertingConfiguration" - }, - "examples": { - "application/json": { - "anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001", - "name": "alerting configuration name", - "description": "this is an anomaly alerting configuration", - "crossMetricsOperator": "AND", - "hookIds": [ - "00000000-0000-0000-0000-000000000001" - ], - "metricAlertingConfigurations": [ - { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "anomalyScopeType": "All", - "negationOperation": false, - "severityFilter": { - "minAlertSeverity": "Medium", - "maxAlertSeverity": "High" - }, - "snoozeFilter": { - "autoSnooze": 0, - "snoozeScope": "Series", - "onlyForSuccessive": true - } - }, - { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002", - "anomalyScopeType": "Dimension", - "negationOperation": false, - "dimensionAnomalyScope": { - "dimension": { - "city": "Beijing" - } - }, - "severityFilter": { - "minAlertSeverity": "Low", - "maxAlertSeverity": "High" - }, - "snoozeFilter": { - "autoSnooze": 0, - "snoozeScope": "Series", - "onlyForSuccessive": true - }, - "valueFilter": { - "lower": 0.0, - "upper": 1000.0, - "direction": "Both" - } - } - ] - } } }, "default": { @@ -316,18 +256,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/AlertResultList" - }, - "examples": { - "application/json": { - "value": [ - { - "alertId": "aaaaaaaaaaaa", - "timestamp": "2020-01-01T00:00:00Z", - "createdTime": "2020-03-01T00:00:00Z", - "modifiedTime": "2020-03-01T00:00:00Z" - } - ] - } } }, "default": { @@ -393,27 +321,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/AnomalyResultList" - }, - "examples": { - "application/json": { - "value": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "timestamp": "2020-01-01T00:00:00Z", - "createdTime": "2020-03-01T00:00:00Z", - "modifiedTime": "2020-03-01T00:00:00Z", - "dimension": { - "category": "__SUM__", - "city": "Beijing" - }, - "property": { - "anomalySeverity": "High", - "anomalyStatus": "Active" - } - } - ] - } } }, "default": { @@ -479,29 +386,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/IncidentResultList" - }, - "examples": { - "application/json": { - "value": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "incidentId": "iiiiiiiiiiii", - "startTime": "2020-01-01T00:00:00Z", - "lastTime": "2020-02-01T00:00:00Z", - "rootNode": { - "dimension": { - "category": "__SUM__", - "city": "Beijing" - } - }, - "property": { - "maxSeverity": "High", - "incidentStatus": "Active" - } - } - ] - } } }, "default": { @@ -546,119 +430,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/AnomalyDetectionConfiguration" - }, - "examples": { - "application/json": { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "name": "Anomaly detection configuration name", - "description": "Anomaly detection configuration description", - "metricId": "22222222-2222-2222-2222-000000000001", - "wholeMetricConfiguration": { - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - }, - "dimensionGroupOverrideConfigurations": [ - { - "group": { - "dimension": { - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - } - ], - "seriesOverrideConfigurations": [ - { - "series": { - "dimension": { - "category": "Jewelry", - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - } - ] - } } }, "default": { @@ -827,61 +598,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/AnomalyAlertingConfigurationList" - }, - "examples": { - "application/json": { - "value": [ - { - "anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001", - "name": "alerting configuration name", - "description": "this is an anomaly alerting configuration", - "crossMetricsOperator": "AND", - "hookIds": [ - "00000000-0000-0000-0000-000000000001" - ], - "metricAlertingConfigurations": [ - { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "anomalyScopeType": "All", - "negationOperation": false, - "severityFilter": { - "minAlertSeverity": "Medium", - "maxAlertSeverity": "High" - }, - "snoozeFilter": { - "autoSnooze": 0, - "snoozeScope": "Series", - "onlyForSuccessive": true - } - }, - { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002", - "anomalyScopeType": "Dimension", - "negationOperation": false, - "dimensionAnomalyScope": { - "dimension": { - "city": "Beijing" - } - }, - "severityFilter": { - "minAlertSeverity": "Low", - "maxAlertSeverity": "High" - }, - "snoozeFilter": { - "autoSnooze": 0, - "snoozeScope": "Series", - "onlyForSuccessive": true - }, - "valueFilter": { - "lower": 0.0, - "upper": 1000.0, - "direction": "Both" - } - } - ] - } - ] - } } }, "default": { @@ -935,41 +651,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/SeriesResultList" - }, - "examples": { - "application/json": { - "value": [ - { - "series": { - "dimension": { - "category": "Jewelry", - "city": "Beijing" - } - }, - "timestampList": [ - "2020-01-01T00:00:00Z" - ], - "valueList": [ - 108.3 - ], - "isAnomalyList": [ - false - ], - "periodList": [ - 0 - ], - "expectedValueList": [ - 108.0 - ], - "lowerBoundaryList": [ - 100.1 - ], - "upperBoundaryList": [ - 112.8 - ] - } - ] - } } }, "default": { @@ -1037,27 +718,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/AnomalyResultList" - }, - "examples": { - "application/json": { - "value": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "timestamp": "2020-01-01T00:00:00Z", - "createdTime": "2020-03-01T00:00:00Z", - "modifiedTime": "2020-03-01T00:00:00Z", - "dimension": { - "category": "__SUM__", - "city": "Beijing" - }, - "property": { - "anomalySeverity": "High", - "anomalyStatus": "Active" - } - } - ] - } } }, "default": { @@ -1128,13 +788,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/AnomalyDimensionList" - }, - "examples": { - "application/json": { - "value": [ - "Jewelry" - ] - } } }, "default": { @@ -1198,29 +851,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/IncidentResultList" - }, - "examples": { - "application/json": { - "value": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "incidentId": "iiiiiiiiiiii", - "startTime": "2020-01-01T00:00:00Z", - "lastTime": "2020-02-01T00:00:00Z", - "rootNode": { - "dimension": { - "category": "__SUM__", - "city": "Beijing" - } - }, - "property": { - "maxSeverity": "High", - "incidentStatus": "Active" - } - } - ] - } } }, "default": { @@ -1276,29 +906,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/IncidentResultList" - }, - "examples": { - "application/json": { - "value": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "incidentId": "iiiiiiiiiiii", - "startTime": "2020-01-01T00:00:00Z", - "lastTime": "2020-02-01T00:00:00Z", - "rootNode": { - "dimension": { - "category": "__SUM__", - "city": "Beijing" - } - }, - "property": { - "maxSeverity": "High", - "incidentStatus": "Active" - } - } - ] - } } }, "default": { @@ -1350,24 +957,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/RootCauseList" - }, - "examples": { - "application/json": { - "value": [ - { - "rootCause": { - "dimension": { - "city": "Beijing" - } - }, - "path": [ - "city" - ], - "score": 0.67, - "description": "city = Beijing contributes the most to this anomaly." - } - ] - } } }, "default": { @@ -1486,65 +1075,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/DataFeedList" - }, - "examples": { - "application/json": { - "@nextLink": "https://localhost/dataFeeds?$skip=1&$top=1", - "value": [ - { - "dataSourceParameter": { - "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", - "query": "select * from your_table where timestamp = @StartTime" - }, - "dataFeedId": "11111111-1111-1111-1111-000000000001", - "dataFeedName": "Sample - cost/revenue - city/category", - "dataFeedDescription": "This is a sample data feed.", - "granularityName": "Daily", - "metrics": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "metricName": "cost", - "metricDisplayName": "cost" - }, - { - "metricId": "22222222-2222-2222-2222-000000000002", - "metricName": "revenue", - "metricDisplayName": "revenue" - } - ], - "dimension": [ - { - "dimensionName": "category", - "dimensionDisplayName": "category" - }, - { - "dimensionName": "city", - "dimensionDisplayName": "city" - } - ], - "timestampColumn": "timestamp", - "dataStartFrom": "2020-01-01T00:00:00Z", - "dataSourceType": "SqlServer", - "startOffsetInSeconds": 86400, - "maxConcurrency": 5, - "minRetryIntervalInSeconds": 3600, - "stopRetryAfterInSeconds": 604800, - "needRollup": "NeedRollup", - "rollUpMethod": "Sum", - "allUpIdentification": "__SUM__", - "fillMissingPointType": "SmartFilling", - "viewMode": "Private", - "admins": [ - "admin@company.example" - ], - "viewers": [], - "isAdmin": true, - "creator": "admin@company.example", - "status": "Active", - "createdTime": "2020-03-01T00:00:00Z" - } - ] - } } }, "default": { @@ -1635,60 +1165,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/DataFeedDetail" - }, - "examples": { - "application/json": { - "dataSourceParameter": { - "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", - "query": "select * from your_table where timestamp = @StartTime" - }, - "dataFeedId": "11111111-1111-1111-1111-000000000001", - "dataFeedName": "Sample - cost/revenue - city/category", - "dataFeedDescription": "This is a sample data feed.", - "granularityName": "Daily", - "metrics": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "metricName": "cost", - "metricDisplayName": "cost" - }, - { - "metricId": "22222222-2222-2222-2222-000000000002", - "metricName": "revenue", - "metricDisplayName": "revenue" - } - ], - "dimension": [ - { - "dimensionName": "category", - "dimensionDisplayName": "category" - }, - { - "dimensionName": "city", - "dimensionDisplayName": "city" - } - ], - "timestampColumn": "timestamp", - "dataStartFrom": "2020-01-01T00:00:00Z", - "dataSourceType": "SqlServer", - "startOffsetInSeconds": 86400, - "maxConcurrency": 5, - "minRetryIntervalInSeconds": 3600, - "stopRetryAfterInSeconds": 604800, - "needRollup": "NeedRollup", - "rollUpMethod": "Sum", - "allUpIdentification": "__SUM__", - "fillMissingPointType": "SmartFilling", - "viewMode": "Private", - "admins": [ - "admin@company.example" - ], - "viewers": [], - "isAdmin": true, - "creator": "admin@company.example", - "status": "Active", - "createdTime": "2020-03-01T00:00:00Z" - } } }, "default": { @@ -1809,137 +1285,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/MetricFeedback" - }, - "examples": { - "application/json": { - "startTime": "2020-01-01T00:00:00Z", - "endTime": "2020-01-01T00:00:00Z", - "value": { - "anomalyValue": "NotAnomaly" - }, - "anomalyDetectionConfigurationId": "00000000-0000-0000-0000-000000000000", - "anomalyDetectionConfigurationSnapshot": { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "name": "Anomaly detection configuration name", - "description": "Anomaly detection configuration description", - "metricId": "22222222-2222-2222-2222-000000000001", - "wholeMetricConfiguration": { - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - }, - "dimensionGroupOverrideConfigurations": [ - { - "group": { - "dimension": { - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - } - ], - "seriesOverrideConfigurations": [ - { - "series": { - "dimension": { - "category": "Jewelry", - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - } - ] - }, - "feedbackId": "99999999-9999-9999-9999-000000000001", - "createdTime": "2020-03-01T00:00:00Z", - "userPrincipal": "viewer@company.example", - "metricId": "22222222-2222-2222-2222-000000000001", - "dimensionFilter": { - "dimension": { - "city": "Beijing" - } - }, - "feedbackType": "Anomaly" - } } }, "default": { @@ -1999,142 +1344,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/MetricFeedbackList" - }, - "examples": { - "application/json": { - "@nextLink": "https://localhost/feedback?$skip=1&$top=1", - "value": [ - { - "startTime": "2020-01-01T00:00:00Z", - "endTime": "2020-01-01T00:00:00Z", - "value": { - "anomalyValue": "NotAnomaly" - }, - "anomalyDetectionConfigurationId": "00000000-0000-0000-0000-000000000000", - "anomalyDetectionConfigurationSnapshot": { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "name": "Anomaly detection configuration name", - "description": "Anomaly detection configuration description", - "metricId": "22222222-2222-2222-2222-000000000001", - "wholeMetricConfiguration": { - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - }, - "dimensionGroupOverrideConfigurations": [ - { - "group": { - "dimension": { - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - } - ], - "seriesOverrideConfigurations": [ - { - "series": { - "dimension": { - "category": "Jewelry", - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - } - ] - }, - "feedbackId": "99999999-9999-9999-9999-000000000001", - "createdTime": "2020-03-01T00:00:00Z", - "userPrincipal": "viewer@company.example", - "metricId": "22222222-2222-2222-2222-000000000001", - "dimensionFilter": { - "dimension": { - "city": "Beijing" - } - }, - "feedbackType": "Anomaly" - } - ] - } } }, "default": { @@ -2239,26 +1448,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/HookList" - }, - "examples": { - "application/json": { - "@nextLink": "https://localhost/hooks?$skip=1&$top=1", - "value": [ - { - "hookParameter": { - "endpoint": "https://localhost/demo/post" - }, - "hookId": "00000000-0000-0000-0000-000000000001", - "hookName": "A webhook", - "hookType": "Webhook", - "description": "This is a webhook.", - "externalLink": "", - "admins": [ - "admin@company.example" - ] - } - ] - } } }, "default": { @@ -2349,21 +1538,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/HookInfo" - }, - "examples": { - "application/json": { - "hookParameter": { - "endpoint": "https://localhost/demo/post" - }, - "hookId": "00000000-0000-0000-0000-000000000001", - "hookName": "A webhook", - "hookType": "Webhook", - "description": "This is a webhook.", - "externalLink": "", - "admins": [ - "admin@company.example" - ] - } } }, "default": { @@ -2510,23 +1684,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/IngestionStatusList" - }, - "examples": { - "application/json": { - "@nextLink": "https://localhost/dataFeeds/01234567-8901-2345-6789-012345678901/ingestionStatus/query?$skip=2&$top=2", - "value": [ - { - "timestamp": "2020-01-01T00:00:00Z", - "status": "Succeeded", - "message": "" - }, - { - "timestamp": "2020-01-02T00:00:00Z", - "status": "Succeeded", - "message": "" - } - ] - } } }, "default": { @@ -2621,12 +1778,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/DataFeedIngestionProgress" - }, - "examples": { - "application/json": { - "latestSuccessTimestamp": "2020-01-30T00:00:00Z", - "latestActiveTimestamp": "2020-01-31T00:00:00Z" - } } }, "default": { @@ -2680,29 +1831,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/MetricDataList" - }, - "examples": { - "application/json": { - "value": [ - { - "id": { - "metricId": "22222222-2222-2222-2222-000000000001", - "dimension": { - "category": "__SUM__", - "city": "Beijing" - } - }, - "timestampList": [ - "2020-01-01T00:00:00Z", - "2020-01-02T00:00:00Z" - ], - "valueList": [ - 2.718281828459045, - 3.141592653589793 - ] - } - ] - } } }, "default": { @@ -2770,27 +1898,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/MetricSeriesList" - }, - "examples": { - "application/json": { - "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/series/query?$skip=2&$top=2", - "value": [ - { - "metricId": "22222222-2222-2222-2222-000000000001", - "dimension": { - "category": "__SUM__", - "city": "Beijing" - } - }, - { - "metricId": "22222222-2222-2222-2222-000000000001", - "dimension": { - "category": "Jewelry", - "city": "Beijing" - } - } - ] - } } }, "default": { @@ -2861,15 +1968,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/MetricDimensionList" - }, - "examples": { - "application/json": { - "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/dimension/query?$skip=2&$top=2", - "value": [ - "__SUM__", - "Beijing" - ] - } } }, "default": { @@ -2914,123 +2012,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/AnomalyDetectionConfigurationList" - }, - "examples": { - "application/json": { - "value": [ - { - "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001", - "name": "Anomaly detection configuration name", - "description": "Anomaly detection configuration description", - "metricId": "22222222-2222-2222-2222-000000000001", - "wholeMetricConfiguration": { - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - }, - "dimensionGroupOverrideConfigurations": [ - { - "group": { - "dimension": { - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - } - ], - "seriesOverrideConfigurations": [ - { - "series": { - "dimension": { - "category": "Jewelry", - "city": "Beijing" - } - }, - "conditionOperator": "AND", - "smartDetectionCondition": { - "sensitivity": 91.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "hardThresholdCondition": { - "lowerBound": 1.0, - "upperBound": 100.0, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - }, - "changeThresholdCondition": { - "changePercentage": 5.0, - "shiftPoint": 1, - "withinRange": false, - "anomalyDetectorDirection": "Both", - "suppressCondition": { - "minNumber": 1, - "minRatio": 100.0 - } - } - } - ] - } - ] - } } }, "default": { @@ -3098,23 +2079,6 @@ "description": "Success", "schema": { "$ref": "#/definitions/EnrichmentStatusList" - }, - "examples": { - "application/json": { - "@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/status/enrichment/anomalyDetection/query?$skip=2&$top=2", - "value": [ - { - "timestamp": "2020-01-01T00:00:00Z", - "status": "Succeeded", - "message": "" - }, - { - "timestamp": "2020-01-02T00:00:00Z", - "status": "Succeeded", - "message": "" - } - ] - } } }, "default": { From b7cdf4e9ef8242d9fe27726ddfb3ac513fd1444e Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Tue, 26 Jan 2021 22:31:06 +0800 Subject: [PATCH 17/35] update examples --- .../examples/getAlertsByAnomalyAlertingConfiguration.json | 1 + .../getAnomaliesByAnomalyDetectionConfiguration.json | 1 + ...tAnomaliesFromAlertByAnomalyAlertingConfiguration.json | 5 ++++- .../v1.0/examples/getAnomalyAlertingConfiguration.json | 4 +++- ...tingConfigurationsByAnomalyDetectionConfiguration.json | 4 +++- .../v1.0/examples/getAnomalyDetectionConfiguration.json | 4 +++- .../getAnomalyDetectionConfigurationsByMetric.json | 4 +++- .../preview/v1.0/examples/getDataFeedById.json | 4 +++- .../preview/v1.0/examples/getDataFeedIngestionStatus.json | 1 + ...mensionOfAnomaliesByAnomalyDetectionConfiguration.json | 1 + .../v1.0/examples/getEnrichmentStatusByMetric.json | 1 + .../MetricsAdvisor/preview/v1.0/examples/getHook.json | 4 +++- .../getIncidentsByAnomalyDetectionConfiguration.json | 1 + ...IncidentsByAnomalyDetectionConfigurationNextPages.json | 4 +++- ...tIncidentsFromAlertByAnomalyAlertingConfiguration.json | 5 ++++- .../preview/v1.0/examples/getIngestionProgress.json | 4 +++- .../preview/v1.0/examples/getMetricData.json | 1 + .../preview/v1.0/examples/getMetricDimension.json | 1 + .../preview/v1.0/examples/getMetricFeedback.json | 4 +++- .../preview/v1.0/examples/getMetricSeries.json | 1 + ...ootCauseOfIncidentByAnomalyDetectionConfiguration.json | 5 ++++- .../getSeriesByAnomalyDetectionConfiguration.json | 1 + .../preview/v1.0/examples/listDataFeeds.json | 8 +++++++- .../MetricsAdvisor/preview/v1.0/examples/listHooks.json | 4 +++- .../v1.0/examples/resetDataFeedIngestionStatus.json | 1 + .../v1.0/examples/updateAnomalyAlertingConfiguration.json | 1 + .../examples/updateAnomalyDetectionConfiguration.json | 1 + .../preview/v1.0/examples/updateDataFeed.json | 1 + .../MetricsAdvisor/preview/v1.0/examples/updateHook.json | 1 + 29 files changed, 64 insertions(+), 14 deletions(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json index 9105a017bcf4..d319e64a5fd9 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json @@ -1,5 +1,6 @@ { "parameters": { + "configurationId": "44444444-4444-4444-4444-000000000001", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json index 01355c2476c4..8cdc34dd585a 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json @@ -1,5 +1,6 @@ { "parameters": { + "configurationId": "33333333-3333-3333-3333-000000000001", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json index 148a042d45ac..847d10bd7aaf 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json @@ -1,5 +1,8 @@ { - "parameters": {}, + "parameters": { + "configurationId": "44444444-4444-4444-4444-000000000001", + "alertId": "aaaaaaaaaaaa" + }, "responses": { "200": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json index c629e8fcfb43..f21923f843f2 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json @@ -1,5 +1,7 @@ { - "parameters": {}, + "parameters": { + "configurationId": "44444444-4444-4444-4444-000000000001" + }, "responses": { "200": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json index 1f25302d1f5d..658fa09bb80c 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json @@ -1,5 +1,7 @@ { - "parameters": {}, + "parameters": { + "configurationId": "33333333-3333-3333-3333-000000000001" + }, "responses": { "200": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json index ddacfa7bc578..9da9451215ff 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json @@ -1,5 +1,7 @@ { - "parameters": {}, + "parameters": { + "configurationId": "33333333-3333-3333-3333-000000000001" + }, "responses": { "200": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json index e4e6f134ae7b..4f245c25d8cd 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json @@ -1,5 +1,7 @@ { - "parameters": {}, + "parameters": { + "metricId": "22222222-2222-2222-2222-000000000001" + }, "responses": { "200": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json index bb20a9b1ef09..96bfd1568524 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json @@ -1,5 +1,7 @@ { - "parameters": {}, + "parameters": { + "dataFeedId": "01234567-8901-2345-6789-012345678901" + }, "responses": { "200": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json index 8ad863050fa0..be327b1a0eb8 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json @@ -1,5 +1,6 @@ { "parameters": { + "dataFeedId": "01234567-8901-2345-6789-012345678901", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z" diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json index 441bfcbe5cb0..df95cf41cf89 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json @@ -1,5 +1,6 @@ { "parameters": { + "configurationId": "33333333-3333-3333-3333-000000000001", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json index 6cbb0c6a04e7..1908ea25a235 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json @@ -1,5 +1,6 @@ { "parameters": { + "metricId": "22222222-2222-2222-2222-000000000001", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z" diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json index 3f1ed3f91504..3a1d04f4448d 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json @@ -1,5 +1,7 @@ { - "parameters": {}, + "parameters": { + "hookId": "01234567-8901-2345-6789-012345678901" + }, "responses": { "200": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json index db04d1b3feba..fd7af7feffaa 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json @@ -1,5 +1,6 @@ { "parameters": { + "configurationId": "33333333-3333-3333-3333-000000000001", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json index a9e1bd859f1d..179e86e5ac0c 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json @@ -1,5 +1,7 @@ { - "parameters": {}, + "parameters": { + "configurationId": "33333333-3333-3333-3333-000000000001" + }, "responses": { "200": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json index a9e1bd859f1d..fff7c833f5a6 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json @@ -1,5 +1,8 @@ { - "parameters": {}, + "parameters": { + "configurationId": "44444444-4444-4444-4444-000000000001", + "alertId": "aaaaaaaaaaaa" + }, "responses": { "200": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json index da26f6b4a66d..d7144c3692ec 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json @@ -1,5 +1,7 @@ { - "parameters": {}, + "parameters": { + "dataFeedId": "01234567-8901-2345-6789-012345678901" + }, "responses": { "200": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json index 1a0fa40bf963..09dfb6d532b1 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json @@ -1,5 +1,6 @@ { "parameters": { + "metricId": "22222222-2222-2222-2222-000000000001", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json index b9ae944905cc..f58fad19a5a2 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json @@ -1,5 +1,6 @@ { "parameters": { + "metricId": "22222222-2222-2222-2222-000000000001", "body": { "dimensionName": "city" } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json index 91524fea205c..10675111c0ee 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json @@ -1,5 +1,7 @@ { - "parameters": {}, + "parameters": { + "feedbackId": "99998888-7777-6666-5555-444433332222" + }, "responses": { "200": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json index 92f34f2dfcd0..e579c015e1eb 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json @@ -1,5 +1,6 @@ { "parameters": { + "metricId": "22222222-2222-2222-2222-000000000001", "body": { "activeSince": "2020-01-01T00:00:00.000Z", "dimensionFilter": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json index 038e7b5a8a49..aae30c6cc3d8 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json @@ -1,5 +1,8 @@ { - "parameters": {}, + "parameters": { + "configurationId": "33333333-3333-3333-3333-000000000001", + "incidentId": "iiiiiiiiiiii" + }, "responses": { "200": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json index c139c87b8a93..afe42bc4e9b9 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json @@ -1,5 +1,6 @@ { "parameters": { + "configurationId": "33333333-3333-3333-3333-000000000001", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json index 73897234198f..ed55623f2037 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json @@ -1,5 +1,11 @@ { - "parameters": {}, + "parameters": { + "dataFeedName": "name_prefix", + "dataSourceType": "SqlServer", + "granularityName": "Daily", + "status": "Active", + "creator": "demo@microsoft.com" + }, "responses": { "200": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json index b0a6a19a8857..f733cf5ce1ee 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json @@ -1,5 +1,7 @@ { - "parameters": {}, + "parameters": { + "hookName": "name_prefix" + }, "responses": { "200": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json index 0c70bbbe4ca1..6df63749c099 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json @@ -1,5 +1,6 @@ { "parameters": { + "dataFeedId": "01234567-8901-2345-6789-012345678901", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z" diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json index 3511f02a9639..09dce29d97b4 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json @@ -1,5 +1,6 @@ { "parameters": { + "configurationId": "44444444-4444-4444-4444-000000000001", "body": { "name": "alerting configuration name", "description": "this is an anomaly alerting configuration", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json index cb4d5a696554..13e90de59c3e 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json @@ -1,5 +1,6 @@ { "parameters": { + "configurationId": "33333333-3333-3333-3333-000000000001", "body": { "name": "Anomaly detection configuration name", "description": "Anomaly detection configuration description", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json index 8c21e74391a9..b064a45586c6 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json @@ -1,5 +1,6 @@ { "parameters": { + "dataFeedId": "01234567-8901-2345-6789-012345678901", "body": { "dataFeedName": "Sample - cost/revenue - city/category (modified)", "viewers": [ diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json index 057379cd73c1..3f907e54e00d 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json @@ -1,5 +1,6 @@ { "parameters": { + "hookId": "01234567-8901-2345-6789-012345678901", "body": { "hookName": "A webhook (modified)", "description": "This is a webhook. (modified)" From 2d436e964f672670612c31ce6aa2d64d4d202f51 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Tue, 26 Jan 2021 22:48:20 +0800 Subject: [PATCH 18/35] rename request body param name in examples --- .../v1.0/examples/createAnomalyAlertingConfiguration.json | 2 +- .../v1.0/examples/createAnomalyDetectionConfiguration.json | 2 +- .../MetricsAdvisor/preview/v1.0/examples/createDataFeed.json | 2 +- .../MetricsAdvisor/preview/v1.0/examples/createHook.json | 2 +- .../preview/v1.0/examples/createMetricFeedback.json | 2 +- .../v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json | 2 +- .../examples/getAnomaliesByAnomalyDetectionConfiguration.json | 2 +- .../preview/v1.0/examples/getDataFeedIngestionStatus.json | 2 +- .../getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json | 2 +- .../preview/v1.0/examples/getEnrichmentStatusByMetric.json | 2 +- .../examples/getIncidentsByAnomalyDetectionConfiguration.json | 2 +- .../MetricsAdvisor/preview/v1.0/examples/getMetricData.json | 2 +- .../preview/v1.0/examples/getMetricDimension.json | 2 +- .../MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json | 2 +- .../v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json | 2 +- .../preview/v1.0/examples/listMetricFeedbacks.json | 2 +- .../preview/v1.0/examples/resetDataFeedIngestionStatus.json | 2 +- .../v1.0/examples/updateAnomalyAlertingConfiguration.json | 2 +- .../v1.0/examples/updateAnomalyDetectionConfiguration.json | 2 +- .../MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json | 2 +- .../MetricsAdvisor/preview/v1.0/examples/updateHook.json | 2 +- 21 files changed, 21 insertions(+), 21 deletions(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json index 92c2d4345cec..ea5d45ae8978 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json @@ -1,6 +1,6 @@ { "parameters": { - "body": { + "AnomalyAlertingConfiguration": { "name": "alerting configuration name", "crossMetricsOperator": "AND", "hookIds": [ diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json index d7b2e9907230..62775c4cea33 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json @@ -1,6 +1,6 @@ { "parameters": { - "body": { + "AnomalyDetectionConfiguration": { "name": "Anomaly detection configuration name", "description": "Anomaly detection configuration description", "metricId": "22222222-2222-2222-2222-000000000001", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json index fb98b894e196..b76c3346d2a7 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json @@ -1,6 +1,6 @@ { "parameters": { - "body": { + "DataFeedDetail": { "dataSourceParameter": { "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", "query": "select * from your_table where timestamp = @StartTime" diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json index 6d642642fc79..7e5700a264bd 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json @@ -1,6 +1,6 @@ { "parameters": { - "body": { + "HookInfo": { "hookParameter": { "endpoint": "https://localhost/demo/post" }, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json index ba4741d64e24..08ee455e1989 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json @@ -1,6 +1,6 @@ { "parameters": { - "body": { + "MetricFeedback": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-01-01T00:00:00.000Z", "value": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json index d319e64a5fd9..7abd864b30a5 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json @@ -1,7 +1,7 @@ { "parameters": { "configurationId": "44444444-4444-4444-4444-000000000001", - "body": { + "AlertingResultQuery": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", "timeMode": "AnomalyTime" diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json index 8cdc34dd585a..64788461ee74 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json @@ -1,7 +1,7 @@ { "parameters": { "configurationId": "33333333-3333-3333-3333-000000000001", - "body": { + "DetectionAnomalyResultQuery": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", "filter": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json index be327b1a0eb8..cde7aec50592 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json @@ -1,7 +1,7 @@ { "parameters": { "dataFeedId": "01234567-8901-2345-6789-012345678901", - "body": { + "IngestionStatusQueryOptions": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z" } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json index df95cf41cf89..749495248951 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json @@ -1,7 +1,7 @@ { "parameters": { "configurationId": "33333333-3333-3333-3333-000000000001", - "body": { + "AnomalyDimensionQuery": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", "dimensionName": "category", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json index 1908ea25a235..57b96d64c49b 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json @@ -1,7 +1,7 @@ { "parameters": { "metricId": "22222222-2222-2222-2222-000000000001", - "body": { + "EnrichmentStatusQueryOption": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z" } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json index fd7af7feffaa..96f3c9189642 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json @@ -1,7 +1,7 @@ { "parameters": { "configurationId": "33333333-3333-3333-3333-000000000001", - "body": { + "DetectionIncidentResultQuery": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", "filter": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json index 09dfb6d532b1..c0e90b8fa16f 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json @@ -1,7 +1,7 @@ { "parameters": { "metricId": "22222222-2222-2222-2222-000000000001", - "body": { + "MetricDataQueryOptions": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", "series": [ diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json index f58fad19a5a2..3cd14aa4b2be 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json @@ -1,7 +1,7 @@ { "parameters": { "metricId": "22222222-2222-2222-2222-000000000001", - "body": { + "MetricDimensionQueryOptions": { "dimensionName": "city" } }, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json index e579c015e1eb..5ae0c9e23c71 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json @@ -1,7 +1,7 @@ { "parameters": { "metricId": "22222222-2222-2222-2222-000000000001", - "body": { + "MetricSeriesQueryOptions": { "activeSince": "2020-01-01T00:00:00.000Z", "dimensionFilter": { "city": [ diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json index afe42bc4e9b9..9b5a81d084f9 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json @@ -1,7 +1,7 @@ { "parameters": { "configurationId": "33333333-3333-3333-3333-000000000001", - "body": { + "DetectionSeriesQuery": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", "series": [ diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json index cbf79001e000..620b50126938 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json @@ -1,6 +1,6 @@ { "parameters": { - "body": { + "MetricFeedbackFilter": { "metricId": "22222222-2222-2222-2222-000000000001", "feedbackType": "Anomaly", "startTime": "2020-01-01T00:00:00.000Z", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json index 6df63749c099..2aaed693218d 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json @@ -1,7 +1,7 @@ { "parameters": { "dataFeedId": "01234567-8901-2345-6789-012345678901", - "body": { + "IngestionProgressResetOptions": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z" } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json index 09dce29d97b4..f6bb2153a8da 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json @@ -1,7 +1,7 @@ { "parameters": { "configurationId": "44444444-4444-4444-4444-000000000001", - "body": { + "AnomalyAlertingConfigurationPatch": { "name": "alerting configuration name", "description": "this is an anomaly alerting configuration", "crossMetricsOperator": "AND", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json index 13e90de59c3e..091f31254072 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json @@ -1,7 +1,7 @@ { "parameters": { "configurationId": "33333333-3333-3333-3333-000000000001", - "body": { + "AnomalyDetectionConfigurationPatch": { "name": "Anomaly detection configuration name", "description": "Anomaly detection configuration description", "wholeMetricConfiguration": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json index b064a45586c6..3a84c82684fd 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json @@ -1,7 +1,7 @@ { "parameters": { "dataFeedId": "01234567-8901-2345-6789-012345678901", - "body": { + "DataFeedDetailPatch": { "dataFeedName": "Sample - cost/revenue - city/category (modified)", "viewers": [ "viewer@company.example" diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json index 3f907e54e00d..76f6b9b8efb6 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json @@ -1,7 +1,7 @@ { "parameters": { "hookId": "01234567-8901-2345-6789-012345678901", - "body": { + "HookInfoPatch": { "hookName": "A webhook (modified)", "description": "This is a webhook. (modified)" } From b3ca61c8ca38fda0cf37eb66e7cb0f75e047574c Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Tue, 26 Jan 2021 22:56:29 +0800 Subject: [PATCH 19/35] revert renaming req body name param in examples --- .../v1.0/examples/createAnomalyAlertingConfiguration.json | 2 +- .../v1.0/examples/createAnomalyDetectionConfiguration.json | 2 +- .../MetricsAdvisor/preview/v1.0/examples/createDataFeed.json | 2 +- .../MetricsAdvisor/preview/v1.0/examples/createHook.json | 2 +- .../preview/v1.0/examples/createMetricFeedback.json | 2 +- .../v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json | 2 +- .../examples/getAnomaliesByAnomalyDetectionConfiguration.json | 2 +- .../preview/v1.0/examples/getDataFeedIngestionStatus.json | 2 +- .../getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json | 2 +- .../preview/v1.0/examples/getEnrichmentStatusByMetric.json | 2 +- .../examples/getIncidentsByAnomalyDetectionConfiguration.json | 2 +- .../MetricsAdvisor/preview/v1.0/examples/getMetricData.json | 2 +- .../preview/v1.0/examples/getMetricDimension.json | 2 +- .../MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json | 2 +- .../v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json | 2 +- .../preview/v1.0/examples/listMetricFeedbacks.json | 2 +- .../preview/v1.0/examples/resetDataFeedIngestionStatus.json | 2 +- .../v1.0/examples/updateAnomalyAlertingConfiguration.json | 2 +- .../v1.0/examples/updateAnomalyDetectionConfiguration.json | 2 +- .../MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json | 2 +- .../MetricsAdvisor/preview/v1.0/examples/updateHook.json | 2 +- 21 files changed, 21 insertions(+), 21 deletions(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json index ea5d45ae8978..92c2d4345cec 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json @@ -1,6 +1,6 @@ { "parameters": { - "AnomalyAlertingConfiguration": { + "body": { "name": "alerting configuration name", "crossMetricsOperator": "AND", "hookIds": [ diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json index 62775c4cea33..d7b2e9907230 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json @@ -1,6 +1,6 @@ { "parameters": { - "AnomalyDetectionConfiguration": { + "body": { "name": "Anomaly detection configuration name", "description": "Anomaly detection configuration description", "metricId": "22222222-2222-2222-2222-000000000001", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json index b76c3346d2a7..fb98b894e196 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json @@ -1,6 +1,6 @@ { "parameters": { - "DataFeedDetail": { + "body": { "dataSourceParameter": { "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", "query": "select * from your_table where timestamp = @StartTime" diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json index 7e5700a264bd..6d642642fc79 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json @@ -1,6 +1,6 @@ { "parameters": { - "HookInfo": { + "body": { "hookParameter": { "endpoint": "https://localhost/demo/post" }, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json index 08ee455e1989..ba4741d64e24 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json @@ -1,6 +1,6 @@ { "parameters": { - "MetricFeedback": { + "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-01-01T00:00:00.000Z", "value": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json index 7abd864b30a5..d319e64a5fd9 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json @@ -1,7 +1,7 @@ { "parameters": { "configurationId": "44444444-4444-4444-4444-000000000001", - "AlertingResultQuery": { + "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", "timeMode": "AnomalyTime" diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json index 64788461ee74..8cdc34dd585a 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json @@ -1,7 +1,7 @@ { "parameters": { "configurationId": "33333333-3333-3333-3333-000000000001", - "DetectionAnomalyResultQuery": { + "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", "filter": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json index cde7aec50592..be327b1a0eb8 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json @@ -1,7 +1,7 @@ { "parameters": { "dataFeedId": "01234567-8901-2345-6789-012345678901", - "IngestionStatusQueryOptions": { + "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z" } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json index 749495248951..df95cf41cf89 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json @@ -1,7 +1,7 @@ { "parameters": { "configurationId": "33333333-3333-3333-3333-000000000001", - "AnomalyDimensionQuery": { + "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", "dimensionName": "category", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json index 57b96d64c49b..1908ea25a235 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json @@ -1,7 +1,7 @@ { "parameters": { "metricId": "22222222-2222-2222-2222-000000000001", - "EnrichmentStatusQueryOption": { + "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z" } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json index 96f3c9189642..fd7af7feffaa 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json @@ -1,7 +1,7 @@ { "parameters": { "configurationId": "33333333-3333-3333-3333-000000000001", - "DetectionIncidentResultQuery": { + "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", "filter": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json index c0e90b8fa16f..09dfb6d532b1 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json @@ -1,7 +1,7 @@ { "parameters": { "metricId": "22222222-2222-2222-2222-000000000001", - "MetricDataQueryOptions": { + "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", "series": [ diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json index 3cd14aa4b2be..f58fad19a5a2 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json @@ -1,7 +1,7 @@ { "parameters": { "metricId": "22222222-2222-2222-2222-000000000001", - "MetricDimensionQueryOptions": { + "body": { "dimensionName": "city" } }, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json index 5ae0c9e23c71..e579c015e1eb 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json @@ -1,7 +1,7 @@ { "parameters": { "metricId": "22222222-2222-2222-2222-000000000001", - "MetricSeriesQueryOptions": { + "body": { "activeSince": "2020-01-01T00:00:00.000Z", "dimensionFilter": { "city": [ diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json index 9b5a81d084f9..afe42bc4e9b9 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json @@ -1,7 +1,7 @@ { "parameters": { "configurationId": "33333333-3333-3333-3333-000000000001", - "DetectionSeriesQuery": { + "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", "series": [ diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json index 620b50126938..cbf79001e000 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json @@ -1,6 +1,6 @@ { "parameters": { - "MetricFeedbackFilter": { + "body": { "metricId": "22222222-2222-2222-2222-000000000001", "feedbackType": "Anomaly", "startTime": "2020-01-01T00:00:00.000Z", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json index 2aaed693218d..6df63749c099 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json @@ -1,7 +1,7 @@ { "parameters": { "dataFeedId": "01234567-8901-2345-6789-012345678901", - "IngestionProgressResetOptions": { + "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z" } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json index f6bb2153a8da..09dce29d97b4 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json @@ -1,7 +1,7 @@ { "parameters": { "configurationId": "44444444-4444-4444-4444-000000000001", - "AnomalyAlertingConfigurationPatch": { + "body": { "name": "alerting configuration name", "description": "this is an anomaly alerting configuration", "crossMetricsOperator": "AND", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json index 091f31254072..13e90de59c3e 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json @@ -1,7 +1,7 @@ { "parameters": { "configurationId": "33333333-3333-3333-3333-000000000001", - "AnomalyDetectionConfigurationPatch": { + "body": { "name": "Anomaly detection configuration name", "description": "Anomaly detection configuration description", "wholeMetricConfiguration": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json index 3a84c82684fd..b064a45586c6 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json @@ -1,7 +1,7 @@ { "parameters": { "dataFeedId": "01234567-8901-2345-6789-012345678901", - "DataFeedDetailPatch": { + "body": { "dataFeedName": "Sample - cost/revenue - city/category (modified)", "viewers": [ "viewer@company.example" diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json index 76f6b9b8efb6..3f907e54e00d 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json @@ -1,7 +1,7 @@ { "parameters": { "hookId": "01234567-8901-2345-6789-012345678901", - "HookInfoPatch": { + "body": { "hookName": "A webhook (modified)", "description": "This is a webhook. (modified)" } From 5d5af50bc2cbfb4fbf2211e4c3432f23f0d0a2f2 Mon Sep 17 00:00:00 2001 From: Xiang Yan Date: Tue, 26 Jan 2021 09:05:46 -0800 Subject: [PATCH 20/35] Update MetricsAdvisor.json --- .../preview/v1.0/MetricsAdvisor.json | 72 +++++++++---------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index ddd02b974f3f..e855060213e6 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -30,7 +30,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Get latest usage stats": { "$ref": "./examples/getActiveSeriesCount.json" } @@ -71,7 +71,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Query a single anomaly alerting configuration": { "$ref": "./examples/getAnomalyAlertingConfiguration.json" } @@ -119,7 +119,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Update anomaly alerting configuration": { "$ref": "./examples/updateAnomalyAlertingConfiguration.json" } @@ -198,7 +198,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Create anomaly alerting configuration": { "$ref": "./examples/createAnomalyAlertingConfiguration.json" } @@ -268,7 +268,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query alerts under anomaly alerting configuration": { "$ref": "./examples/getAlertsByAnomalyAlertingConfiguration.json" } @@ -333,7 +333,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query anomalies under a specific alert": { "$ref": "./examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json" } @@ -398,7 +398,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query incidents under a specific alert": { "$ref": "./examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json" } @@ -439,7 +439,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Query a single anomaly detection configuration": { "$ref": "./examples/getAnomalyDetectionConfiguration.json" } @@ -487,7 +487,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Update anomaly detection configuration": { "$ref": "./examples/updateAnomalyDetectionConfiguration.json" } @@ -566,7 +566,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Create anomaly detection configuration": { "$ref": "./examples/createAnomalyDetectionConfiguration.json" } @@ -607,7 +607,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Query all anomaly alerting configurations for specific anomaly detection configuration": { "$ref": "./examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json" } @@ -660,7 +660,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Query series enriched by anomaly detection": { "$ref": "./examples/getSeriesByAnomalyDetectionConfiguration.json" } @@ -730,7 +730,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query anomalies under anomaly detection configuration": { "$ref": "./examples/getAnomaliesByAnomalyDetectionConfiguration.json" } @@ -800,7 +800,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query dimension values of anomalies": { "$ref": "./examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json" } @@ -863,7 +863,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query incidents under anomaly detection configuration": { "$ref": "./examples/getIncidentsByAnomalyDetectionConfiguration.json" } @@ -918,7 +918,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query incidents under anomaly detection configuration": { "$ref": "./examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json" } @@ -966,7 +966,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Query root cause for incident": { "$ref": "./examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json" } @@ -1087,7 +1087,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "List all data feeds": { "$ref": "./examples/listDataFeeds.json" } @@ -1133,7 +1133,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Create a new data feed": { "$ref": "./examples/createDataFeed.json" } @@ -1174,7 +1174,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Get a data feed by its id": { "$ref": "./examples/getDataFeedById.json" } @@ -1222,7 +1222,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Update a data feed": { "$ref": "./examples/updateDataFeed.json" } @@ -1294,7 +1294,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Get a metric feedback by its id": { "$ref": "./examples/getMetricFeedback.json" } @@ -1356,7 +1356,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "List feedback on the given metric": { "$ref": "./examples/listMetricFeedbacks.json" } @@ -1404,7 +1404,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Create a new metric feedback": { "$ref": "./examples/createMetricFeedback.json" } @@ -1460,7 +1460,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "List all hooks": { "$ref": "./examples/listHooks.json" } @@ -1506,7 +1506,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Create a new hook": { "$ref": "./examples/createHook.json" } @@ -1547,7 +1547,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Get a hook by its id": { "$ref": "./examples/getHook.json" } @@ -1595,7 +1595,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Update a hook": { "$ref": "./examples/updateHook.json" } @@ -1696,7 +1696,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get data ingestion status by data feed": { "$ref": "./examples/getDataFeedIngestionStatus.json" } @@ -1746,7 +1746,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Reset data ingestion status by data feed to backfill data": { "$ref": "./examples/resetDataFeedIngestionStatus.json" } @@ -1787,7 +1787,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Get data last success ingestion job timestamp by data feed": { "$ref": "./examples/getIngestionProgress.json" } @@ -1840,7 +1840,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Get time series data from metric": { "$ref": "./examples/getMetricData.json" } @@ -1910,7 +1910,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "List series (dimension combinations) from metric": { "$ref": "./examples/getMetricSeries.json" } @@ -1980,7 +1980,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "List dimension from certain metric": { "$ref": "./examples/getMetricDimension.json" } @@ -2021,7 +2021,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Query all anomaly detection configurations for specific metric": { "$ref": "./examples/getAnomalyDetectionConfigurationsByMetric.json" } @@ -2091,7 +2091,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query anomaly detection status": { "$ref": "./examples/getEnrichmentStatusByMetric.json" } From 663e8e51d3da807b08ce490de91596b452a4ddd0 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Wed, 27 Jan 2021 11:17:25 +0800 Subject: [PATCH 21/35] fix x-ms-examples --- .../preview/v1.0/MetricsAdvisor.json | 72 +++++++++---------- .../createAnomalyAlertingConfiguration.json | 3 + .../createAnomalyDetectionConfiguration.json | 3 + .../preview/v1.0/examples/createDataFeed.json | 3 + .../preview/v1.0/examples/createHook.json | 3 + .../v1.0/examples/createMetricFeedback.json | 3 + .../v1.0/examples/getActiveSeriesCount.json | 5 +- ...tAlertsByAnomalyAlertingConfiguration.json | 3 + ...maliesByAnomalyDetectionConfiguration.json | 3 + ...omAlertByAnomalyAlertingConfiguration.json | 2 + .../getAnomalyAlertingConfiguration.json | 2 + ...ationsByAnomalyDetectionConfiguration.json | 2 + .../getAnomalyDetectionConfiguration.json | 2 + ...nomalyDetectionConfigurationsByMetric.json | 2 + .../v1.0/examples/getDataFeedById.json | 2 + .../examples/getDataFeedIngestionStatus.json | 3 + ...maliesByAnomalyDetectionConfiguration.json | 3 + .../examples/getEnrichmentStatusByMetric.json | 3 + .../preview/v1.0/examples/getHook.json | 2 + ...identsByAnomalyDetectionConfiguration.json | 3 + ...nomalyDetectionConfigurationNextPages.json | 2 + ...omAlertByAnomalyAlertingConfiguration.json | 2 + .../v1.0/examples/getIngestionProgress.json | 2 + .../preview/v1.0/examples/getMetricData.json | 3 + .../v1.0/examples/getMetricDimension.json | 3 + .../v1.0/examples/getMetricFeedback.json | 2 + .../v1.0/examples/getMetricSeries.json | 3 + ...cidentByAnomalyDetectionConfiguration.json | 2 + ...SeriesByAnomalyDetectionConfiguration.json | 3 + .../preview/v1.0/examples/listDataFeeds.json | 2 + .../preview/v1.0/examples/listHooks.json | 2 + .../v1.0/examples/listMetricFeedbacks.json | 3 + .../resetDataFeedIngestionStatus.json | 3 + .../updateAnomalyAlertingConfiguration.json | 3 + .../updateAnomalyDetectionConfiguration.json | 3 + .../preview/v1.0/examples/updateDataFeed.json | 3 + .../preview/v1.0/examples/updateHook.json | 3 + 37 files changed, 131 insertions(+), 37 deletions(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index ddd02b974f3f..e855060213e6 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -30,7 +30,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Get latest usage stats": { "$ref": "./examples/getActiveSeriesCount.json" } @@ -71,7 +71,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Query a single anomaly alerting configuration": { "$ref": "./examples/getAnomalyAlertingConfiguration.json" } @@ -119,7 +119,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Update anomaly alerting configuration": { "$ref": "./examples/updateAnomalyAlertingConfiguration.json" } @@ -198,7 +198,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Create anomaly alerting configuration": { "$ref": "./examples/createAnomalyAlertingConfiguration.json" } @@ -268,7 +268,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query alerts under anomaly alerting configuration": { "$ref": "./examples/getAlertsByAnomalyAlertingConfiguration.json" } @@ -333,7 +333,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query anomalies under a specific alert": { "$ref": "./examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json" } @@ -398,7 +398,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query incidents under a specific alert": { "$ref": "./examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json" } @@ -439,7 +439,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Query a single anomaly detection configuration": { "$ref": "./examples/getAnomalyDetectionConfiguration.json" } @@ -487,7 +487,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Update anomaly detection configuration": { "$ref": "./examples/updateAnomalyDetectionConfiguration.json" } @@ -566,7 +566,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Create anomaly detection configuration": { "$ref": "./examples/createAnomalyDetectionConfiguration.json" } @@ -607,7 +607,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Query all anomaly alerting configurations for specific anomaly detection configuration": { "$ref": "./examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json" } @@ -660,7 +660,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Query series enriched by anomaly detection": { "$ref": "./examples/getSeriesByAnomalyDetectionConfiguration.json" } @@ -730,7 +730,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query anomalies under anomaly detection configuration": { "$ref": "./examples/getAnomaliesByAnomalyDetectionConfiguration.json" } @@ -800,7 +800,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query dimension values of anomalies": { "$ref": "./examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json" } @@ -863,7 +863,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query incidents under anomaly detection configuration": { "$ref": "./examples/getIncidentsByAnomalyDetectionConfiguration.json" } @@ -918,7 +918,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query incidents under anomaly detection configuration": { "$ref": "./examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json" } @@ -966,7 +966,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Query root cause for incident": { "$ref": "./examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json" } @@ -1087,7 +1087,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "List all data feeds": { "$ref": "./examples/listDataFeeds.json" } @@ -1133,7 +1133,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Create a new data feed": { "$ref": "./examples/createDataFeed.json" } @@ -1174,7 +1174,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Get a data feed by its id": { "$ref": "./examples/getDataFeedById.json" } @@ -1222,7 +1222,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Update a data feed": { "$ref": "./examples/updateDataFeed.json" } @@ -1294,7 +1294,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Get a metric feedback by its id": { "$ref": "./examples/getMetricFeedback.json" } @@ -1356,7 +1356,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "List feedback on the given metric": { "$ref": "./examples/listMetricFeedbacks.json" } @@ -1404,7 +1404,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Create a new metric feedback": { "$ref": "./examples/createMetricFeedback.json" } @@ -1460,7 +1460,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "List all hooks": { "$ref": "./examples/listHooks.json" } @@ -1506,7 +1506,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Create a new hook": { "$ref": "./examples/createHook.json" } @@ -1547,7 +1547,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Get a hook by its id": { "$ref": "./examples/getHook.json" } @@ -1595,7 +1595,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Update a hook": { "$ref": "./examples/updateHook.json" } @@ -1696,7 +1696,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get data ingestion status by data feed": { "$ref": "./examples/getDataFeedIngestionStatus.json" } @@ -1746,7 +1746,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Reset data ingestion status by data feed to backfill data": { "$ref": "./examples/resetDataFeedIngestionStatus.json" } @@ -1787,7 +1787,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Get data last success ingestion job timestamp by data feed": { "$ref": "./examples/getIngestionProgress.json" } @@ -1840,7 +1840,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Get time series data from metric": { "$ref": "./examples/getMetricData.json" } @@ -1910,7 +1910,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "List series (dimension combinations) from metric": { "$ref": "./examples/getMetricSeries.json" } @@ -1980,7 +1980,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "List dimension from certain metric": { "$ref": "./examples/getMetricDimension.json" } @@ -2021,7 +2021,7 @@ } } }, - "x-ms-example": { + "x-ms-examples": { "Query all anomaly detection configurations for specific metric": { "$ref": "./examples/getAnomalyDetectionConfigurationsByMetric.json" } @@ -2091,7 +2091,7 @@ "x-ms-pageable": { "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Query anomaly detection status": { "$ref": "./examples/getEnrichmentStatusByMetric.json" } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json index 92c2d4345cec..119ed5e2af1a 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json @@ -1,5 +1,8 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", "body": { "name": "alerting configuration name", "crossMetricsOperator": "AND", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json index d7b2e9907230..2961e3ed3ad9 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json @@ -1,5 +1,8 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", "body": { "name": "Anomaly detection configuration name", "description": "Anomaly detection configuration description", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json index fb98b894e196..1be3494687a7 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json @@ -1,5 +1,8 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", "body": { "dataSourceParameter": { "connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json index 6d642642fc79..b9846edac1c1 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json @@ -1,5 +1,8 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", "body": { "hookParameter": { "endpoint": "https://localhost/demo/post" diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json index ba4741d64e24..a3d93af25485 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json @@ -1,5 +1,8 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-01-01T00:00:00.000Z", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json index 9361beacc14a..e6467fd367b9 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json @@ -1,5 +1,8 @@ { - "parameters": {}, + "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, "responses": { "200": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json index d319e64a5fd9..bed33512f60c 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json @@ -1,6 +1,9 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "configurationId": "44444444-4444-4444-4444-000000000001", + "Content-Type": "application/json", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json index 8cdc34dd585a..0b2b7997cf68 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json @@ -1,6 +1,9 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "configurationId": "33333333-3333-3333-3333-000000000001", + "Content-Type": "application/json", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json index 847d10bd7aaf..4ff0ee79068c 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json @@ -1,5 +1,7 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "configurationId": "44444444-4444-4444-4444-000000000001", "alertId": "aaaaaaaaaaaa" }, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json index f21923f843f2..2c897605bcf0 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json @@ -1,5 +1,7 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "configurationId": "44444444-4444-4444-4444-000000000001" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json index 658fa09bb80c..d67129f5b6ea 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json @@ -1,5 +1,7 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "configurationId": "33333333-3333-3333-3333-000000000001" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json index 9da9451215ff..b2fd5518141c 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json @@ -1,5 +1,7 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "configurationId": "33333333-3333-3333-3333-000000000001" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json index 4f245c25d8cd..3d6716b34801 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json @@ -1,5 +1,7 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "metricId": "22222222-2222-2222-2222-000000000001" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json index 96bfd1568524..c78cf89d8cfc 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json @@ -1,5 +1,7 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "dataFeedId": "01234567-8901-2345-6789-012345678901" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json index be327b1a0eb8..a0a4eac1ec42 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json @@ -1,6 +1,9 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "dataFeedId": "01234567-8901-2345-6789-012345678901", + "Content-Type": "application/json", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z" diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json index df95cf41cf89..2e6e6324cdce 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json @@ -1,6 +1,9 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "configurationId": "33333333-3333-3333-3333-000000000001", + "Content-Type": "application/json", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json index 1908ea25a235..d2b37e657ae7 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json @@ -1,6 +1,9 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "metricId": "22222222-2222-2222-2222-000000000001", + "Content-Type": "application/json", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z" diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json index 3a1d04f4448d..9b2b57f0d975 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json @@ -1,5 +1,7 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "hookId": "01234567-8901-2345-6789-012345678901" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json index fd7af7feffaa..e2dc2b033536 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json @@ -1,6 +1,9 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "configurationId": "33333333-3333-3333-3333-000000000001", + "Content-Type": "application/json", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json index 179e86e5ac0c..ca486dff0444 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json @@ -1,5 +1,7 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "configurationId": "33333333-3333-3333-3333-000000000001" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json index fff7c833f5a6..7338f495b54e 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json @@ -1,5 +1,7 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "configurationId": "44444444-4444-4444-4444-000000000001", "alertId": "aaaaaaaaaaaa" }, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json index d7144c3692ec..c82d15d40676 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json @@ -1,5 +1,7 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "dataFeedId": "01234567-8901-2345-6789-012345678901" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json index 09dfb6d532b1..66ad68c60dcd 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json @@ -1,6 +1,9 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "metricId": "22222222-2222-2222-2222-000000000001", + "Content-Type": "application/json", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json index f58fad19a5a2..5112c4b19a28 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json @@ -1,6 +1,9 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "metricId": "22222222-2222-2222-2222-000000000001", + "Content-Type": "application/json", "body": { "dimensionName": "city" } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json index 10675111c0ee..727abdca5fb2 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json @@ -1,5 +1,7 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "feedbackId": "99998888-7777-6666-5555-444433332222" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json index e579c015e1eb..9013cfa69a67 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json @@ -1,6 +1,9 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "metricId": "22222222-2222-2222-2222-000000000001", + "Content-Type": "application/json", "body": { "activeSince": "2020-01-01T00:00:00.000Z", "dimensionFilter": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json index aae30c6cc3d8..1d58a66e7ada 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json @@ -1,5 +1,7 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "configurationId": "33333333-3333-3333-3333-000000000001", "incidentId": "iiiiiiiiiiii" }, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json index afe42bc4e9b9..6c2cde33749f 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json @@ -1,6 +1,9 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "configurationId": "33333333-3333-3333-3333-000000000001", + "Content-Type": "application/json", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json index ed55623f2037..29ac2cb33c03 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json @@ -1,5 +1,7 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "dataFeedName": "name_prefix", "dataSourceType": "SqlServer", "granularityName": "Daily", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json index f733cf5ce1ee..b4f06320519f 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json @@ -1,5 +1,7 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "hookName": "name_prefix" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json index cbf79001e000..a7f095cd7bf6 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json @@ -1,5 +1,8 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", "body": { "metricId": "22222222-2222-2222-2222-000000000001", "feedbackType": "Anomaly", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json index 6df63749c099..def155f6ea5e 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json @@ -1,6 +1,9 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "dataFeedId": "01234567-8901-2345-6789-012345678901", + "Content-Type": "application/json", "body": { "startTime": "2020-01-01T00:00:00.000Z", "endTime": "2020-02-01T00:00:00.000Z" diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json index 09dce29d97b4..36f71d83475a 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json @@ -1,6 +1,9 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "configurationId": "44444444-4444-4444-4444-000000000001", + "Content-Type": "application/merge-patch+json", "body": { "name": "alerting configuration name", "description": "this is an anomaly alerting configuration", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json index 13e90de59c3e..7820224e5d7f 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json @@ -1,6 +1,9 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "configurationId": "33333333-3333-3333-3333-000000000001", + "Content-Type": "application/merge-patch+json", "body": { "name": "Anomaly detection configuration name", "description": "Anomaly detection configuration description", diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json index b064a45586c6..c2799fff884d 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json @@ -1,6 +1,9 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "dataFeedId": "01234567-8901-2345-6789-012345678901", + "Content-Type": "application/merge-patch+json", "body": { "dataFeedName": "Sample - cost/revenue - city/category (modified)", "viewers": [ diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json index 3f907e54e00d..0cabf428e7a9 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json @@ -1,6 +1,9 @@ { "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", "hookId": "01234567-8901-2345-6789-012345678901", + "Content-Type": "application/merge-patch+json", "body": { "hookName": "A webhook (modified)", "description": "This is a webhook. (modified)" From af57ed0017ccbe2de1d0ea7d5c94dad95318bd4c Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Wed, 27 Jan 2021 11:22:52 +0800 Subject: [PATCH 22/35] trigger validation --- .../data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt index 76ea4d3aaf3f..73ebb8238f04 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt @@ -1 +1,2 @@ metricsadvisor + From 935637e68386ce1998bd4b2b3a493f6ec9685365 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Wed, 27 Jan 2021 11:38:32 +0800 Subject: [PATCH 23/35] fix examples --- .../examples/createAnomalyAlertingConfiguration.json | 9 ++++++++- .../examples/createAnomalyDetectionConfiguration.json | 9 ++++++++- .../preview/v1.0/examples/createDataFeed.json | 9 ++++++++- .../preview/v1.0/examples/createHook.json | 9 ++++++++- .../preview/v1.0/examples/createMetricFeedback.json | 9 ++++++++- .../examples/deleteAnomalyAlertingConfiguration.json | 11 +++++++++++ .../examples/deleteAnomalyDetectionConfiguration.json | 11 +++++++++++ .../preview/v1.0/examples/deleteDataFeed.json | 11 +++++++++++ .../preview/v1.0/examples/deleteHook.json | 11 +++++++++++ .../preview/v1.0/examples/getActiveSeriesCount.json | 3 ++- .../getAlertsByAnomalyAlertingConfiguration.json | 3 ++- .../getAnomaliesByAnomalyDetectionConfiguration.json | 3 ++- ...maliesFromAlertByAnomalyAlertingConfiguration.json | 3 ++- .../examples/getAnomalyAlertingConfiguration.json | 3 ++- ...ConfigurationsByAnomalyDetectionConfiguration.json | 3 ++- .../examples/getAnomalyDetectionConfiguration.json | 3 ++- .../getAnomalyDetectionConfigurationsByMetric.json | 3 ++- .../preview/v1.0/examples/getDataFeedById.json | 3 ++- .../v1.0/examples/getDataFeedIngestionStatus.json | 3 ++- ...ionOfAnomaliesByAnomalyDetectionConfiguration.json | 3 ++- .../v1.0/examples/getEnrichmentStatusByMetric.json | 3 ++- .../MetricsAdvisor/preview/v1.0/examples/getHook.json | 3 ++- .../getIncidentsByAnomalyDetectionConfiguration.json | 3 ++- ...dentsByAnomalyDetectionConfigurationNextPages.json | 3 ++- ...identsFromAlertByAnomalyAlertingConfiguration.json | 3 ++- .../preview/v1.0/examples/getIngestionProgress.json | 3 ++- .../preview/v1.0/examples/getMetricData.json | 3 ++- .../preview/v1.0/examples/getMetricDimension.json | 3 ++- .../preview/v1.0/examples/getMetricFeedback.json | 3 ++- .../preview/v1.0/examples/getMetricSeries.json | 3 ++- ...auseOfIncidentByAnomalyDetectionConfiguration.json | 3 ++- .../getSeriesByAnomalyDetectionConfiguration.json | 3 ++- .../preview/v1.0/examples/listDataFeeds.json | 3 ++- .../preview/v1.0/examples/listHooks.json | 3 ++- .../preview/v1.0/examples/listMetricFeedbacks.json | 3 ++- .../v1.0/examples/resetDataFeedIngestionStatus.json | 5 ++++- .../examples/updateAnomalyAlertingConfiguration.json | 5 ++++- .../examples/updateAnomalyDetectionConfiguration.json | 5 ++++- .../preview/v1.0/examples/updateDataFeed.json | 5 ++++- .../preview/v1.0/examples/updateHook.json | 5 ++++- 40 files changed, 156 insertions(+), 36 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyAlertingConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyDetectionConfiguration.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteDataFeed.json create mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteHook.json diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json index 119ed5e2af1a..aab16782bd51 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json @@ -51,5 +51,12 @@ ] } }, - "responses": {} + "responses": { + "201": { + "headers": { + "Location": "" + } + }, + "default": {} + } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json index 2961e3ed3ad9..6da4cd54794f 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json @@ -114,5 +114,12 @@ ] } }, - "responses": {} + "responses": { + "201": { + "headers": { + "Location": "" + } + }, + "default": {} + } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json index 1be3494687a7..d5a93f1d703d 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json @@ -46,5 +46,12 @@ "isAdmin": false } }, - "responses": {} + "responses": { + "201": { + "headers": { + "Location": "" + } + }, + "default": {} + } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json index b9846edac1c1..06e8c01b1274 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json @@ -13,5 +13,12 @@ "externalLink": "" } }, - "responses": {} + "responses": { + "201": { + "headers": { + "Location": "" + } + }, + "default": {} + } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json index a3d93af25485..0d584f83004e 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json @@ -19,5 +19,12 @@ "feedbackType": "Anomaly" } }, - "responses": {} + "responses": { + "201": { + "headers": { + "Location": "" + } + }, + "default": {} + } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyAlertingConfiguration.json new file mode 100644 index 000000000000..7f08c62457d1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyAlertingConfiguration.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "configurationId": "44444444-4444-4444-4444-000000000001" + }, + "responses": { + "204": {}, + "default": {} + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyDetectionConfiguration.json new file mode 100644 index 000000000000..34e3172bd82c --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyDetectionConfiguration.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "configurationId": "33333333-3333-3333-3333-000000000001" + }, + "responses": { + "204": {}, + "default": {} + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteDataFeed.json new file mode 100644 index 000000000000..d4a3de1869f1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteDataFeed.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "dataFeedId": "01234567-8901-2345-6789-012345678901" + }, + "responses": { + "204": {}, + "default": {} + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteHook.json new file mode 100644 index 000000000000..55eeb978f2c7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteHook.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "hookId": "01234567-8901-2345-6789-012345678901" + }, + "responses": { + "204": {}, + "default": {} + } +} diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json index e6467fd367b9..919e6b470585 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json @@ -13,6 +13,7 @@ "metricsCount": 10, "dataFeedCount": 5 } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json index bed33512f60c..99a46da0a4bb 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json @@ -23,6 +23,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json index 0b2b7997cf68..3c8c5bf093f1 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json @@ -44,6 +44,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json index 4ff0ee79068c..ac0071a6282b 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json @@ -27,6 +27,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json index 2c897605bcf0..5b93cbebb1a9 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json @@ -56,6 +56,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json index d67129f5b6ea..e73ae36674d2 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json @@ -60,6 +60,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json index b2fd5518141c..06d98207051b 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json @@ -118,6 +118,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json index 3d6716b34801..533c5a4eb2fb 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json @@ -122,6 +122,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json index c78cf89d8cfc..6e698ae1dda6 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json @@ -59,6 +59,7 @@ "status": "Active", "createdTime": "2020-03-01T00:00:00.000Z" } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json index a0a4eac1ec42..2dd2997ff790 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json @@ -27,6 +27,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json index 2e6e6324cdce..5b02a646193e 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json @@ -23,6 +23,7 @@ "Jewelry" ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json index d2b37e657ae7..7b5bf6cc3054 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json @@ -27,6 +27,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json index 9b2b57f0d975..7683b312cb06 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json @@ -20,6 +20,7 @@ "admin@company.example" ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json index e2dc2b033536..8b3021a750ed 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json @@ -42,6 +42,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json index ca486dff0444..5882a2ce9896 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json @@ -28,6 +28,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json index 7338f495b54e..69cde08dea0b 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json @@ -29,6 +29,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json index c82d15d40676..eb2bb4913755 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json @@ -11,6 +11,7 @@ "latestSuccessTimestamp": "2020-01-30T00:00:00.000Z", "latestActiveTimestamp": "2020-01-31T00:00:00.000Z" } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json index 66ad68c60dcd..cb04b7eea478 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json @@ -39,6 +39,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json index 5112c4b19a28..37a9cea8f1d3 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json @@ -18,6 +18,7 @@ "Beijing" ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json index 727abdca5fb2..60fcb5765bf5 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json @@ -136,6 +136,7 @@ }, "feedbackType": "Anomaly" } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json index 9013cfa69a67..ccb62cd8310a 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json @@ -35,6 +35,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json index 1d58a66e7ada..69103f91956a 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json @@ -24,6 +24,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json index 6c2cde33749f..e75009bbb94f 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json @@ -53,6 +53,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json index 29ac2cb33c03..96b5a1ebf9de 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json @@ -68,6 +68,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json index b4f06320519f..9ce29995eb9b 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json @@ -25,6 +25,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json index a7f095cd7bf6..7b694bdd0b67 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json @@ -148,6 +148,7 @@ } ] } - } + }, + "default": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json index def155f6ea5e..33d8d9e2f1ce 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json @@ -9,5 +9,8 @@ "endTime": "2020-02-01T00:00:00.000Z" } }, - "responses": {} + "responses": { + "204": {}, + "default": {} + } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json index 36f71d83475a..80ec3d5971f9 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json @@ -53,5 +53,8 @@ ] } }, - "responses": {} + "responses": { + "204": {}, + "default": {} + } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json index 7820224e5d7f..593bb6ab8b1b 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json @@ -114,5 +114,8 @@ ] } }, - "responses": {} + "responses": { + "204": {}, + "default": {} + } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json index c2799fff884d..f722393e57a6 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json @@ -11,5 +11,8 @@ ] } }, - "responses": {} + "responses": { + "204": {}, + "default": {} + } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json index 0cabf428e7a9..618ecad3c7bc 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json @@ -9,5 +9,8 @@ "description": "This is a webhook. (modified)" } }, - "responses": {} + "responses": { + "204": {}, + "default": {} + } } From d3c6cf91d16303b5973f4501c66dcaae32621339 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Wed, 27 Jan 2021 11:49:50 +0800 Subject: [PATCH 24/35] fix examples --- .../preview/v1.0/MetricsAdvisor.json | 20 +++++++++++++++++++ .../createAnomalyAlertingConfiguration.json | 3 +-- .../createAnomalyDetectionConfiguration.json | 3 +-- .../preview/v1.0/examples/createDataFeed.json | 3 +-- .../preview/v1.0/examples/createHook.json | 3 +-- .../v1.0/examples/createMetricFeedback.json | 3 +-- .../deleteAnomalyAlertingConfiguration.json | 3 +-- .../deleteAnomalyDetectionConfiguration.json | 3 +-- .../preview/v1.0/examples/deleteDataFeed.json | 3 +-- .../preview/v1.0/examples/deleteHook.json | 3 +-- .../v1.0/examples/getActiveSeriesCount.json | 3 +-- ...tAlertsByAnomalyAlertingConfiguration.json | 3 +-- ...maliesByAnomalyDetectionConfiguration.json | 3 +-- ...omAlertByAnomalyAlertingConfiguration.json | 3 +-- .../getAnomalyAlertingConfiguration.json | 3 +-- ...ationsByAnomalyDetectionConfiguration.json | 3 +-- .../getAnomalyDetectionConfiguration.json | 3 +-- ...nomalyDetectionConfigurationsByMetric.json | 3 +-- .../v1.0/examples/getDataFeedById.json | 3 +-- .../examples/getDataFeedIngestionStatus.json | 3 +-- ...maliesByAnomalyDetectionConfiguration.json | 3 +-- .../examples/getEnrichmentStatusByMetric.json | 3 +-- .../preview/v1.0/examples/getHook.json | 3 +-- ...identsByAnomalyDetectionConfiguration.json | 3 +-- ...nomalyDetectionConfigurationNextPages.json | 3 +-- ...omAlertByAnomalyAlertingConfiguration.json | 3 +-- .../v1.0/examples/getIngestionProgress.json | 3 +-- .../preview/v1.0/examples/getMetricData.json | 3 +-- .../v1.0/examples/getMetricDimension.json | 3 +-- .../v1.0/examples/getMetricFeedback.json | 3 +-- .../v1.0/examples/getMetricSeries.json | 3 +-- ...cidentByAnomalyDetectionConfiguration.json | 3 +-- ...SeriesByAnomalyDetectionConfiguration.json | 3 +-- .../preview/v1.0/examples/listDataFeeds.json | 3 +-- .../preview/v1.0/examples/listHooks.json | 3 +-- .../v1.0/examples/listMetricFeedbacks.json | 3 +-- .../resetDataFeedIngestionStatus.json | 3 +-- .../updateAnomalyAlertingConfiguration.json | 3 +-- .../updateAnomalyDetectionConfiguration.json | 3 +-- .../preview/v1.0/examples/updateDataFeed.json | 3 +-- .../preview/v1.0/examples/updateHook.json | 3 +-- 41 files changed, 60 insertions(+), 80 deletions(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index e855060213e6..65dde37e2638 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -154,6 +154,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-examples": { + "Delete anomaly alerting configuration": { + "$ref": "./examples/deleteAnomalyAlertingConfiguration.json" + } } } }, @@ -522,6 +527,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-examples": { + "Delete anomaly detection configuration": { + "$ref": "./examples/deleteAnomalyDetectionConfiguration.json" + } } } }, @@ -1257,6 +1267,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-examples": { + "Delete a data feed": { + "$ref": "./examples/deleteDataFeed.json" + } } } }, @@ -1630,6 +1645,11 @@ "$ref": "#/definitions/ErrorCode" } } + }, + "x-ms-examples": { + "Delete a hook": { + "$ref": "./examples/deleteHook.json" + } } } }, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json index aab16782bd51..55bb7bc485c7 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyAlertingConfiguration.json @@ -56,7 +56,6 @@ "headers": { "Location": "" } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json index 6da4cd54794f..161e6c1b8f47 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createAnomalyDetectionConfiguration.json @@ -119,7 +119,6 @@ "headers": { "Location": "" } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json index d5a93f1d703d..ebbe0885ec37 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json @@ -51,7 +51,6 @@ "headers": { "Location": "" } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json index 06e8c01b1274..4aea0fe2b530 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createHook.json @@ -18,7 +18,6 @@ "headers": { "Location": "" } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json index 0d584f83004e..12421f458e97 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createMetricFeedback.json @@ -24,7 +24,6 @@ "headers": { "Location": "" } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyAlertingConfiguration.json index 7f08c62457d1..5c62504ec248 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyAlertingConfiguration.json @@ -5,7 +5,6 @@ "configurationId": "44444444-4444-4444-4444-000000000001" }, "responses": { - "204": {}, - "default": {} + "204": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyDetectionConfiguration.json index 34e3172bd82c..5eedb118b916 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteAnomalyDetectionConfiguration.json @@ -5,7 +5,6 @@ "configurationId": "33333333-3333-3333-3333-000000000001" }, "responses": { - "204": {}, - "default": {} + "204": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteDataFeed.json index d4a3de1869f1..173c1f778d9a 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteDataFeed.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteDataFeed.json @@ -5,7 +5,6 @@ "dataFeedId": "01234567-8901-2345-6789-012345678901" }, "responses": { - "204": {}, - "default": {} + "204": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteHook.json index 55eeb978f2c7..36644117ba43 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/deleteHook.json @@ -5,7 +5,6 @@ "hookId": "01234567-8901-2345-6789-012345678901" }, "responses": { - "204": {}, - "default": {} + "204": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json index 919e6b470585..e6467fd367b9 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json @@ -13,7 +13,6 @@ "metricsCount": 10, "dataFeedCount": 5 } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json index 99a46da0a4bb..bed33512f60c 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAlertsByAnomalyAlertingConfiguration.json @@ -23,7 +23,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json index 3c8c5bf093f1..0b2b7997cf68 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesByAnomalyDetectionConfiguration.json @@ -44,7 +44,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json index ac0071a6282b..4ff0ee79068c 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomaliesFromAlertByAnomalyAlertingConfiguration.json @@ -27,7 +27,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json index 5b93cbebb1a9..2c897605bcf0 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json @@ -56,7 +56,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json index e73ae36674d2..d67129f5b6ea 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json @@ -60,7 +60,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json index 06d98207051b..b2fd5518141c 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfiguration.json @@ -118,7 +118,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json index 533c5a4eb2fb..3d6716b34801 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyDetectionConfigurationsByMetric.json @@ -122,7 +122,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json index 6e698ae1dda6..c78cf89d8cfc 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedById.json @@ -59,7 +59,6 @@ "status": "Active", "createdTime": "2020-03-01T00:00:00.000Z" } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json index 2dd2997ff790..a0a4eac1ec42 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDataFeedIngestionStatus.json @@ -27,7 +27,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json index 5b02a646193e..2e6e6324cdce 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json @@ -23,7 +23,6 @@ "Jewelry" ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json index 7b5bf6cc3054..d2b37e657ae7 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getEnrichmentStatusByMetric.json @@ -27,7 +27,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json index 7683b312cb06..9b2b57f0d975 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getHook.json @@ -20,7 +20,6 @@ "admin@company.example" ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json index 8b3021a750ed..e2dc2b033536 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfiguration.json @@ -42,7 +42,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json index 5882a2ce9896..ca486dff0444 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json @@ -28,7 +28,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json index 69cde08dea0b..7338f495b54e 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIncidentsFromAlertByAnomalyAlertingConfiguration.json @@ -29,7 +29,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json index eb2bb4913755..c82d15d40676 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getIngestionProgress.json @@ -11,7 +11,6 @@ "latestSuccessTimestamp": "2020-01-30T00:00:00.000Z", "latestActiveTimestamp": "2020-01-31T00:00:00.000Z" } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json index cb04b7eea478..66ad68c60dcd 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricData.json @@ -39,7 +39,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json index 37a9cea8f1d3..5112c4b19a28 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricDimension.json @@ -18,7 +18,6 @@ "Beijing" ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json index 60fcb5765bf5..727abdca5fb2 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricFeedback.json @@ -136,7 +136,6 @@ }, "feedbackType": "Anomaly" } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json index ccb62cd8310a..9013cfa69a67 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getMetricSeries.json @@ -35,7 +35,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json index 69103f91956a..1d58a66e7ada 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json @@ -24,7 +24,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json index e75009bbb94f..6c2cde33749f 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getSeriesByAnomalyDetectionConfiguration.json @@ -53,7 +53,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json index 96b5a1ebf9de..29ac2cb33c03 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listDataFeeds.json @@ -68,7 +68,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json index 9ce29995eb9b..b4f06320519f 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listHooks.json @@ -25,7 +25,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json index 7b694bdd0b67..a7f095cd7bf6 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/listMetricFeedbacks.json @@ -148,7 +148,6 @@ } ] } - }, - "default": {} + } } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json index 33d8d9e2f1ce..db81482a2224 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/resetDataFeedIngestionStatus.json @@ -10,7 +10,6 @@ } }, "responses": { - "204": {}, - "default": {} + "204": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json index 80ec3d5971f9..22d1df25b83d 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyAlertingConfiguration.json @@ -54,7 +54,6 @@ } }, "responses": { - "204": {}, - "default": {} + "204": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json index 593bb6ab8b1b..638e88d5724a 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateAnomalyDetectionConfiguration.json @@ -115,7 +115,6 @@ } }, "responses": { - "204": {}, - "default": {} + "204": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json index f722393e57a6..54febb327084 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateDataFeed.json @@ -12,7 +12,6 @@ } }, "responses": { - "204": {}, - "default": {} + "204": {} } } diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json index 618ecad3c7bc..a6e131d7568e 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/updateHook.json @@ -10,7 +10,6 @@ } }, "responses": { - "204": {}, - "default": {} + "204": {} } } From 149d077a40ac97175471573603dbc2dfb3400e21 Mon Sep 17 00:00:00 2001 From: Xiang Yan Date: Wed, 27 Jan 2021 10:30:21 -0800 Subject: [PATCH 25/35] Update getAnomalyAlertingConfiguration.json --- .../preview/v1.0/examples/getAnomalyAlertingConfiguration.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json index 2c897605bcf0..11564692bb39 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json @@ -2,7 +2,7 @@ "parameters": { "endpoint": "{endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", - "configurationId": "44444444-4444-4444-4444-000000000001" + "configurationId": "{configurationId}" }, "responses": { "200": { From 79448d2e65d600ea62035ca83b746c1e890cfa99 Mon Sep 17 00:00:00 2001 From: Xiang Yan Date: Wed, 27 Jan 2021 10:36:47 -0800 Subject: [PATCH 26/35] Update getActiveSeriesCount.json --- .../preview/v1.0/examples/getActiveSeriesCount.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json index e6467fd367b9..a078676acf69 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json @@ -1,7 +1,8 @@ { "parameters": { "endpoint": "{endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}" + "Ocp-Apim-Subscription-Key": "{API key}", + "body": {} }, "responses": { "200": { From 640b5054a2616e903b07673d005061413626b890 Mon Sep 17 00:00:00 2001 From: Xiang Yan Date: Wed, 27 Jan 2021 10:58:19 -0800 Subject: [PATCH 27/35] Update MetricsAdvisor.json --- .../preview/v1.0/MetricsAdvisor.json | 80 +++++++++---------- 1 file changed, 40 insertions(+), 40 deletions(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index 65dde37e2638..29b7dd3ebf66 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -12,7 +12,7 @@ "Admin" ], "summary": "Get latest usage stats", - "operationId": "getActiveSeriesCount", + "operationId": "GetActiveSeriesCount", "produces": [ "application/json" ], @@ -43,7 +43,7 @@ "AnomalyAlerting" ], "summary": "Query a single anomaly alerting configuration", - "operationId": "getAnomalyAlertingConfiguration", + "operationId": "GetAnomalyAlertingConfiguration", "produces": [ "application/json" ], @@ -82,7 +82,7 @@ "AnomalyAlerting" ], "summary": "Update anomaly alerting configuration", - "operationId": "updateAnomalyAlertingConfiguration", + "operationId": "UpdateAnomalyAlertingConfiguration", "consumes": [ "application/merge-patch+json" ], @@ -130,7 +130,7 @@ "AnomalyAlerting" ], "summary": "Delete anomaly alerting configuration", - "operationId": "deleteAnomalyAlertingConfiguration", + "operationId": "DeleteAnomalyAlertingConfiguration", "produces": [ "application/json" ], @@ -168,7 +168,7 @@ "AnomalyAlerting" ], "summary": "Create anomaly alerting configuration", - "operationId": "createAnomalyAlertingConfiguration", + "operationId": "CreateAnomalyAlertingConfiguration", "consumes": [ "application/json" ], @@ -216,7 +216,7 @@ "AnomalyAlerting" ], "summary": "Query alerts under anomaly alerting configuration", - "operationId": "getAlertsByAnomalyAlertingConfiguration", + "operationId": "GetAlertsByAnomalyAlertingConfiguration", "consumes": [ "application/json" ], @@ -286,7 +286,7 @@ "AnomalyAlerting" ], "summary": "Query anomalies under a specific alert", - "operationId": "getAnomaliesFromAlertByAnomalyAlertingConfiguration", + "operationId": "GetAnomaliesFromAlertByAnomalyAlertingConfiguration", "produces": [ "application/json" ], @@ -351,7 +351,7 @@ "AnomalyAlerting" ], "summary": "Query incidents under a specific alert", - "operationId": "getIncidentsFromAlertByAnomalyAlertingConfiguration", + "operationId": "GetIncidentsFromAlertByAnomalyAlertingConfiguration", "produces": [ "application/json" ], @@ -416,7 +416,7 @@ "AnomalyDetection" ], "summary": "Query a single anomaly detection configuration", - "operationId": "getAnomalyDetectionConfiguration", + "operationId": "GetAnomalyDetectionConfiguration", "produces": [ "application/json" ], @@ -455,7 +455,7 @@ "AnomalyDetection" ], "summary": "Update anomaly detection configuration", - "operationId": "updateAnomalyDetectionConfiguration", + "operationId": "UpdateAnomalyDetectionConfiguration", "consumes": [ "application/merge-patch+json" ], @@ -503,7 +503,7 @@ "AnomalyDetection" ], "summary": "Delete anomaly detection configuration", - "operationId": "deleteAnomalyDetectionConfiguration", + "operationId": "DeleteAnomalyDetectionConfiguration", "produces": [ "application/json" ], @@ -541,7 +541,7 @@ "AnomalyDetection" ], "summary": "Create anomaly detection configuration", - "operationId": "createAnomalyDetectionConfiguration", + "operationId": "CreateAnomalyDetectionConfiguration", "consumes": [ "application/json" ], @@ -589,7 +589,7 @@ "AnomalyDetection" ], "summary": "Query all anomaly alerting configurations for specific anomaly detection configuration", - "operationId": "getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration", + "operationId": "GetAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration", "produces": [ "application/json" ], @@ -630,7 +630,7 @@ "AnomalyDetection" ], "summary": "Query series enriched by anomaly detection", - "operationId": "getSeriesByAnomalyDetectionConfiguration", + "operationId": "GetSeriesByAnomalyDetectionConfiguration", "consumes": [ "application/json" ], @@ -683,7 +683,7 @@ "AnomalyDetection" ], "summary": "Query anomalies under anomaly detection configuration", - "operationId": "getAnomaliesByAnomalyDetectionConfiguration", + "operationId": "GetAnomaliesByAnomalyDetectionConfiguration", "consumes": [ "application/json" ], @@ -753,7 +753,7 @@ "AnomalyDetection" ], "summary": "Query dimension values of anomalies", - "operationId": "getDimensionOfAnomaliesByAnomalyDetectionConfiguration", + "operationId": "GetDimensionOfAnomaliesByAnomalyDetectionConfiguration", "consumes": [ "application/json" ], @@ -823,7 +823,7 @@ "AnomalyDetection" ], "summary": "Query incidents under anomaly detection configuration", - "operationId": "getIncidentsByAnomalyDetectionConfiguration", + "operationId": "GetIncidentsByAnomalyDetectionConfiguration", "consumes": [ "application/json" ], @@ -884,7 +884,7 @@ "AnomalyDetection" ], "summary": "Query incidents under anomaly detection configuration", - "operationId": "getIncidentsByAnomalyDetectionConfigurationNextPages", + "operationId": "GetIncidentsByAnomalyDetectionConfigurationNextPages", "produces": [ "application/json" ], @@ -941,7 +941,7 @@ "AnomalyDetection" ], "summary": "Query root cause for incident", - "operationId": "getRootCauseOfIncidentByAnomalyDetectionConfiguration", + "operationId": "GetRootCauseOfIncidentByAnomalyDetectionConfiguration", "produces": [ "application/json" ], @@ -989,7 +989,7 @@ "DataFeed" ], "summary": "List all data feeds", - "operationId": "listDataFeeds", + "operationId": "ListDataFeeds", "produces": [ "application/json" ], @@ -1108,7 +1108,7 @@ "DataFeed" ], "summary": "Create a new data feed", - "operationId": "createDataFeed", + "operationId": "CreateDataFeed", "consumes": [ "application/json" ], @@ -1156,7 +1156,7 @@ "DataFeed" ], "summary": "Get a data feed by its id", - "operationId": "getDataFeedById", + "operationId": "GetDataFeedById", "produces": [ "application/json" ], @@ -1195,7 +1195,7 @@ "DataFeed" ], "summary": "Update a data feed", - "operationId": "updateDataFeed", + "operationId": "UpdateDataFeed", "consumes": [ "application/merge-patch+json" ], @@ -1243,7 +1243,7 @@ "DataFeed" ], "summary": "Delete a data feed", - "operationId": "deleteDataFeed", + "operationId": "DeleteDataFeed", "produces": [ "application/json" ], @@ -1281,7 +1281,7 @@ "Feedback" ], "summary": "Get a metric feedback by its id", - "operationId": "getMetricFeedback", + "operationId": "GetMetricFeedback", "produces": [ "application/json" ], @@ -1322,7 +1322,7 @@ "Feedback" ], "summary": "List feedback on the given metric", - "operationId": "listMetricFeedbacks", + "operationId": "ListMetricFeedbacks", "consumes": [ "application/json" ], @@ -1384,7 +1384,7 @@ "Feedback" ], "summary": "Create a new metric feedback", - "operationId": "createMetricFeedback", + "operationId": "CreateMetricFeedback", "consumes": [ "application/json" ], @@ -1432,7 +1432,7 @@ "Hook" ], "summary": "List all hooks", - "operationId": "listHooks", + "operationId": "ListHooks", "produces": [ "application/json" ], @@ -1486,7 +1486,7 @@ "Hook" ], "summary": "Create a new hook", - "operationId": "createHook", + "operationId": "CreateHook", "consumes": [ "application/json" ], @@ -1534,7 +1534,7 @@ "Hook" ], "summary": "Get a hook by its id", - "operationId": "getHook", + "operationId": "GetHook", "produces": [ "application/json" ], @@ -1573,7 +1573,7 @@ "Hook" ], "summary": "Update a hook", - "operationId": "updateHook", + "operationId": "UpdateHook", "consumes": [ "application/merge-patch+json" ], @@ -1621,7 +1621,7 @@ "Hook" ], "summary": "Delete a hook", - "operationId": "deleteHook", + "operationId": "DeleteHook", "produces": [ "application/json" ], @@ -1659,7 +1659,7 @@ "IngestionStatus" ], "summary": "Get data ingestion status by data feed", - "operationId": "getDataFeedIngestionStatus", + "operationId": "GetDataFeedIngestionStatus", "consumes": [ "application/json" ], @@ -1729,7 +1729,7 @@ "IngestionStatus" ], "summary": "Reset data ingestion status by data feed to backfill data", - "operationId": "resetDataFeedIngestionStatus", + "operationId": "ResetDataFeedIngestionStatus", "consumes": [ "application/json" ], @@ -1779,7 +1779,7 @@ "IngestionStatus" ], "summary": "Get data last success ingestion job timestamp by data feed", - "operationId": "getIngestionProgress", + "operationId": "GetIngestionProgress", "produces": [ "application/json" ], @@ -1820,7 +1820,7 @@ "Metric" ], "summary": "Get time series data from metric", - "operationId": "getMetricData", + "operationId": "GetMetricData", "consumes": [ "application/json" ], @@ -1873,7 +1873,7 @@ "Metric" ], "summary": "List series (dimension combinations) from metric", - "operationId": "getMetricSeries", + "operationId": "GetMetricSeries", "consumes": [ "application/json" ], @@ -1943,7 +1943,7 @@ "Metric" ], "summary": "List dimension from certain metric", - "operationId": "getMetricDimension", + "operationId": "GetMetricDimension", "consumes": [ "application/json" ], @@ -2013,7 +2013,7 @@ "Metric" ], "summary": "Query all anomaly detection configurations for specific metric", - "operationId": "getAnomalyDetectionConfigurationsByMetric", + "operationId": "GetAnomalyDetectionConfigurationsByMetric", "produces": [ "application/json" ], @@ -2054,7 +2054,7 @@ "Metric" ], "summary": "Query anomaly detection status", - "operationId": "getEnrichmentStatusByMetric", + "operationId": "GetEnrichmentStatusByMetric", "consumes": [ "application/json" ], From c1c04c8e1f5aadfa1b97f708a6d5f7042680ae06 Mon Sep 17 00:00:00 2001 From: Xiang Yan Date: Wed, 27 Jan 2021 11:04:28 -0800 Subject: [PATCH 28/35] Update MetricsAdvisor.json --- .../data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index 29b7dd3ebf66..4910815c433f 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -49,8 +49,8 @@ ], "parameters": [ { - "in": "path", "name": "configurationId", + "in": "path", "description": "anomaly alerting configuration unique id", "required": true, "type": "string", From 774460684233cd9ed3334b2752f2a7c7b02aad09 Mon Sep 17 00:00:00 2001 From: Xiang Yan Date: Wed, 27 Jan 2021 14:38:05 -0800 Subject: [PATCH 29/35] Update MetricsAdvisor.json --- .../data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index 4910815c433f..33803b7a490d 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -5884,7 +5884,7 @@ "securityDefinitions": { "apiKeyHeader": { "type": "apiKey", - "name": "x-api-key", + "name": "Ocp-Apim-Subscription-Key", "in": "header" } }, From eca4810a3243da34611805fc7b2cc3d16914e095 Mon Sep 17 00:00:00 2001 From: Xiang Yan Date: Wed, 27 Jan 2021 14:44:57 -0800 Subject: [PATCH 30/35] Update MetricsAdvisor.json --- .../MetricsAdvisor/preview/v1.0/MetricsAdvisor.json | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index 33803b7a490d..bb811d442820 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -5882,12 +5882,17 @@ } }, "securityDefinitions": { - "apiKeyHeader": { + "apim_key": { "type": "apiKey", "name": "Ocp-Apim-Subscription-Key", "in": "header" } }, + "security": [ + { + "apim_key": [] + } + ], "parameters": { "Endpoint": { "name": "endpoint", From e9e61bf716c0a1612942bf376af3b9bf447a7ee7 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Tue, 2 Feb 2021 19:39:46 +0800 Subject: [PATCH 31/35] fix validation --- .../preview/v1.0/MetricsAdvisor.json | 92 ++++++++++--------- 1 file changed, 49 insertions(+), 43 deletions(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index bb811d442820..7859e641b793 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -12,7 +12,7 @@ "Admin" ], "summary": "Get latest usage stats", - "operationId": "GetActiveSeriesCount", + "operationId": "getActiveSeriesCount", "produces": [ "application/json" ], @@ -43,14 +43,14 @@ "AnomalyAlerting" ], "summary": "Query a single anomaly alerting configuration", - "operationId": "GetAnomalyAlertingConfiguration", + "operationId": "getAnomalyAlertingConfiguration", "produces": [ "application/json" ], "parameters": [ { - "name": "configurationId", "in": "path", + "name": "configurationId", "description": "anomaly alerting configuration unique id", "required": true, "type": "string", @@ -82,7 +82,7 @@ "AnomalyAlerting" ], "summary": "Update anomaly alerting configuration", - "operationId": "UpdateAnomalyAlertingConfiguration", + "operationId": "updateAnomalyAlertingConfiguration", "consumes": [ "application/merge-patch+json" ], @@ -130,7 +130,7 @@ "AnomalyAlerting" ], "summary": "Delete anomaly alerting configuration", - "operationId": "DeleteAnomalyAlertingConfiguration", + "operationId": "deleteAnomalyAlertingConfiguration", "produces": [ "application/json" ], @@ -168,7 +168,7 @@ "AnomalyAlerting" ], "summary": "Create anomaly alerting configuration", - "operationId": "CreateAnomalyAlertingConfiguration", + "operationId": "createAnomalyAlertingConfiguration", "consumes": [ "application/json" ], @@ -216,7 +216,7 @@ "AnomalyAlerting" ], "summary": "Query alerts under anomaly alerting configuration", - "operationId": "GetAlertsByAnomalyAlertingConfiguration", + "operationId": "getAlertsByAnomalyAlertingConfiguration", "consumes": [ "application/json" ], @@ -286,7 +286,7 @@ "AnomalyAlerting" ], "summary": "Query anomalies under a specific alert", - "operationId": "GetAnomaliesFromAlertByAnomalyAlertingConfiguration", + "operationId": "getAnomaliesFromAlertByAnomalyAlertingConfiguration", "produces": [ "application/json" ], @@ -351,7 +351,7 @@ "AnomalyAlerting" ], "summary": "Query incidents under a specific alert", - "operationId": "GetIncidentsFromAlertByAnomalyAlertingConfiguration", + "operationId": "getIncidentsFromAlertByAnomalyAlertingConfiguration", "produces": [ "application/json" ], @@ -416,7 +416,7 @@ "AnomalyDetection" ], "summary": "Query a single anomaly detection configuration", - "operationId": "GetAnomalyDetectionConfiguration", + "operationId": "getAnomalyDetectionConfiguration", "produces": [ "application/json" ], @@ -455,7 +455,7 @@ "AnomalyDetection" ], "summary": "Update anomaly detection configuration", - "operationId": "UpdateAnomalyDetectionConfiguration", + "operationId": "updateAnomalyDetectionConfiguration", "consumes": [ "application/merge-patch+json" ], @@ -503,7 +503,7 @@ "AnomalyDetection" ], "summary": "Delete anomaly detection configuration", - "operationId": "DeleteAnomalyDetectionConfiguration", + "operationId": "deleteAnomalyDetectionConfiguration", "produces": [ "application/json" ], @@ -541,7 +541,7 @@ "AnomalyDetection" ], "summary": "Create anomaly detection configuration", - "operationId": "CreateAnomalyDetectionConfiguration", + "operationId": "createAnomalyDetectionConfiguration", "consumes": [ "application/json" ], @@ -589,7 +589,7 @@ "AnomalyDetection" ], "summary": "Query all anomaly alerting configurations for specific anomaly detection configuration", - "operationId": "GetAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration", + "operationId": "getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration", "produces": [ "application/json" ], @@ -630,7 +630,7 @@ "AnomalyDetection" ], "summary": "Query series enriched by anomaly detection", - "operationId": "GetSeriesByAnomalyDetectionConfiguration", + "operationId": "getSeriesByAnomalyDetectionConfiguration", "consumes": [ "application/json" ], @@ -683,7 +683,7 @@ "AnomalyDetection" ], "summary": "Query anomalies under anomaly detection configuration", - "operationId": "GetAnomaliesByAnomalyDetectionConfiguration", + "operationId": "getAnomaliesByAnomalyDetectionConfiguration", "consumes": [ "application/json" ], @@ -753,7 +753,7 @@ "AnomalyDetection" ], "summary": "Query dimension values of anomalies", - "operationId": "GetDimensionOfAnomaliesByAnomalyDetectionConfiguration", + "operationId": "getDimensionOfAnomaliesByAnomalyDetectionConfiguration", "consumes": [ "application/json" ], @@ -823,7 +823,7 @@ "AnomalyDetection" ], "summary": "Query incidents under anomaly detection configuration", - "operationId": "GetIncidentsByAnomalyDetectionConfiguration", + "operationId": "getIncidentsByAnomalyDetectionConfiguration", "consumes": [ "application/json" ], @@ -884,7 +884,7 @@ "AnomalyDetection" ], "summary": "Query incidents under anomaly detection configuration", - "operationId": "GetIncidentsByAnomalyDetectionConfigurationNextPages", + "operationId": "getIncidentsByAnomalyDetectionConfigurationNextPages", "produces": [ "application/json" ], @@ -941,7 +941,7 @@ "AnomalyDetection" ], "summary": "Query root cause for incident", - "operationId": "GetRootCauseOfIncidentByAnomalyDetectionConfiguration", + "operationId": "getRootCauseOfIncidentByAnomalyDetectionConfiguration", "produces": [ "application/json" ], @@ -989,7 +989,7 @@ "DataFeed" ], "summary": "List all data feeds", - "operationId": "ListDataFeeds", + "operationId": "listDataFeeds", "produces": [ "application/json" ], @@ -1108,7 +1108,7 @@ "DataFeed" ], "summary": "Create a new data feed", - "operationId": "CreateDataFeed", + "operationId": "createDataFeed", "consumes": [ "application/json" ], @@ -1156,7 +1156,7 @@ "DataFeed" ], "summary": "Get a data feed by its id", - "operationId": "GetDataFeedById", + "operationId": "getDataFeedById", "produces": [ "application/json" ], @@ -1195,7 +1195,7 @@ "DataFeed" ], "summary": "Update a data feed", - "operationId": "UpdateDataFeed", + "operationId": "updateDataFeed", "consumes": [ "application/merge-patch+json" ], @@ -1243,7 +1243,7 @@ "DataFeed" ], "summary": "Delete a data feed", - "operationId": "DeleteDataFeed", + "operationId": "deleteDataFeed", "produces": [ "application/json" ], @@ -1281,7 +1281,7 @@ "Feedback" ], "summary": "Get a metric feedback by its id", - "operationId": "GetMetricFeedback", + "operationId": "getMetricFeedback", "produces": [ "application/json" ], @@ -1322,7 +1322,7 @@ "Feedback" ], "summary": "List feedback on the given metric", - "operationId": "ListMetricFeedbacks", + "operationId": "listMetricFeedbacks", "consumes": [ "application/json" ], @@ -1384,7 +1384,7 @@ "Feedback" ], "summary": "Create a new metric feedback", - "operationId": "CreateMetricFeedback", + "operationId": "createMetricFeedback", "consumes": [ "application/json" ], @@ -1432,7 +1432,7 @@ "Hook" ], "summary": "List all hooks", - "operationId": "ListHooks", + "operationId": "listHooks", "produces": [ "application/json" ], @@ -1486,7 +1486,7 @@ "Hook" ], "summary": "Create a new hook", - "operationId": "CreateHook", + "operationId": "createHook", "consumes": [ "application/json" ], @@ -1534,7 +1534,7 @@ "Hook" ], "summary": "Get a hook by its id", - "operationId": "GetHook", + "operationId": "getHook", "produces": [ "application/json" ], @@ -1573,7 +1573,7 @@ "Hook" ], "summary": "Update a hook", - "operationId": "UpdateHook", + "operationId": "updateHook", "consumes": [ "application/merge-patch+json" ], @@ -1621,7 +1621,7 @@ "Hook" ], "summary": "Delete a hook", - "operationId": "DeleteHook", + "operationId": "deleteHook", "produces": [ "application/json" ], @@ -1659,7 +1659,7 @@ "IngestionStatus" ], "summary": "Get data ingestion status by data feed", - "operationId": "GetDataFeedIngestionStatus", + "operationId": "getDataFeedIngestionStatus", "consumes": [ "application/json" ], @@ -1729,7 +1729,7 @@ "IngestionStatus" ], "summary": "Reset data ingestion status by data feed to backfill data", - "operationId": "ResetDataFeedIngestionStatus", + "operationId": "resetDataFeedIngestionStatus", "consumes": [ "application/json" ], @@ -1779,7 +1779,7 @@ "IngestionStatus" ], "summary": "Get data last success ingestion job timestamp by data feed", - "operationId": "GetIngestionProgress", + "operationId": "getIngestionProgress", "produces": [ "application/json" ], @@ -1820,7 +1820,7 @@ "Metric" ], "summary": "Get time series data from metric", - "operationId": "GetMetricData", + "operationId": "getMetricData", "consumes": [ "application/json" ], @@ -1873,7 +1873,7 @@ "Metric" ], "summary": "List series (dimension combinations) from metric", - "operationId": "GetMetricSeries", + "operationId": "getMetricSeries", "consumes": [ "application/json" ], @@ -1943,7 +1943,7 @@ "Metric" ], "summary": "List dimension from certain metric", - "operationId": "GetMetricDimension", + "operationId": "getMetricDimension", "consumes": [ "application/json" ], @@ -2013,7 +2013,7 @@ "Metric" ], "summary": "Query all anomaly detection configurations for specific metric", - "operationId": "GetAnomalyDetectionConfigurationsByMetric", + "operationId": "getAnomalyDetectionConfigurationsByMetric", "produces": [ "application/json" ], @@ -2054,7 +2054,7 @@ "Metric" ], "summary": "Query anomaly detection status", - "operationId": "GetEnrichmentStatusByMetric", + "operationId": "getEnrichmentStatusByMetric", "consumes": [ "application/json" ], @@ -5882,6 +5882,11 @@ } }, "securityDefinitions": { + "ma_api_key": { + "type": "apiKey", + "name": "x-api-key", + "in": "header" + }, "apim_key": { "type": "apiKey", "name": "Ocp-Apim-Subscription-Key", @@ -5890,7 +5895,8 @@ }, "security": [ { - "apim_key": [] + "apim_key": [], + "ma_api_key": [] } ], "parameters": { @@ -5905,7 +5911,7 @@ } }, "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}/metricsadvisor/v1.0/", + "hostTemplate": "{endpoint}/metricsadvisor/v1.0", "useSchemePrefix": false, "parameters": [ { From d3db084f394924012ce8b23f765eab8307038459 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Tue, 2 Feb 2021 20:00:14 +0800 Subject: [PATCH 32/35] fix examples --- .../MetricsAdvisor/preview/v1.0/examples/createDataFeed.json | 3 +-- .../preview/v1.0/examples/getActiveSeriesCount.json | 3 +-- .../preview/v1.0/examples/getAnomalyAlertingConfiguration.json | 2 +- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json index ebbe0885ec37..7db33d1dfd96 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/createDataFeed.json @@ -42,8 +42,7 @@ "rollUpMethod": "Sum", "allUpIdentification": "__SUM__", "fillMissingPointType": "SmartFilling", - "viewMode": "Private", - "isAdmin": false + "viewMode": "Private" } }, "responses": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json index a078676acf69..e6467fd367b9 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getActiveSeriesCount.json @@ -1,8 +1,7 @@ { "parameters": { "endpoint": "{endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "body": {} + "Ocp-Apim-Subscription-Key": "{API key}" }, "responses": { "200": { diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json index 11564692bb39..2c897605bcf0 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/examples/getAnomalyAlertingConfiguration.json @@ -2,7 +2,7 @@ "parameters": { "endpoint": "{endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", - "configurationId": "{configurationId}" + "configurationId": "44444444-4444-4444-4444-000000000001" }, "responses": { "200": { From aee742ed8a8367d91d06cccec8d9193498bf5e22 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Thu, 4 Feb 2021 12:35:18 +0800 Subject: [PATCH 33/35] fix discriminator --- .../preview/v1.0/MetricsAdvisor.json | 207 +++++++++--------- 1 file changed, 103 insertions(+), 104 deletions(-) diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index 7859e641b793..87cc75e87320 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -4097,8 +4097,7 @@ "rollUpMethod": "Sum", "allUpIdentification": "__SUM__", "fillMissingPointType": "SmartFilling", - "viewMode": "Private", - "isAdmin": false + "viewMode": "Private" } }, "AzureApplicationInsightsDataFeed": { @@ -4112,10 +4111,10 @@ "dataSourceParameter": { "$ref": "#/definitions/AzureApplicationInsightsParameter" } - }, - "x-ms-discriminator-value": "AzureApplicationInsights" + } } - ] + ], + "x-ms-discriminator-value": "AzureApplicationInsights" }, "AzureBlobParameter": { "required": [ @@ -4150,10 +4149,10 @@ "dataSourceParameter": { "$ref": "#/definitions/AzureBlobParameter" } - }, - "x-ms-discriminator-value": "AzureBlob" + } } - ] + ], + "x-ms-discriminator-value": "AzureBlob" }, "AzureCosmosDBParameter": { "required": [ @@ -4193,10 +4192,10 @@ "dataSourceParameter": { "$ref": "#/definitions/AzureCosmosDBParameter" } - }, - "x-ms-discriminator-value": "AzureCosmosDB" + } } - ] + ], + "x-ms-discriminator-value": "AzureCosmosDB" }, "SqlSourceParameter": { "required": [ @@ -4226,10 +4225,10 @@ "dataSourceParameter": { "$ref": "#/definitions/SqlSourceParameter" } - }, - "x-ms-discriminator-value": "AzureDataExplorer" + } } - ] + ], + "x-ms-discriminator-value": "AzureDataExplorer" }, "AzureDataLakeStorageGen2Parameter": { "required": [ @@ -4274,10 +4273,10 @@ "dataSourceParameter": { "$ref": "#/definitions/AzureDataLakeStorageGen2Parameter" } - }, - "x-ms-discriminator-value": "AzureDataLakeStorageGen2" + } } - ] + ], + "x-ms-discriminator-value": "AzureDataLakeStorageGen2" }, "AzureTableParameter": { "required": [ @@ -4312,10 +4311,10 @@ "dataSourceParameter": { "$ref": "#/definitions/AzureTableParameter" } - }, - "x-ms-discriminator-value": "AzureTable" + } } - ] + ], + "x-ms-discriminator-value": "AzureTable" }, "ElasticsearchParameter": { "required": [ @@ -4355,10 +4354,10 @@ "dataSourceParameter": { "$ref": "#/definitions/ElasticsearchParameter" } - }, - "x-ms-discriminator-value": "Elasticsearch" + } } - ] + ], + "x-ms-discriminator-value": "Elasticsearch" }, "HttpRequestParameter": { "required": [ @@ -4398,10 +4397,10 @@ "dataSourceParameter": { "$ref": "#/definitions/HttpRequestParameter" } - }, - "x-ms-discriminator-value": "HttpRequest" + } } - ] + ], + "x-ms-discriminator-value": "HttpRequest" }, "InfluxDBParameter": { "required": [ @@ -4446,10 +4445,10 @@ "dataSourceParameter": { "$ref": "#/definitions/InfluxDBParameter" } - }, - "x-ms-discriminator-value": "InfluxDB" + } } - ] + ], + "x-ms-discriminator-value": "InfluxDB" }, "MySqlDataFeed": { "allOf": [ @@ -4462,10 +4461,10 @@ "dataSourceParameter": { "$ref": "#/definitions/SqlSourceParameter" } - }, - "x-ms-discriminator-value": "MySql" + } } - ] + ], + "x-ms-discriminator-value": "MySql" }, "PostgreSqlDataFeed": { "allOf": [ @@ -4478,10 +4477,10 @@ "dataSourceParameter": { "$ref": "#/definitions/SqlSourceParameter" } - }, - "x-ms-discriminator-value": "PostgreSql" + } } - ] + ], + "x-ms-discriminator-value": "PostgreSql" }, "SQLServerDataFeed": { "allOf": [ @@ -4494,10 +4493,10 @@ "dataSourceParameter": { "$ref": "#/definitions/SqlSourceParameter" } - }, - "x-ms-discriminator-value": "SqlServer" + } } - ] + ], + "x-ms-discriminator-value": "SqlServer" }, "MongoDBParameter": { "required": [ @@ -4532,10 +4531,10 @@ "dataSourceParameter": { "$ref": "#/definitions/MongoDBParameter" } - }, - "x-ms-discriminator-value": "MongoDB" + } } - ] + ], + "x-ms-discriminator-value": "MongoDB" }, "DataFeedList": { "type": "object", @@ -4737,10 +4736,10 @@ "dataSourceParameter": { "$ref": "#/definitions/AzureApplicationInsightsParameter" } - }, - "x-ms-discriminator-value": "AzureApplicationInsights" + } } - ] + ], + "x-ms-discriminator-value": "AzureApplicationInsights" }, "AzureBlobDataFeedPatch": { "allOf": [ @@ -4753,10 +4752,10 @@ "dataSourceParameter": { "$ref": "#/definitions/AzureBlobParameter" } - }, - "x-ms-discriminator-value": "AzureBlob" + } } - ] + ], + "x-ms-discriminator-value": "AzureBlob" }, "AzureCosmosDBDataFeedPatch": { "allOf": [ @@ -4769,10 +4768,10 @@ "dataSourceParameter": { "$ref": "#/definitions/AzureCosmosDBParameter" } - }, - "x-ms-discriminator-value": "AzureCosmosDB" + } } - ] + ], + "x-ms-discriminator-value": "AzureCosmosDB" }, "AzureDataExplorerDataFeedPatch": { "allOf": [ @@ -4785,10 +4784,10 @@ "dataSourceParameter": { "$ref": "#/definitions/SqlSourceParameter" } - }, - "x-ms-discriminator-value": "AzureDataExplorer" + } } - ] + ], + "x-ms-discriminator-value": "AzureDataExplorer" }, "AzureDataLakeStorageGen2DataFeedPatch": { "allOf": [ @@ -4801,10 +4800,10 @@ "dataSourceParameter": { "$ref": "#/definitions/AzureDataLakeStorageGen2Parameter" } - }, - "x-ms-discriminator-value": "AzureDataLakeStorageGen2" + } } - ] + ], + "x-ms-discriminator-value": "AzureDataLakeStorageGen2" }, "AzureTableDataFeedPatch": { "allOf": [ @@ -4817,10 +4816,10 @@ "dataSourceParameter": { "$ref": "#/definitions/AzureTableParameter" } - }, - "x-ms-discriminator-value": "AzureTable" + } } - ] + ], + "x-ms-discriminator-value": "AzureTable" }, "ElasticsearchDataFeedPatch": { "allOf": [ @@ -4833,10 +4832,10 @@ "dataSourceParameter": { "$ref": "#/definitions/ElasticsearchParameter" } - }, - "x-ms-discriminator-value": "Elasticsearch" + } } - ] + ], + "x-ms-discriminator-value": "Elasticsearch" }, "HttpRequestDataFeedPatch": { "allOf": [ @@ -4849,10 +4848,10 @@ "dataSourceParameter": { "$ref": "#/definitions/HttpRequestParameter" } - }, - "x-ms-discriminator-value": "HttpRequest" + } } - ] + ], + "x-ms-discriminator-value": "HttpRequest" }, "InfluxDBDataFeedPatch": { "allOf": [ @@ -4865,10 +4864,10 @@ "dataSourceParameter": { "$ref": "#/definitions/InfluxDBParameter" } - }, - "x-ms-discriminator-value": "InfluxDB" + } } - ] + ], + "x-ms-discriminator-value": "InfluxDB" }, "MySqlDataFeedPatch": { "allOf": [ @@ -4881,10 +4880,10 @@ "dataSourceParameter": { "$ref": "#/definitions/SqlSourceParameter" } - }, - "x-ms-discriminator-value": "MySql" + } } - ] + ], + "x-ms-discriminator-value": "MySql" }, "PostgreSqlDataFeedPatch": { "allOf": [ @@ -4897,10 +4896,10 @@ "dataSourceParameter": { "$ref": "#/definitions/SqlSourceParameter" } - }, - "x-ms-discriminator-value": "PostgreSql" + } } - ] + ], + "x-ms-discriminator-value": "PostgreSql" }, "SQLServerDataFeedPatch": { "allOf": [ @@ -4913,8 +4912,7 @@ "dataSourceParameter": { "$ref": "#/definitions/SqlSourceParameter" } - }, - "x-ms-discriminator-value": "SqlServer" + } } ], "example": { @@ -4922,7 +4920,8 @@ "viewers": [ "viewer@company.example" ] - } + }, + "x-ms-discriminator-value": "SqlServer" }, "MongoDBDataFeedPatch": { "allOf": [ @@ -4935,10 +4934,10 @@ "dataSourceParameter": { "$ref": "#/definitions/MongoDBParameter" } - }, - "x-ms-discriminator-value": "MongoDB" + } } - ] + ], + "x-ms-discriminator-value": "MongoDB" }, "AnomalyFeedbackValue": { "required": [ @@ -5054,8 +5053,7 @@ "anomalyDetectionConfigurationSnapshot": { "$ref": "#/definitions/AnomalyDetectionConfiguration" } - }, - "x-ms-discriminator-value": "Anomaly" + } } ], "example": { @@ -5072,7 +5070,8 @@ } }, "feedbackType": "Anomaly" - } + }, + "x-ms-discriminator-value": "Anomaly" }, "ChangePointFeedbackValue": { "required": [ @@ -5115,10 +5114,10 @@ "value": { "$ref": "#/definitions/ChangePointFeedbackValue" } - }, - "x-ms-discriminator-value": "ChangePoint" + } } - ] + ], + "x-ms-discriminator-value": "ChangePoint" }, "CommentFeedbackValue": { "required": [ @@ -5153,10 +5152,10 @@ "value": { "$ref": "#/definitions/CommentFeedbackValue" } - }, - "x-ms-discriminator-value": "Comment" + } } - ] + ], + "x-ms-discriminator-value": "Comment" }, "PeriodFeedbackValue": { "required": [ @@ -5196,10 +5195,10 @@ "value": { "$ref": "#/definitions/PeriodFeedbackValue" } - }, - "x-ms-discriminator-value": "Period" + } } - ] + ], + "x-ms-discriminator-value": "Period" }, "MetricFeedbackFilter": { "required": [ @@ -5352,10 +5351,10 @@ "hookParameter": { "$ref": "#/definitions/EmailHookParameter" } - }, - "x-ms-discriminator-value": "Email" + } } - ] + ], + "x-ms-discriminator-value": "Email" }, "WebhookHookParameter": { "required": [ @@ -5403,8 +5402,7 @@ "hookParameter": { "$ref": "#/definitions/WebhookHookParameter" } - }, - "x-ms-discriminator-value": "Webhook" + } } ], "example": { @@ -5415,7 +5413,8 @@ "hookType": "Webhook", "description": "This is a webhook.", "externalLink": "" - } + }, + "x-ms-discriminator-value": "Webhook" }, "HookList": { "type": "object", @@ -5487,10 +5486,10 @@ "hookParameter": { "$ref": "#/definitions/EmailHookParameter" } - }, - "x-ms-discriminator-value": "Email" + } } - ] + ], + "x-ms-discriminator-value": "Email" }, "WebhookHookInfoPatch": { "allOf": [ @@ -5503,14 +5502,14 @@ "hookParameter": { "$ref": "#/definitions/WebhookHookParameter" } - }, - "x-ms-discriminator-value": "Webhook" + } } ], "example": { "hookName": "A webhook (modified)", "description": "This is a webhook. (modified)" - } + }, + "x-ms-discriminator-value": "Webhook" }, "IngestionStatusQueryOptions": { "required": [ From 214648c092d8249ad4fe91cee12a63455bffb105 Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Thu, 4 Feb 2021 22:17:25 +0800 Subject: [PATCH 34/35] fix custom word --- .../data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt | 2 -- 1 file changed, 2 deletions(-) delete mode 100644 specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt deleted file mode 100644 index 73ebb8238f04..000000000000 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/custom-words.txt +++ /dev/null @@ -1,2 +0,0 @@ -metricsadvisor - From 50ceb8e1e09a2940c28f60e69cba8ac0ef291c5e Mon Sep 17 00:00:00 2001 From: Bowen Gong Date: Thu, 4 Feb 2021 22:21:50 +0800 Subject: [PATCH 35/35] fix custom word --- custom-words.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/custom-words.txt b/custom-words.txt index 84736b8ac152..968a9cce1730 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -868,6 +868,7 @@ metricdefinitions metricmetadata metricnames metricnamespace +metricsadvisor metrictype mgmt microservices