swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector AnomalyDetection API schemes: - https tags: - name: AnomalyDetection paths: /enrichment/anomalyDetection/configurations/{configurationId}: get: tags: - AnomalyDetection summary: Microsoft Azure Query A Single Anomaly Detection Configuration operationId: microsoftAzureGetanomalydetectionconfiguration 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' default: description: Client error or server error (4xx or 5xx) schema: $ref: '#/definitions/ErrorCode' x-ms-examples: Query a single anomaly detection configuration: $ref: ./examples/getAnomalyDetectionConfiguration.json description: Needs a more full description created. patch: tags: - AnomalyDetection summary: Microsoft Azure Update Anomaly Detection Configuration operationId: microsoftAzureUpdateanomalydetectionconfiguration 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: '200': description: Success schema: $ref: '#/definitions/AnomalyDetectionConfiguration' default: description: Client error or server error (4xx or 5xx) schema: $ref: '#/definitions/ErrorCode' x-ms-examples: Update anomaly detection configuration: $ref: ./examples/updateAnomalyDetectionConfiguration.json description: Needs a more full description created. delete: tags: - AnomalyDetection summary: Microsoft Azure Delete Anomaly Detection Configuration operationId: microsoftAzureDeleteanomalydetectionconfiguration 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' x-ms-examples: Delete anomaly detection configuration: $ref: ./examples/deleteAnomalyDetectionConfiguration.json description: Needs a more full description created. /enrichment/anomalyDetection/configurations: post: tags: - AnomalyDetection summary: Microsoft Azure Create Anomaly Detection Configuration operationId: microsoftAzureCreateanomalydetectionconfiguration 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' x-ms-examples: Create anomaly detection configuration: $ref: ./examples/createAnomalyDetectionConfiguration.json description: Needs a more full description created. /enrichment/anomalyDetection/configurations/{configurationId}/alert/anomaly/configurations: get: tags: - AnomalyDetection summary: Microsoft Azure List All Anomaly Alerting Configurations For Specific Anomaly Detection Configuration operationId: microsoftAzureGetanomalyalertingconfigurationsbyanomalydetectionconfiguration produces: - application/json parameters: - in: path name: configurationId description: anomaly detection configuration unique id required: true type: string format: uuid - in: query name: $skip description: for paging, skipped number type: integer format: int32 - in: query name: $maxpagesize description: the maximum number of items in one page type: integer format: int32 responses: '200': description: Success schema: $ref: '#/definitions/AnomalyAlertingConfigurationList' default: description: Client error or server error (4xx or 5xx) schema: $ref: '#/definitions/ErrorCode' x-ms-pageable: nextLinkName: '@nextLink' x-ms-examples: List all anomaly alerting configurations for specific anomaly detection configuration: $ref: ./examples/getAnomalyAlertingConfigurationsByAnomalyDetectionConfiguration.json description: Needs a more full description created. /enrichment/anomalyDetection/configurations/{configurationId}/series/query: post: tags: - AnomalyDetection summary: Microsoft Azure Query Series Enriched By Anomaly Detection operationId: microsoftAzureGetseriesbyanomalydetectionconfiguration 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' default: description: Client error or server error (4xx or 5xx) schema: $ref: '#/definitions/ErrorCode' x-ms-examples: Query series enriched by anomaly detection: $ref: ./examples/getSeriesByAnomalyDetectionConfiguration.json description: Needs a more full description created. /enrichment/anomalyDetection/configurations/{configurationId}/anomalies/query: post: tags: - AnomalyDetection summary: Microsoft Azure Query Anomalies Under Anomaly Detection Configuration operationId: microsoftAzureGetanomaliesbyanomalydetectionconfiguration 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 description: for paging, skipped number type: integer format: int32 - in: query name: $maxpagesize description: the maximum number of items in one page 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' default: description: Client error or server error (4xx or 5xx) schema: $ref: '#/definitions/ErrorCode' x-ms-pageable: nextLinkName: '@nextLink' x-ms-examples: Query anomalies under anomaly detection configuration: $ref: ./examples/getAnomaliesByAnomalyDetectionConfiguration.json description: Needs a more full description created. /enrichment/anomalyDetection/configurations/{configurationId}/anomalies/dimension/query: post: tags: - AnomalyDetection summary: Microsoft Azure Query Dimension Values Of Anomalies operationId: microsoftAzureGetdimensionofanomaliesbyanomalydetectionconfiguration 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 description: for paging, skipped number type: integer format: int32 - in: query name: $maxpagesize description: the maximum number of items in one page 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' default: description: Client error or server error (4xx or 5xx) schema: $ref: '#/definitions/ErrorCode' x-ms-pageable: nextLinkName: '@nextLink' x-ms-examples: Query dimension values of anomalies: $ref: ./examples/getDimensionOfAnomaliesByAnomalyDetectionConfiguration.json description: Needs a more full description created. /enrichment/anomalyDetection/configurations/{configurationId}/incidents/query: post: tags: - AnomalyDetection summary: Microsoft Azure Query Incidents Under Anomaly Detection Configuration operationId: microsoftAzureGetincidentsbyanomalydetectionconfiguration 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: $maxpagesize description: the maximum number of items in one page 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' default: description: Client error or server error (4xx or 5xx) schema: $ref: '#/definitions/ErrorCode' x-ms-pageable: nextLinkName: '@nextLink' x-ms-examples: Query incidents under anomaly detection configuration: $ref: ./examples/getIncidentsByAnomalyDetectionConfiguration.json description: Needs a more full description created. get: tags: - AnomalyDetection summary: Microsoft Azure Query Incidents Under Anomaly Detection Configuration operationId: microsoftAzureGetincidentsbyanomalydetectionconfigurationnextpages produces: - application/json parameters: - in: path name: configurationId description: anomaly detection configuration unique id required: true type: string format: uuid - in: query name: $maxpagesize description: the maximum number of items in one page type: integer format: int32 - in: query name: $token description: the token for getting the next page type: string responses: '200': description: Success schema: $ref: '#/definitions/IncidentResultList' default: description: Client error or server error (4xx or 5xx) schema: $ref: '#/definitions/ErrorCode' x-ms-pageable: nextLinkName: '@nextLink' x-ms-examples: Query incidents under anomaly detection configuration: $ref: ./examples/getIncidentsByAnomalyDetectionConfigurationNextPages.json description: Needs a more full description created. /enrichment/anomalyDetection/configurations/{configurationId}/incidents/{incidentId}/rootCause: get: tags: - AnomalyDetection summary: Microsoft Azure Query Root Cause For Incident operationId: microsoftAzureGetrootcauseofincidentbyanomalydetectionconfiguration 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' default: description: Client error or server error (4xx or 5xx) schema: $ref: '#/definitions/ErrorCode' x-ms-examples: Query root cause for incident: $ref: ./examples/getRootCauseOfIncidentByAnomalyDetectionConfiguration.json description: Needs a more full description created. definitions: 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 x-ms-enum: name: AnomalyDetectionConfigurationLogicType modelAsString: true smartDetectionCondition: $ref: '#/definitions/SmartDetectionCondition' hardThresholdCondition: $ref: '#/definitions/HardThresholdCondition' changeThresholdCondition: $ref: '#/definitions/ChangeThresholdCondition' SuppressConditionPatch: 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 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' AnomalyResultList: required: - value type: object properties: '@nextLink': type: string readOnly: true value: type: array items: $ref: '#/definitions/AnomalyResult' 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' example: startTime: '2020-01-01T00:00:00Z' endTime: '2020-02-01T00:00:00Z' dimensionName: category dimensionFilter: dimension: city: Beijing 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' RootCauseList: required: - value type: object properties: value: type: array items: $ref: '#/definitions/RootCause' 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 default: '' 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' example: name: Anomaly detection configuration name description: Anomaly detection configuration description metricId: 22222222-2222-2222-2222-000000000001 wholeMetricConfiguration: conditionOperator: AND smartDetectionCondition: sensitivity: 91 anomalyDetectorDirection: Both suppressCondition: minNumber: 1 minRatio: 100 hardThresholdCondition: lowerBound: 1 upperBound: 100 anomalyDetectorDirection: Both suppressCondition: minNumber: 1 minRatio: 100 changeThresholdCondition: changePercentage: 5 shiftPoint: 1 withinRange: false anomalyDetectorDirection: Both suppressCondition: minNumber: 1 minRatio: 100 dimensionGroupOverrideConfigurations: - group: dimension: city: Beijing conditionOperator: AND smartDetectionCondition: sensitivity: 91 anomalyDetectorDirection: Both suppressCondition: minNumber: 1 minRatio: 100 hardThresholdCondition: lowerBound: 1 upperBound: 100 anomalyDetectorDirection: Both suppressCondition: minNumber: 1 minRatio: 100 changeThresholdCondition: changePercentage: 5 shiftPoint: 1 withinRange: false anomalyDetectorDirection: Both suppressCondition: minNumber: 1 minRatio: 100 seriesOverrideConfigurations: - series: dimension: category: Jewelry city: Beijing conditionOperator: AND smartDetectionCondition: sensitivity: 91 anomalyDetectorDirection: Both suppressCondition: minNumber: 1 minRatio: 100 hardThresholdCondition: lowerBound: 1 upperBound: 100 anomalyDetectorDirection: Both suppressCondition: minNumber: 1 minRatio: 100 changeThresholdCondition: changePercentage: 5 shiftPoint: 1 withinRange: false anomalyDetectorDirection: Both suppressCondition: minNumber: 1 minRatio: 100 SeriesIdentity: required: - dimension type: object properties: dimension: description: dimension specified for series type: object additionalProperties: type: string DetectionSeriesQuery: required: - endTime - series - startTime type: object properties: startTime: format: date-time description: This is inclusive. The maximum number of data points (series number * time range) is 10000. type: string endTime: format: date-time description: This is exclusive. The maximum number of data points (series number * time range) is 10000. type: string series: description: The series to be queried. The identity must be able to define one single time series instead of a group of time series. The maximum number of series is 100. uniqueItems: true type: array items: $ref: '#/definitions/SeriesIdentity' example: startTime: '2020-01-01T00:00:00Z' endTime: '2020-02-01T00:00:00Z' series: - dimension: category: Jewelry city: Beijing DimensionGroupIdentity: required: - dimension type: object properties: dimension: description: dimension specified for series group type: object additionalProperties: type: string 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' example: startTime: '2020-01-01T00:00:00Z' endTime: '2020-02-01T00:00:00Z' filter: dimensionFilter: - dimension: city: Beijing 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 default: false type: boolean dimensionAnomalyScope: $ref: '#/definitions/DimensionGroupIdentity' topNAnomalyScope: $ref: '#/definitions/TopNGroupScope' severityFilter: $ref: '#/definitions/SeverityCondition' snoozeFilter: $ref: '#/definitions/AlertSnoozeCondition' valueFilter: $ref: '#/definitions/ValueCondition' WholeMetricConfigurationPatch: type: object properties: conditionOperator: description: "condition operator\r\n\r\nshould be specified when combining multiple detection conditions" enum: - AND - OR type: string x-ms-enum: name: AnomalyDetectionConfigurationLogicType modelAsString: true smartDetectionCondition: $ref: '#/definitions/SmartDetectionConditionPatch' hardThresholdCondition: $ref: '#/definitions/HardThresholdConditionPatch' changeThresholdCondition: $ref: '#/definitions/ChangeThresholdConditionPatch' ChangeThresholdConditionPatch: 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/SuppressConditionPatch' IncidentResult: required: - incidentId - lastTime - property - rootNode - startTime type: object properties: dataFeedId: format: uuid description: "data feed unique id\r\n\r\nonly return for alerting anomaly result" type: string readOnly: true 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' AnomalyDimensionList: required: - value type: object properties: '@nextLink': type: string readOnly: true value: type: array items: type: string AnomalyResult: required: - dimension - property - timestamp type: object properties: dataFeedId: format: uuid description: "data feed unique id\r\n\r\nonly return for alerting anomaly result" type: string readOnly: true 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' 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 AnomalyDetectionConfigurationPatch: type: object properties: name: description: anomaly detection configuration name type: string description: description: anomaly detection configuration description default: '' type: string wholeMetricConfiguration: $ref: '#/definitions/WholeMetricConfigurationPatch' 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' example: wholeMetricConfiguration: smartDetectionCondition: sensitivity: 91 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 default: '' 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 x-ms-enum: name: AnomalyAlertingConfigurationLogicType modelAsString: true splitAlertByDimensions: description: dimensions used to split alert uniqueItems: true type: array items: 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' 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 upper: 1000 direction: Both type: Value 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 HardThresholdConditionPatch: 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/SuppressConditionPatch' WholeMetricConfiguration: type: object properties: conditionOperator: description: "condition operator\r\n\r\nshould be specified when combining multiple detection conditions" enum: - AND - OR type: string x-ms-enum: name: AnomalyDetectionConfigurationLogicType modelAsString: true 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 x-ms-enum: name: AnomalyDetectionConfigurationLogicType modelAsString: true smartDetectionCondition: $ref: '#/definitions/SmartDetectionCondition' hardThresholdCondition: $ref: '#/definitions/HardThresholdCondition' changeThresholdCondition: $ref: '#/definitions/ChangeThresholdCondition' 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 x-ms-enum: name: AnomalyStatus modelAsString: true value: format: double description: value of the anomaly type: number readOnly: true expectedValue: format: double description: expected value of the anomaly given by smart detector type: number readOnly: 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 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 x-ms-enum: name: IncidentStatus modelAsString: true valueOfRootNode: format: double description: value of the root node type: number readOnly: true expectedValueOfRootNode: format: double description: expected value of the root node given by smart detector type: number readOnly: true 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' AnomalyAlertingConfigurationList: type: object properties: value: type: array items: $ref: '#/definitions/AnomalyAlertingConfiguration' readOnly: true '@nextLink': type: string readOnly: true SeriesResultList: required: - value type: object properties: value: type: array items: $ref: '#/definitions/SeriesResult' SmartDetectionConditionPatch: 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/SuppressConditionPatch' ErrorCode: type: object properties: message: type: string code: type: string IncidentResultList: required: - value type: object properties: '@nextLink': type: string readOnly: true value: type: array items: $ref: '#/definitions/IncidentResult' 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 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 type: description: data used to implement value filter default: Value enum: - Value - Mean type: string x-ms-enum: name: ValueType 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 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 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' example: startTime: '2020-01-01T00:00:00Z' endTime: '2020-02-01T00:00:00Z' filter: dimensionFilter: - dimension: city: Beijing severityFilter: min: Low max: High 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 of the root cause type: number description: description: description of the root cause type: string DetectionIncidentFilterCondition: type: object properties: dimensionFilter: description: dimension filter uniqueItems: true type: array items: $ref: '#/definitions/DimensionGroupIdentity' DetectionAnomalyFilterCondition: type: object properties: dimensionFilter: description: dimension filter uniqueItems: true type: array items: $ref: '#/definitions/DimensionGroupIdentity' severityFilter: $ref: '#/definitions/SeverityFilterCondition' 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 x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'