Azure/azure-sdk-for-js @azure/ai-metrics-advisor_1.0.0-beta.2

on GitHub

1.0.0-beta.2 (2020-11-10)

• [Breaking] Combine listAnomaliesForDetectionConfiguration() and listAnomaliesForAlert() into overloads of listAnomalies()
• [Breaking] Combine listIncidentsForDetectionConfiguration() and listIncidentsForAlert() into overloads of listIncidents()
• listAnomalies() and listIncidents() on detection configures now also take strings of date formats for startTime and endTime parameters.
• [Breaking] Fix typo: lastOccuredTime is now lastOccurredTime.
• [Breaking] Feedback property dimensionFilter is renamed to dimensionKey.
• [Breaking] DataFeed.metricIds array is removed as GUIDs alone are not very useful.
• [Breaking] DataFeedOptions property dataFeedDescription is renamed to description.
• [Breaking] rename types whose name are too generic:
  • Alert is renamed to AnomalyAlert.
  • Anomaly is renamed to DataPointAnomaly
  • Incident is renamed to AnomalyIncident.
  • Metric is renamed to DataFeedMetric.
  • Dimension is renamed to DataFeedDimension.
  • *Hook* is renamed to *NotificationHook*.
• [Breaking] DataFeed properties admins is renamed to adminEmails and viewers is renamed to viewerEmails.
• [Breaking] IncidentRootCause property dimensionKey is renamed to seriesKey. AnomalyIncident.dimensionKey is renamed to rootDimensionKey
• [Breaking] The -List suffix is removed from Array properties in MetricSeriesData and MetricsEnrichedSeriesData. Plural form is used instead.
• [Breaking] *PageResponse types now extends from Array<ItemType> instead of wrapping an array of ItemType. Their types names are also shortened.
• [Breaking] Rename method for listing alerts
  • listAlertsForAlertConfiguration(alertConfigId, startTime, endTime, timemode, options) to listAlerts(alertConfigId, startTime, endTime, timemode, options)
• [Breaking] Rename feedback methods :
  • listMetricFeedbacks() to listFeedback()
  • getMetricFeedback() to getFeedback()
  • createMetricFeedback() to createFeedback()
• [Breaking] Rename detection configuration methods:
  • createMetricAnomalyDetectionConfiguration(anomalyConfig) to createDetectionConfig(anomalyConfig)
  • getMetricAnomalyDetectionConfiguration(detectionConfigId) to getDetectionConfig(detectionConfigId)
  • createMetricAnomalyDetectionConfiguration(config) to createDetectionConfig(config)
  • updateMetricAnomalyDetectionConfiguration(configId, patch) to updateDetectionConfig(configId, patch)
  • deleteMetricAnomalyDetectionConfiguration(detectionConfigId) to deleteDetectionConfig(detectionConfigId)
  • listMetricAnomalyDetectionConfigurations(metricId) to listDetectionConfigs(metricId)
• [Breaking] Rename anomaly alert configuration methods:
  • createAnomalyAlertConfiguration(anomalyAlertConfig) to createAlertConfig(anomalyAlertConfig)
  • updateAnomalyAlertConfiguration(alertConfigId, patch) to updateAlertConfig(alertConfigId, patch)
  • deleteAnomalyAlertConfiguration(alertConfigId) to deleteAlertConfig(alertConfigId)
  • listAnomalyAlertConfigurations(detectdionConfigId) to listAlertConfigs(detectdionConfigId)
• [Breaking] Data feed ingestion granularity now has "PerMinute" and "PerSecond" instead of "Minutely" and "Secondly".
• [Breaking] Change the type of following timestamp properties from Date to number
  • AnomalyAlert.timestamp
  • DataPointAnomaly.timestamp
  • EnrichmentStatus.timestamp
  • IngestionStatus.timestamp
  • latestSuccessTimestamp and latestActiveTimestamp in the return type of getDataFeedIngestionProgress().
• [Breaking] property createdTime on DataFeed and MetricFeedbackCommon to createdOn.
• [Breaking] Remove the wrapping data feed options property from DataFeed and DataFeedPatch and flatten its child properties.
• Parameters of Date type now also accept strings. No validation is done for the strings. The SDK calls new Date() to convert them to Date.
• Handle potential new data feed source types gracefully